Generating Process Model Documentation

The Process Model Documentation view displays a report of your process model design and the objects it contains. The documentation view can be displayed from the Process Modeler or the Process Model Details page. Links displayed on the report display the details for the selected object. The report provides the following details:

  • Process model properties
  • Business Process Modeling Notation (BPMN) view of the process model
  • Properties for each activity, event, and gateway
  • Swimlane properties
  • Annotations
  • Process flow connection properties

Configuring Printing Options

To ensure the process entire process model diagram prints, use the Landscape page setting. Based on your web browser, configure the printing option below to ensure the process model diagram prints with the grid background. If you do not want to see grid lines, ignore the browser step that sets background graphics.

Chrome

  1. From the process modeler menu, click File > Print.
  2. Unselect the Background graphics (Options) checkbox.
  3. Click OK.

Internet Explorer 11

  1. Access the Page Setup dialog. Depending on your version of Internet Explorer, you may find this dialog via the File menu, the Print button on the toolbar, or the Tools gear icon.
  2. Locate the Paper Options group and select the Print background colors and images checkbox.
  3. Click OK.

Firefox

  1. From the toolbar, click File > Print.
  2. Select the Print Background Colors and Print Background Images checkboxes.
  3. Click OK.

The browser may not render the process model JavaScript in the same manner when printing the documentation as opposed to viewing the documentation. The Firefox plugin ScreenGrab may be useful in configuring the desired results.

Safari

  1. From the toolbar, click File > Print.
  2. Select the Background graphics (Options) checkbox.
  3. Select the Print Backgrounds checkbox.
  4. Click Print when ready to print.
Microsoft Edge does not support backgrounds. See Microsoft's site for additional details.

Viewing Process Model Documentation

From the Process Modeler:

  1. While viewing the process model, select Tools > Generate Documentation from the toolbar.

    • The current process model (saved or unsaved, published or unpublished) is rendered as documentation in a separate window. From the Process Model Details page:
  2. While viewing the process model, click View Documentation from the toolbar.

    • The latest published process model is rendered as documentation.
    • This option is only displayed for Process Administrators and Editors.

Process Model Properties

The following process model properties are listed.

  • Process Display Name:The process display name can be either a typed string of text or an expression.
  • Model Id : This report item lists an ID number used internally to reference the process model.
  • UUID : This report item lists a unique string of 32 hexadecimal digits assigned to the process model once you save it.
  • Last Updated: This report item lists the user name of the user who last saved the process model.

Process Model Diagram

The report displays a BPMN view of the process model. - Click each activity to view its details. - Clicking a Sub-Process activity displays the Sub-Process diagram.

Process Model Contents

The Process Model Contents section of the report lists the objects that appear on the Process Modeler canvas.

Process Start Form Type

If there is a process start form, it is listed as a SAIL Form.

Process Variables

This section of the report lists each of the process variables configured for the process model, and the number of process variables in the process model. The following columns are displayed:

  • Type: The type column lists the process variable's data type.
  • Value: The value column lists any configured default value.
  • Parameter: This column lists whether the process variable is required at the start of the process, as with a process start form.
  • Required: This column lists whether a value must be stored for the process variable.
  • Multiple: This column lists whether the process variable holds more than one value.
  • Hidden: This column lists whether the process variable is hidden from reports.

Lanes

This section lists the swimlanes configured for process activities in the process model. The following columns are displayed:

  • ID : A number used internally to reference the swimlane.
  • Label: This report item lists the name of the swimlane as it appears on the process model.
  • Height: This report item lists the height setting for the swimlane.
  • Attended: An attended lane overrides individual assignment settings for attended activities in the lane, and sets assignment to this designated user or group.
  • Assignees/Run As: When a swimlane is assigned, this column lists the user or group that the activities in the lane are assigned to. When activities are unassigned, this column lists the user account that is used to resolve security requirements.

Node List

This section of the report lists all nodes that appear in the process model. The following columns are displayed:

  • ID: A number used internally to reference the node at runtime.
  • GUI ID: A number used internally to reference the node at design time.
  • Name: The name displayed on the Process Modeler canvas.
  • Task Display Name: The name displayed on any tasks assigned by the activity.
  • Lane: The name of the swimlane that contains the node, if any.
  • Attended: This column lists whether the node is assigned to a user or group as a task.
  • Assignees/Run As: When an activity is assigned, this column lists the user or group that the activity is assigned to. When the activity is unassigned, this column lists the user account that is used for security permissions.

Annotations

This section of the report lists any notes that appear in the process model. The following columns are displayed:

  • GUI ID: A number used internally to reference the note.
  • Text: The content of the note.

Connections

This section of the report lists the flow connectors that appear in the process model. The following columns are displayed:

  • Start Node: The process node where the flow connector originates.
  • End Node: The process node where the flow connector terminates.
  • Activity-Chained: This column lists flows that are configured to automatically display the next assigned task.

Process Model Node Details

Each node that appears in the process model is listed in greater detail in this section. The following information appears for each node below its name and icon:

  • Node Type: This line item lists the name of the type of node used as it appears on the Process Modeler palette. It also lists the internal object name in parentheses.
  • Form Type: Smart service activities display the type of form configured (dynamic or JSP). A dynamic form uses the process modeler. JSP forms list the path to the JSP.
  • UUID: This line item lists a unique string of 32 hexadecimal digits assigned to the associated node once you save the process model.
  • Description: This line lists any descriptive text entered for the activity on the general tab of the node properties dialog box.
  • Task Display Name: The name displayed on any tasks assigned by the activity. A rule or expression may be used to resolve the display name at runtime.
  • Lane: The name of the swimlane that contains the node, if any.
  • Attended: This item lists whether the node is assigned to a user or group as a task.
  • Assignees: When an activity is assigned, this item lists the user or group that the activity is assigned to. When the activity is unassigned, this item states that the node is run as either the process initiator or the process designer.
  • Exception Flow Triggers: Smart services list any rules configured to trigger an exception flow.

Event Nodes

Process events are listed according by name and process modeler icon. The following details are listed for each process event:

  • Event Type: This line lists the type of event node, or the type of event configured for a node such as send message, or receive message.
  • Conditions to activate event node: Each logic test that must be satisfied before the event is triggered is listed.

Send Message Events

  • Message Type: This line lists the type of message being sent such as email or process.
  • Message Body: This line lists the body text of the message that is sent.

Mappings

The event mappings are listed in a table that displays the following columns.

  • Name: The name of each property.
  • Value: The data listed for each property configured for the event mapping.

Receive Message Event

  • Listen for messages of type: Typically, this property lists either email or process-to-process messages.
  • Once activated, listen for messages for the life of the process: True/False. This property lists whether the an event is activated once, or whether it can be activated multiple times.

Gateways

Each gateway node is listed with its standard node properties. Each gateway also lists the conditions that route process flow to different nodes in a table. This table displays the following columns.

  • Condition: The logical test that must be true to activate an outgoing flow.
  • Result: The outgoing flow to activate, listed according to its destination node.
  • Path Label: The label that appears on the outgoing flow (if any).

Node Inputs Table

When a node has configured data inputs, this table lists the data collected. This normally only occurs in assigned nodes (we don't recommend configuring node inputs for unassigned activities. Use outputs instead.) The following columns are displayed.

  • Name: The name assigned to the node input variable.
  • Type: The type column lists the process variable's data type.
  • Value: The value column lists any configured default value. When the default value of a custom Complex Data Type (CDT) is set within the parent element, the Value column displays the expression or literal value specified. When the default value is defined within a sub-element of a CDT, the Value column appears blank.
  • Parameter: This column lists whether the process variable is required at the start of the process, as with a process start form.
  • Required: This column lists whether a value must be stored for the process variable.
  • Multiple: This column lists whether the process variable holds more than one value.
  • Hidden: This column lists whether the process variable is hidden from reports.

When a complete CDT hierarchy, or when the parent element of a CDT is saved into a process variable, it is listed as a node input. When a sub-element of a CDT is saved into a process variable or subelement of a CDT, it is displayed as a node output.

Node Outputs Table

When a node has configured outputs, this table lists the output data. The following columns are displayed.

  • Expression: The name of the output is taken from the expression used to formulate the output data.
  • Operation: Different operations can be performed on output data, such as appending the values to an array. This column lists the operation performed when storing the data.
  • Variable: This column lists the process variable storing the output data.

Sub-Process Activities

Click the name of the sub-process to display process model documentation for the configured Sub-Process. Resting your pointer on the name of the Sub-Process displays an image of the process model.

Sub-Process activities display the following additional report items:

  • Is Asynchronous: True/False. Synchronous Sub-Process Activities must end before the process flow continues. Asynchronous Sub-Process Activities launch the child process and continue the flow.
  • Data from sub-process can be included...: True/False. Process reports can aggregate data from multiple process models when this is true. Process variables should have different names in each process model referenced by the report.
  • Sub-process inherits security from parent process: True/False. Should a user not have the right to view a sub-process, the parent process may pause due to a security exception. Inheriting security from the parent allows users to launch the Sub-Process model if they have the right to launch the parent process.
  • Sub-Process Model: This line lists the name of the Sub-Process model. The process model ID or UUID are listed in parentheses (PmId, PmUUId).

Sub-Process Data Mapping

Sub-Process Activities pass variable data from parent to child. Synchronous Sub-Process Activities can also pass data from the child to the parent process. The report lists any such variables.

For Input Variables, the following columns are displayed.

  • Sub-Process Variable: The name of the parameter in the child process model that receives data from the parent process.
  • Set From: The name of the parent process variable.

For Output Variables, the following columns are displayed.

  • Sub-Process Variable: The name of the process variable in the child process model that returns data back to the parent process.
  • Save Into: The name of the parent process variable that receives data from the child process.

Best Practices

We recommend maintaining detailed process model documentation to allow other process developers easily read and maintain your process models. - Update the process model properties and activities with clear descriptions. - Annotations the process model to call out sections that need additional explanation. - Use descriptive names for your process variables.

Beyond the process model documentation report:

Create portal pages (or write documents) that describe any complex parts of the process model that need additional explanation.

See also: Updating Process Model Properties

17.2

On This Page

FEEDBACK