documentation

Definitions for the bpmn:documentation XML element.

CLASS	DESCRIPTION
Documentation	The Documentation element is used to annotate the BPMN element, such as descriptions and other documentation.

Classes

Documentation dataclass

Documentation(
    *, id: Optional[str] = None, text_format: str = "text/plain", content: str
)

The Documentation element is used to annotate the BPMN element, such as descriptions and other documentation.

ATTRIBUTE	DESCRIPTION
content	This attribute is used to capture the text descriptions of a BPMN element. TYPE: str
id	This attribute is used to uniquely identify BPMN elements. TYPE: Optional[str]
text_format	This attribute identifies the format of the text. It MUST follow the mime-type format. TYPE: str

Attributes

content class-attribute instance-attribute

content: str = field(
    metadata={"name": "#text", "type": "Wildcard", "mixed": True}
)

This attribute is used to capture the text descriptions of a BPMN element.

id class-attribute instance-attribute

id: Optional[str] = field(default=None, metadata={'type': 'Attribute'})

This attribute is used to uniquely identify BPMN elements. The id is REQUIRED if this element is referenced or intended to be referenced by something else. If the element is not currently referenced and is never intended to be referenced, the id MAY be omitted.

text_format class-attribute instance-attribute

text_format: str = field(
    default="text/plain", metadata={"name": "textFormat", "type": "Attribute"}
)

This attribute identifies the format of the text. It MUST follow the mime-type format. The default is “text/plain.

Functions