Документация для разработчиков

CBPDocument

CBPDocument - вспомогательный класс, содержащий статические методы-обертки для удобного использования API модуля бизнес-процессов.

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

$runtime = CBPRuntime::GetRuntime();
$wi = $runtime->CreateWorkflow($workflowTemplateId, $documentId, $arParameters);
$wi->Start(); 

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

string CBPDocument::StartWorkflow($workflowTemplateId, $documentId, $arParameters, &$arErrors)
который кроме того обработает исключения, собрав их в массив $arErrors, и вернет идентификатор бизнес-процесса.

Методы класса

МетодОписаниеС версии
AddDocumentToHistoryМетод добавляет текущую версию документа в историю.9.0.0
AutoStartWorkflows Метод запускает рабочие потоки, настроенные на автозапуск.
CanOperate Метод проверяет, может ли указанный пользователь совершить указанную операцию, если документ находится в указанных состояниях.
CanUserOperateDocument Метод проверяет путем обращения к сущности документа, может ли пользователь совершать указанную операцию с документом.
CanUserOperateDocumentType Метод проверяет путем обращения к сущности типа документа, может ли пользователь совершать указанную операцию с документами данного типа.
DeleteWorkflowTemplate Метод удаляет шаблон бизнес-процесса.
GetAllowableEvents Метод возвращает массив событий, которые указанный пользователь может отправить рабочему потоку в указанном состоянии.
GetAllowableOperations Метод возвращает массив операций, которые указанный пользователь может совершить, если документ находится в указанных состояниях.
GetDocumentState Метод для данного документа возвращает состояние указанного рабочего потока.
GetDocumentStates Метод возвращает массив всех рабочих потоков и их состояний для данного документа.
GetUserTasksForWorkflow Метод возвращает массив заданий для данного пользователя в данном рабочем потоке.
GetWorkflowTemplatesForDocumentType Метод возвращает массив шаблонов рабочих потоков для данного типа документа.
OnDocumentDelete Метод удаляет все связанные с документом записи модуля бизнес-процессов.
SendExternalEvent Метод отправляет внешнее событие рабочему потоку.
StartWorkflow Метод запускает рабочий поток по коду его шаблона. Это рекомендуемый метод для запуска бизнес-процессов.
TerminateWorkflow Метод останавливает выполнение рабочего потока.
UpdateWorkflowTemplate Метод изменяет параметры шаблона бизнес-процесса.


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2019, «1С-Битрикс», 2019
Наверх