Смарт-процессы: обзор методов

Смарт-процесс — это универсальный объект CRM, который можно настроить с учетом потребностей компании. Для каждого смарт-процесса Битрикс24 создает отдельный раздел в CRM. В разделе можно настроить воронки и стадии, роботов, поля, связи с другими объектами Битрикс24.

Быстрый переход: все методы и события

Пользовательская документация: Смарт-процессы в CRM

Порядок работы со смарт-процессом

Создайте и настройте смарт-процесс — методы crm.type.*.
Настройте воронки и стадии — crm.category.* для воронок и crm.status.* для стадий.
Добавьте пользовательские поля — userfieldconfig.*.
Настройте вид карточки элемента — crm.item.details.configuration.*.
Создайте первые элементы внутри смарт-процесса — crm.item.*.

Смарт-процесс можно перенести из раздела CRM в раздел Автоматизация через цифровые рабочие места.

Связь с другими объектами

Объекты CRM. Смарт-процесс можно связать с лидами, сделками и другими объектами CRM. Связанный объект будет доступен через поле parentId{ID}, где {ID} — числовой идентификатор объекта CRM.

Клиент. Поле в карточке смарт-процесса, которое состоит из связанных с ним компании и контактов. Компания в поле одна, изменяйте связанную компанию через поле companyId. Контактов в поле «Клиент» может быть несколько. Взаимодействие с контактами ведется через поле contactIds — передавайте в поле массив с ID контактов. Включите поле опцией isClientEnabled в методе crm.type.add или crm.type.update.

Реквизиты вашей компании. Укажите ID вашей компании в поле mycompanyId, чтобы ее реквизиты автоматически использовались в документах. Получить ID вашей компании можно методом crm.item.list для объекта компаний с фильтром по полю isMyCompany. Включите поле опцией isMycompanyEnabled в методе crm.type.add или crm.type.update.

Товары. Чтобы добавить, изменить или удалить товарные позиции в смарт-процессе используйте методы crm.item.productrow.*. Включите вкладку с товарами и поле «Сумма и валюта» опцией isLinkWithProductsEnabled в методе crm.type.add или crm.type.update.

Пользователи. Смарт-процесс имеет привязку к пользователям по числовым идентификаторам в полях:

createdBy — кем создан,
updatedBy — кем обновлен,
movedBy — кто изменил стадию,
assignedById — ответственный за элемент,
observers — наблюдатели. Включите поле опцией isObserversEnabled в методе crm.type.add или crm.type.update.

Получить идентификатор и данные пользователя можно с помощью метода user.get.

Документы. Чтобы создать документ по шаблону, загрузить новый шаблон для смарт-процесса или настроить нумератор для документов, используйте методы crm.documentgenerator.*. Включите работу с документами в смарт-процессе опцией isDocumentsEnabled в методе crm.type.add или crm.type.update.

Задачи. Элементы смарт-процесса можно привязывать к задачам. Для работы с задачами используйте методы tasks.task.*. Чтобы возможность связи была доступна, включите и настройте опцию isUseInUserfieldEnabled в методе crm.type.add или crm.type.update.

События календаря. Элементы смарт-процесса можно привязывать к событиям календаря. Для работы с календарем используйте методы calendar.event.*. Чтобы возможность связи была доступна, включите и настройте опцию isUseInUserfieldEnabled в методе crm.type.add или crm.type.update.

Пользовательская документация

Карточка элемента смарт-процесса

Основное рабочее пространство в смарт-процессе — вкладка «Общее» карточки. Она состоит из двух частей:

левая, в ней располагаются поля с информацией. Если системных полей недостаточно, можно создать собственные пользовательские поля. Поля позволяют хранить информацию в различных форматах данных: строка, число, ссылка, адрес и другие. Для создания, изменения, получения или удаления пользовательских полей смарт-процесса используйте группу методов userfieldconfig.*.
правая, в ней располагается таймлайн смарт-процесса. В нем можно создавать, редактировать, фильтровать, удалять дела CRM — группа методов crm.activity.*, и записи таймлайна — группа методов crm.timeline.*.

Параметрами карточки смарт-процесса можно управлять через группу методов crm.item.details.configuration.*.

Пользовательская документация

Виджеты

В карточку смарт-процесса можно встроить приложение. Благодаря встраиванию можно будет использовать приложение и не покидать карточку элемента.

Есть два сценария встройки:

использовать специальные места встраивания. Например, через создание своей вкладки.
создать пользовательское поле, в котором будет загружаться интерфейс вашего приложения.

Места встраивания смарт-процессов

Вместо XXX укажите числовой идентификатор конкретного смарт-процесса, например CRM_DYNAMIC_183_DOCUMENTGENERATOR_BUTTON.

CRM_DYNAMIC_XXX_DETAIL_TAB — вкладка в детальной карточке элемента CRM
CRM_DYNAMIC_XXX_DETAIL_ACTIVITY — кнопка над таймлайном карточки элемента
CRM_DYNAMIC_XXX_DETAIL_TOOLBAR — пункт выпадающего меню верхней кнопки карточки
CRM_DYNAMIC_XXX_DOCUMENTGENERATOR_BUTTON — пункт выпадающего меню генератора документов
CRM_DYNAMIC_XXX_LIST_MENU — пункт контекстного меню в списке элементов
CRM_DYNAMIC_XXX_LIST_TOOLBAR — пункт выпадающего меню над списком элементов
CRM_DYNAMIC_XXX_ACTIVITY_TIMELINE_MENU — пункт контекстного меню дела в карточке элемента
CRM_DYNAMIC_XXX_ROBOT_DESIGNER_TOOLBAR — пункт выпадающего меню верхней кнопки дизайнера роботов

Частые кейсы и сценарии

Идентификаторы смарт-процессов

У каждого смарт-процесса есть четыре типа идентификаторов. Используйте идентификаторы, чтобы применить метод к определенному смарт-процессу.

Числовой идентификатор типа 130. Получить можно методом crm.enum.ownertype ID или crm.type.list entityTypeId.
Символьный код типа DYNAMIC_130 — crm.enum.ownertype SYMBOL_CODE.
Краткий символьный код типа T82 — crm.enum.ownertype SYMBOL_CODE_SHORT.
Тип объекта пользовательского поля CRM_13 — crm.type.list. id из результата метода подставьте в формулу CRM_ + {ID}.

Обзор методов и событий

Scope: crm

Кто может выполнять метод: в зависимости от метода