Документация элементов процесса

Эта функция доступна только в редакции OpenBPM Control Enterprise.

OpenBPM Control может отображать документацию для отдельных BPMN-элементов прямо на диаграмме процесса. Когда разработчик процесса добавляет запись Documentation для элемента в BPMN XML, этот текст становится доступен операторам и аналитикам в OpenBPM Control без необходимости открывать исходную модель.

Это помогает быстро понять назначение задачи, шлюза или события прямо в контексте при мониторинге или анализе выполняющегося процесса.

Функция доступна на следующих страницах:

Просмотр документации элемента

Элементы, к которым добавлена документация, помечаются значком вопроса (?) на BPMN-диаграмме.

process documentation 1
process documentation 2

Чтобы просмотреть документацию элемента:

  1. Перейдите в раздел Processes или Process Instances.

  2. Выберите нужный процесс и откройте его диаграмму.

  3. Нажмите значок ? на любом BPMN-элементе, для которого добавлена документация.

  4. Откроется диалог Element documentation.

    process documentation 3

В диалоге отображаются:

  • Type — тип BPMN-элемента (например, bpmn:UserTask, bpmn:ServiceTask).

  • Id — уникальный идентификатор элемента, заданный в BPMN XML.

  • Documentation text — описание, добавленное разработчиком процесса.

Документация в BPMN XML

Документация элемента задается в исходном BPMN с помощью стандартного тега <documentation> внутри любого элемента потока:

<bpmn:userTask id="approveInvoice" name="Approve Invoice">
  <bpmn:documentation>Approve the invoice (or not).</bpmn:documentation>
  ...
</bpmn:userTask>

OpenBPM Control автоматически считывает это значение при развертывании процесса. Дополнительная настройка не требуется.

Документацию можно добавить к любому BPMN-элементу, который это поддерживает: задачам, шлюзам, событиям, подпроцессам и потокам последовательности.