The BPaaS Editor provides you with two functionalities that support you in documenting your process:

  1. The element property Description
  2. The context menu option Generate Model Report Deprecated since PAS 20.1

Maintaining Descriptions

Each element created in the BPaaS Editor contains the property field Description. Here you can record notes on the use of the element in the process.

Project and EPC Elements

The content of the Description field is only used for documentation within your project. The text is not visible to the outside.
Form Elements

If you enter text in the Description field of a form element, it is not only used for documentation purposes.

The contents of the field are also displayed to the user as a quick info when he hovers over the field.

If you want to use the Description field for the documentation of form elements, make sure that it does not contain internal information.

Use the Description field of form elements to create tool tips for users.

Generating Model Reports

Deprecated since PAS 20.1

If you consistently maintain the descriptions in your project, you fully document the project and the associated process in your BPaaS system. You can also save the documentation in file form using the context menu option Generate Model Report. If you select this option, an export is triggered which saves the data of your model in an Excel file.

ssOpen the context menu on the empty work space of the Project Editor and select the Generate Model Report option.

The Generate Model Report option is also available in the Process and in the Forms Editor.

If you have selected this option, the export starts. The export file is named after the scheme:

  • Current date
  • Name of the model

Confirm to save the file on your computer.

An Excel file is created containing the following information about all the elements used in the model:

  • Type: Element type.
  • Name: The element name.
  • Description: The text you entered in the element's description field.
  • ID: The unique ID of the element within the exported model.

Expert Advice

Use the ID in the global search to find a specific element.
On this Page:
Related Pages:
  • No labels