View Documentation for a Process

View documentation for your Processes that includes an image of the Process map, lists all its elements and connectors, and their functional descriptions.

Overview

If the Documentation package is installed, the View Documentation option is available from a selected Process's ellipses menu options from which to view documentation for your Processes. Entered documentation is for informational purposes only and does not affect Request workflow.

The documentation displays as a page within ProcessMaker Platform. Use the Web browser to print or save as a PDF if your browser supports those functions.

Process documentation has the following attributes:

• The page generated by the Documentation package provides the following information about the Process:

  • The name of the Process.

  • When was the Process was last updated and by whom.

  • A description of the Process as entered when creating a new process.

  • An image of the Process map.

  • Names of all Process elements and their unique node IDs.

• The documented description of each Process element and/or connector. If no description has been entered for an element/connector, No Documentation Found message displays.

Below is an example of a documented Process.

Documentation for a Process

View Process Documentation

Permissions and Package Required

The Documentation package must installed to view documentation for a Process. Use the Documentation package to view documentation for Processes that includes an image of the Process map and entered description of its elements and connectors.

Furthermore, your user account or group membership must have the following permissions to view documentation for a Process unless your user account has the Make this user a Super Admin setting selected:

• Processes: Edit Processes

• Processes: View Processes

See the Processes permissions or ask your Administrator for assistance.

Follow these steps to view documentation for a Process:

1. View your Processes.

2. Click the ellipses icon, and then select the View Documentation option for your Process. Process documentation displays as a page within ProcessMaker Platform.
3. Alternatively, use the print or save as PDF functions of your Web browser to print or save Process documentation.

Related Topics

pageWhat is a Process?pageManage Process CategoriespageCreate a New ProcesspageImport a ProcessMaker Platform ProcesspageSearch for a ProcesspageEdit a ProcesspageConfigure a ProcesspageExport a BPMN-Compliant ProcessMaker Platform ProcesspageArchive a ProcesspageRestore a Process