Text Annotation Activity
The Text Annotation activity enables modelers to embed descriptive notes directly within a process model. This feature provides crucial context and additional information, enhancing readability and understanding for anyone reviewing the process flow.
| Field | Description | Requirement |
|---|---|---|
| Id | The unique identifier of the element within the process model. | Optional |
| Name | The displayed name of the element in the canvas. | Optional |
| Documentation | A detailed description and additional information about the annotation. | Optional |
| Text | The actual text content of the annotation. | Required |
Action Types & Examples
Retrieve Annotation Text
- Format: string
- Example Result:
"This step validates user input before proceeding."
Implementation Examples
Field Setup - Id: process_note_001 - Name: Initial Data Capture Note - Documentation: This annotation clarifies the purpose of the first data entry stage. - Text: Ensure all mandatory fields are populated.
Execution Parameters - Id: current_step_annotation - Text: workflow.variables.currentStepDescription
Technical Notes
Text annotations are purely for documentation purposes and do not influence the execution logic or flow of the process. They are visible only within the design environment and are not exposed to end-users during runtime unless explicitly extracted and displayed by other means.