Text Annotation

Introduction

info

Annotations are a mechanism for a modeler to provide additional information for the reader of a BPMN Diagram.

— BPMN 2.0.2 Standard, 8.4.1, Text Annotations

Properties

General

Attribute	Type	Description	Category
Model Id	Text	Model Id identifies the element within the process model.	The model id, name and documentation properties can be found on any element. They are used respectively to uniquely identify the text annotation, to give it a user-friendly name and to add a free-form description.
Name	Text	The name of the element. This is the name displayed in the diagram.
Documentation	Multiline Text	A free-form text that can be used to explain details about the particular element.
Text	TextArea		The text, displayed on the diagram.
Text format	Text	This attribute identifies the format of the text. It must follow the MIME type format.

Advanced

Attribute	Type	Description	Category
Include in history	Boolean	When the history level is set to "instance" or "task" level with this property it can be configured if this activity instance should be included in the historic activity data.	The Include in history flag can be used to store the historical entry of this text annotation when running with a history level that normally would not store the execution of this text annotation. Note that this flag has no effect when running with history level 'none'.

Visual

Attribute	Type	Description	Category
Font size	Selection: 8 9 10 11 12 14 18 20 24 36 48 72	Font size.	Visual properties that determine how the event listener is shown in the diagram. This has no impact on the runtime execution.
Font weight	Selection: Normal Bold	Select the style between bold and normal.
Font style	Selection: Normal Italic	Select the style between italic and normal.
Font color	Color	Select a font color.
Background color	Color	The background color of the element in the diagram.
Border color	Color	The border color of the element in the diagram.