Получить активные бизнес-процессы документа

Показывает доступные запущенные процессы выбранного документа и их шаблоны.

Видимая часть формы настройки в Битрикс24. Скриншот показывает поля действия; он не подтверждает выполнение учебного примера.

Для кого и какую проблему решает

Робот полезен для администратора бизнес-процессов, который разбирает зависшее согласование. На одной карточке запущено несколько процессов, и по названию карточки нельзя понять, какие экземпляры ещё присутствуют в активном списке. Робот возвращает их строковые ID и доступные сведения о шаблонах.

Что делает и когда применять

Показывает доступные запущенные процессы выбранного документа и их шаблоны.

Принимает полный идентификатор документа DOCUMENT_ID: три строки в JSON (модуль, класс документа, ID), необязательные TEMPLATE_IDS и LIMIT до 500. Сравнивает все три части точно. Возвращает строковые ID экземпляров, шаблоны, дату запуска, инициатора и доступные даты служебного состояния. Наличие означает, что экземпляр присутствует в списке запущенных процессов; конкретный этап выполнения не определяется. Пустой доступный поиск успешен. Более 5000 строк или неполное чтение: ошибка; усечение вывода указано отдельно.

Что подготовить

Нужен установленный робот из приложения «CRM роботы 2.0 + AI» и право на настройку автоматизации нужной CRM-воронки или шаблона бизнес-процесса. Пользователю, от имени которого работает приложение, должны быть доступны выбранные CRM-элементы и нужное действие с ними.

Подготовьте полный идентификатор документа как JSON из трёх строк. Укажите модуль, класс документа и точный ID документа. Если нужен определённый шаблон, передайте его ID в отдельном массиве.

Как настроить и использовать

1. Откройте автоматизацию нужной сущности и выберите стадию, на которой нужен робот «Получить активные бизнес-процессы документа». В шаблоне бизнес-процесса добавьте одноимённое действие.
2. Подготовьте полный идентификатор документа как JSON из трёх строк. Укажите модуль, класс документа и точный ID документа. Если нужен определённый шаблон, передайте его ID в отдельном массиве.
3. Заполните Полный идентификатор документа: JSON из трёх строк, Шаблоны: JSON ID, пусто — любые, Лимит вывода. Для рабочего сценария подставьте значения полей документа или результаты предыдущих действий вместо учебных данных ниже.
4. Проверьте обязательные поля и варианты выбора в таблице настроек. Сохраните действие и свяжите его результаты с дальнейшими условиями процесса.
5. Выполните пробный запуск на отдельном учебном элементе. Сначала проверьте статус и пояснение ошибки, затем содержательный результат и ветку, выбранную следующим действием.

Параметры робота

Имена полей ниже совпадают с настройками действия. Значения из таблицы относятся к самому роботу; результаты предыдущих шагов выбирайте через подстановку значения в редакторе.

Поле в настройках	Что передать	Обязательность и исходное значение
Полный идентификатор документа: JSON из трёх строк (DOCUMENT_ID)	Формат: текст.	Обязательно. Значение по умолчанию в настройках не задано
Шаблоны: JSON ID, пусто — любые (TEMPLATE_IDS)	Формат: текст.	Необязательно. По умолчанию: []
Лимит вывода (LIMIT)	Формат: целое число.	Обязательно. По умолчанию: 100

Учебный пример

Пример показывает способ настройки на вымышленных данных и ожидаемый смысл результата; это не отчёт о запуске на вашем портале.

• Полный идентификатор документа: JSON из трёх строк (DOCUMENT_ID): ["crm","CCrmDocumentDeal","DEAL_501"].
• Шаблоны: JSON ID, пусто — любые (TEMPLATE_IDS): [].
• Лимит вывода (LIMIT): 100.

Полный идентификатор документа: JSON из трёх строк (DOCUMENT_ID)

Копируйте в это поле только содержимое блока, без названия поля и внешней обёртки со всеми настройками. Здесь нужен JSON-массив в квадратных скобках. Пустой массив [] означает отсутствие элементов; объект {} его не заменяет. Учебные ID замените реальными ID выбранных карточек, дел, шаблонов или сотрудников; их можно передать из результатов предыдущего поиска. Коды полей берите из настроек вашей CRM. Все три элемента являются строками в фиксированном порядке: модуль документа, класс документа, идентификатор документа. В учебном примере crm / CCrmDocumentDeal / DEAL_501 относится к сделке 501. Используйте идентификатор именно выбранного документа; одного числа 501 вместо массива недостаточно.

[
  "crm",
  "CCrmDocumentDeal",
  "DEAL_501"
]

Шаблоны: JSON ID, пусто — любые (TEMPLATE_IDS)

Копируйте в это поле только содержимое блока, без названия поля и внешней обёртки со всеми настройками. Здесь нужен JSON-массив в квадратных скобках. Пустой массив [] означает отсутствие элементов; объект {} его не заменяет. Учебные ID замените реальными ID выбранных карточек, дел, шаблонов или сотрудников; их можно передать из результатов предыдущего поиска. Коды полей берите из настроек вашей CRM. Каждый элемент массива содержит ID нужного шаблона бизнес-процесса. [] снимает этот дополнительный фильтр и оставляет поиск по документу. ID шаблона берите из настройки бизнес-процесса, не из ID его запущенного экземпляра.

[]

Для учебной сделки возвращается доступный список запущенных экземпляров. Ноль строк означает успешный пустой поиск при наличии доступа. Если вывод усечён, количество возвращённых строк не равно полному числу всех процессов.

Какие данные возвращает и что делать дальше

Результат	Какое значение получает следующий шаг
ID экземпляров (workflowIds)	строка, несколько значений
Запущенные процессы: JSON (workflowsJson)	текст
Возвращено экземпляров (count)	целое число
Вывод усечён (truncated)	да/нет
Статус выполнения (status)	да/нет
Пояснение ошибки (error)	строка

Передайте «ID экземпляров» в проверку заданий или сотруднику для разбора. Наличие в активном списке не подтверждает конкретный этап или зависание; сначала сопоставьте шаблон и доступные даты.

Ошибки и ограничения

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