Documenting Processes

Processes can be easily documented as process manuals.

Prerequisites

You require access rights for documenting a BPMN process.

The model configuration contains a configured documentation command and the execution right is assigned to the user's active role.

The documentation command's Word Template option takes you to a suitable template file.

The documentation command does not have the Always value as the Open Result property.

Purpose

Process manuals can be created as attachments for BPMN processes; these can be easily updated. You can also access this function via concepts with a concept realization for a BPMN process.

You can configure documentation commands for documenting a process as a process manual and make it available for roles with appropriate execution rights in the Extras>Update Process Manual ribbon group.

Opening a documentation command with Extras>Update Process Manual><Documentation Command> creates a documentation for processes and concepts in the selection. The process manual is saved as an attachment for the process.

How to Proceed

Use the documentation commands in the Extras>Update Process Manual ribbon group to create a process manual as an attachment for the process or update an existing one.

Select at least one BPMN process or concept that has a concept realization for a BPMN process.

You can cancel creation of the process manual if a configured verification fails. The created process manual has the name of the documentation command as the file name, is attached to the process and replaces any existing process manual.

Configuration

Using Application Configuration

You can load the model-wide application configuration from the $INOHOME\ProcessCharacteristics.json file using the Extras>Update Process Manual>Load Application Configuration command if you have the Edit Model-Wide Configurations privilege.

Note

Changes only take effect after the model editor has been restarted.

You must explicitly set roles and documentation commands in the application configuration, otherwise all roles with the appropriate execution rights will be able to use all documentation commands configured in the model configuration.

Editing the Application Configuration

Prerequisites

Due to your currently used role you have the privilege Edit Model-Wide Configurations.

Context

You can edit the current application configuration locally in a text editor.

If roles are configured in the application configuration, then only these configured roles can execute documentation commands. If no roles are configured, then all roles with appropriate execution rights can execute documentation commands.

You should configure documentation commands in the application configuration so that appropriate documentation commands appear for selection. If no commands are configured, then all documentation commands configured in the model configuration with execution rights for the active role appear for selection.

How to proceed

Save the current application configuration as a $INOHOME\ProcessCharacteristics.json file in $INOHOME (default directory: %APPDATA%\Innovator\16.0) using Extras>Update Process Manual>Save Application Configuration to set which roles a process manual can create and which documentation commands should appear.
Open the $INOHOME\ProcessCharacteristics.json file in a text editor.
Add the localized name of the documentation command as a value in the DocuCommands JSON element so that a process manual can be created using one or more particular documentation commands. Separate multiple documentation commands using commas.
Add the name of the role as a value in the Roles JSON element so that a process manual can be created for one or more roles. Separate multiple roles using commas.
Save the file in the same $INOHOME directory.
Load the file with Extras>Update Process Manual>Load Application Configuration.

Note

Changes only take effect after the model editor has been restarted.

Application Configuration Example

{
  "DocuCommands": [
    "DiagramOriented",
    "HierarchyOriented"
  ],
  "Roles": [
    "Business Analyst"
  ]
}

Configuration of Documentation Commands, Execution Rights and Menu Commands

Each documentation command available in the application configuration must be configured for the executing roles in the model configuration and as a command in the menu.