Generating process documentation
The process documentation generation feature in the
Development Studio application allows you to create a PDF or HTML file that contains the attributes and a graphical representation of the process. This file saves to the name and location you specify.
The uses for this documentation include internal audits or documentation for operators using the
Operator Control Panel application. In addition to the graphical representation of a process, the process documentation contains process attributes such as:
- Process name
- Full path to the process
- Module name and directories that contain the process
- Process description from the process properties
- Process properties
- Input parameter names
- Output parameter names
The generated process documentation resides outside of
Development Studio, in the location you choose. You can review the documentation in a web browser or an application that displays PDF files.
To generate process documentation
- In the
Development Studio Project Navigator, right-click on a process.
- Select Generate documentation.
- In the Workflow Doc Gen window, select the file format, either HTML or PDF.
- Specify the file path or click the Browse button and navigate to a location.
- Click OK to save the file location.
The file is saved in the location and format you specified. The graphical representation of the process is saved in a .png format in a directory with a name based on the file name.
Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*