Кейсы
Справочник технических полей Bitrix24
Как локальное приложение показывает поля CRM, смарт-процессов, задач, пользователей, диска и открытых линий.
При разработке под Bitrix24 часто нужно быстро понять, какие поля есть у нужной сущности, как они называются технически и какие типы данных возвращает REST. Для этого был сделан отдельный справочник полей по нескольким разделам Bitrix24.
Задача
Нужно было сделать локальное приложение, которое показывает технические поля разных сущностей Bitrix24 в одном интерфейсе.
Поля всех сущностей в одном месте
Приложение должно было отображать поля выбранной сущности: название, технический код, тип, признаки системности, множественности и доступности для чтения или изменения.
В справочнике нужно было видеть поля по разделам:
- CRM;
- смарт-процессы;
- задачи;
- пользователи;
- диск и файлы;
- открытые линии.
Для CRM дополнительно нужны были стандартные сущности: лиды, сделки, контакты, компании и счета. Для смарт-процессов — пользовательские типы CRM, которые есть на конкретном портале.
Быстрее понимать, что реально есть в портале
В доработках Bitrix24 почти всегда приходится работать не с русскими названиями полей, а с техническими кодами. Они нужны в REST-запросах, обработчиках, локальных приложениях и интеграциях.
Если каждый раз искать поле в настройках, документации или через отдельные тестовые запросы, разработка замедляется. Гораздо удобнее открыть один экран, выбрать раздел и сущность, а потом сразу увидеть список полей.
Проблема
У разных разделов Bitrix24 разные методы, разные наборы полей и разные технические названия. Для разработки это неудобно, особенно когда нужно быстро проверить структуру сущности.
Нужные коды приходилось искать вручную
Поля CRM, задач, пользователей, файлов и открытых линий смотрятся по-разному. Часть данных видна в интерфейсе, часть — только через REST, а часть зависит от прав пользователя и настроек конкретного портала.
Из-за этого простая задача — найти нужный код поля — превращается в переключение между карточкой, настройками, документацией и тестовыми REST-запросами.
Названия в интерфейсе не помогают в коде
У пользовательских полей есть коды вида UF_..., у системных — свои названия,
а у смарт-процессов и отдельных модулей набор полей может отличаться от привычных CRM-сущностей.
Если перепутать поле или его тип, доработка может работать неправильно: не туда записывать значение, не находить данные в фильтре или ломаться на множественных полях.
Решение
Я сделал локальное приложение для Bitrix24 Cloud. Оно получает список доступных разделов и сущностей, загружает метаданные полей и показывает их в отдельном интерфейсе.
Единая справка по техническим полям
В приложении можно выбрать раздел, затем конкретную сущность и посмотреть её поля без ручных REST-запросов.
Интерфейс сделан как техническая таблица для разработчика: минимум лишнего текста, акцент на кодах полей, типах и признаках, которые важны при реализации.
CRM, задачи, диск и открытые линии в одном интерфейсе
Справочник разделён по направлениям Bitrix24. Это удобнее, чем один общий список, потому что у CRM, задач, пользователей, файлов и открытых линий разные сущности и разные наборы полей.
В приложении доступны разделы:
- CRM — лиды, сделки, контакты, компании и счета;
- Смарт-процессы — пользовательские CRM-типы портала;
- Задачи — поля задач;
- Пользователи — поля пользователей;
- Диск / файлы — поля файлов и объектов диска;
- Открытые линии — поля, связанные с чатами и сессиями открытых линий.
Лид как пример карточки с техническими кодами
На скриншоте показан пример для лида. Приложение выводит список доступных полей, их технические коды и параметры, которые нужны при разработке.
Поиск по названию, коду и типу поля
Чтобы не прокручивать длинный список, в интерфейсе добавлен поиск по названию и коду поля. Можно ввести часть русского названия, технического кода или типа значения и быстро сузить список.
Так приложение закрывает частый рабочий сценарий: нужно не изучать всю сущность, а быстро найти одно конкретное поле и скопировать его код для доработки.
Результат
Получился простой справочник технических полей внутри Bitrix24. Он помогает быстрее готовить доработки, проверять структуру сущностей и не ошибаться в кодах полей.
Разработчик быстрее находит нужное поле
Теперь для просмотра полей не нужно каждый раз открывать настройки, документацию или делать отдельные тестовые REST-запросы. Достаточно открыть приложение, выбрать раздел и сущность.
После доработки можно:
- посмотреть поля CRM-сущностей;
- посмотреть поля смарт-процессов;
- посмотреть поля задач, пользователей, файлов и открытых линий;
- быстро найти технический код нужного поля;
- увидеть тип поля и его основные признаки;
- подготовить данные для REST-запросов, обработчиков и локальных приложений.
Приложение не меняет данные Bitrix24. Оно только читает метаданные и показывает их в удобном интерфейсе.