For every combination of a Document Pattern and Element Type, a Doclet may be defined. This mapping information is stored in the current Process Documentation definition file (*.pdx). The default file is stored as Templates\Process Documentation\default.pdx in the installation folder.

To open an existing Process Documentation definition file, simply press the Open… button and choose the appropriate file.

You may view a Document Pattern’s skeleton by pressing the Quick View button. This function creates a new Microsoft Word document based on the selected template or document you used during the last creation of a Process Documentation and the currently chosen Element Doclets, but restricted to the currently selected Document Pattern. This helps you to see, how the Doclets will be inserted and formatted inside your Process Documentation.

To open a Doclet (*.rtf) , select the assignment in the table and double click, or right click on the assignment and choose Open. Another option is to search for the desired file in the file explorer and open it that way.

Note: The Graphics Pattern is not listed, since this pattern doesn’t use any Doclets.

How to create a new Documentation Pattern for Elements:

The process documentation definition file and the process document pattern files are connected. As mentioned above, the Process defintion file maps the connections of elements to their documentation pattern.

Therefore to Modify or create your own documentation templates you firstly have to create a new document definition file (*.pdx).

To create a new Process Documentation definition file, simply press the New button. You will be asked, if you want to reuse the current settings or to start from factory default settings. By choosing the factory default settings, all factory default doclet files (*.rtf) from the document Patterns will be copied to your chosen location and added into a new Doclets folder.

As a second step you can now change and modify the doclet (*.rtf) files which can either be done by double-clicking on the *.rtf file in the list in this Window or externally by opening the desired template RTF file in your file explorer. Each of this options will create a new Microsoft Word document based on the selected template/document (*.rtf) you used. Now you are free to change the template. In order to make your changes and modifications permanent you need to save your changes.

Please mind that the saving location should not be changed in order to keep the Process documentation definition file (*.pdx) connection to its corresponding Doclet files intact.

Expand attribute variables within attributes:

Choose this option to search and replace attribute variables within the inserted attributes. For example, if the Documentation attribute of an element contains %%Bpmn.Diagram.Name%% within the attribute value, then with this option checked, the attribute variable is substituted by the Name attribute of the Diagram.

After pressing the OK button, the current settings will be stored in the selected Process Documentation definition file (*.pdx).

For more information on the Process Documentation feature, see Process Documentation.