Online Help Process Modeler

Document a process

Documenting a process

Defining Attributes and Documentations

Due to its capability to give access to all element attributes stored in the object model, the Attribute Explorer is one of the most important and central modules of the Process Modeler. Some of the attributes behave dynamically, meaning that their visibility is dependent on the value of other attributes.  All BPMN 2.0 attributes are supported with drop-down lists and value constrains.

The Attribute Explorer can be displayed by right mouse click on the element-> Attribute or in the Process Modeler BPMN->view ->Attribute.

Defining a UDA with the Attribute Explorer

Entering Documentation

You can enter documentation by using the predefined elements (divided into the sections User Attributes, System Attributes and BPMN Attributes). The simplest way of documenting is using the documentation attribute, shown in the above picture.

Text Documentation

The documentation attribute provides a text area where you can enter plain text or rich text. Choosing plain text always leaves the entire text inside the BPMN XML whereas if you choose to enter rich text a MS Word file (.rtf) is generated and referenced from the BPMN XML. Rich text provides you with the advantage to enter formats (like italics and table definitions) and you can edit the text either in the Attribute Explorer or with Microsoft Word.

References and Hyperlinks

If you already have a series of documents outside of your BPMN diagram you can either reference these documents or set hyperlink to them.

Referencing a document will import a document and save it in the same place as the diagram itself (Team Repository or file system). To reference documents just add a new user defined attribute (UDA) of type Documents and add your documents there.

A hyperlink (to locations in the web or a file system) can be added either in the systems defined attribute Hyperlinks or you can add hyperlinks on a UDA of type Documents.