Documentation Package
Documentation for your Processes that includes an image of the Process map, lists all its elements and connectors, and their functional descriptions.
Last updated
Documentation for your Processes that includes an image of the Process map, lists all its elements and connectors, and their functional descriptions.
Last updated
Use the Documentation package to enter and 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 a documented Process.
See the following topics regarding how to view Process documentation and edit the description for Process elements and/or connectors:
View Documentation for a process: from the Processes tab.
Start Event element configuration: for a Start Event element.
Start Timer Event element configuration: for a Start Timer Event element.
Signal Start Event element configuration: for a Signal Start Event element.
Message Start Event element configuration: for a Message Start Event element.
Conditional Start Event element configuration: for a Conditional Start Event element.
Intermediate Timer Event element configuration: for an Intermediate Timer Event element.
Intermediate Signal Catch Event element configuration: for an Intermediate Signal Catch Event element.
Intermediate Signal Throw Event element configuration: for an Intermediate Message Throw Event element.
Intermediate Message Catch Event element configuration: for an Intermediate Message Catch Event element.
Intermediate Message Throw Event element configuration: for an Intermediate Message Throw Event element.
Intermediate Conditional Catch Event element configuration: for an Intermediate Conditional Catch event element.
End Event element configuration: for an End Event element.
Message End Event element configuration: for a Message End Event element.
Error End Event element configuration: for an Error End Event element.
Signal End Event element configuration: for a Signal End Event element.
Terminate End Event element configuration: for a Terminate End Event element.
Form Task element configuration: for a Form Task element.
Manual Task element configuration: for a Manual Task element.
Script Task element configuration: for a Script Task element.
Sub Process element configuration: for a Sub process element.
Boundary Timer Event element configuration: for a Boundary Timer Event element.
Boundary Error Event element configuration: for a Boundary Error Event element.
Boundary Signal Event element configuration: for a Boundary Signal Event element.
Boundary Conditional Event element configuration: for a Boundary Conditional Event element.
Boundary Message Event element configuration: for a Boundary Message Event element.
Exclusive Gateway element configuration: for an Exclusive Gateway element.
Inclusive Gateway element configuration: for an Inclusive Gateway element.
Parallel Gateway element configuration: for a parallel Gateway element.
Event-Based Gateway element configuration: for an Event-Based Gateway element.
Pool element configuration: for a Pool element.
Lane element configuration: for a Lane element.
Text Annotation element configuration: for a Text Annotation element.
Message Flow element configuration: for a Message Flow element.
Actions by Email connector configuration: for an Actions by Email connector.
Data Connector connector configuration: for a Data Connector connector.
DocuSign connector configuration: for a DocuSign connector.
PDF Generator connector configuration: for a PDF Generator connector.
Send Email connector configuration: for a Send Email connector.
Slack Notification connector configuration: for a Slack Notification connector.
