Documentación de elementos de proceso

Esta funcionalidad está disponible exclusivamente en la edición Flowset Control Enterprise.

Flowset Control puede mostrar la documentación de elementos BPMN individuales directamente en el diagrama del proceso. Cuando un desarrollador de procesos añade una entrada Documentation a un elemento en el BPMN XML, ese texto queda accesible para operadores y analistas en Flowset Control, sin necesidad de abrir el modelo de origen.

Esto facilita la comprensión del propósito de una tarea, compuerta o evento en su propio contexto, mientras se monitorea o analiza un proceso en ejecución.

La funcionalidad está disponible en las siguientes páginas:

Visualización de la documentación de un elemento

Los elementos que tienen documentación adjunta se indican mediante un icono de signo de interrogación (?) mostrado sobre el elemento en el diagrama BPMN.

process documentation 1
process documentation 2

Para ver la documentación de un elemento:

  1. Ve a Processes o Process Instances.

  2. Selecciona el proceso deseado y abre su diagrama.

  3. Haz clic en el icono ? de cualquier elemento BPMN que tenga documentación adjunta.

  4. Se abrirá el diálogo Element documentation.

    process documentation 3

El diálogo muestra:

  • Type — el tipo de elemento BPMN (por ejemplo, bpmn:UserTask, bpmn:ServiceTask).

  • Id — el identificador único del elemento tal como se define en el BPMN XML.

  • Documentation text — la descripción escrita por el desarrollador del proceso.

Documentación en el BPMN XML

La documentación de un elemento se define en el origen BPMN mediante la etiqueta estándar <documentation> dentro de cualquier elemento de flujo:

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

Flowset Control lee este valor automáticamente cuando se despliega el proceso, sin necesidad de configuración adicional.

La documentación puedes añadirse a cualquier elemento BPMN que la admita: tareas, compuertas, eventos, subprocesos y flujos de secuencia.