Generating and Using Process Documentation › Generate Process Documentation

Generate Process Documentation

You can generate process documentation at any time. For example, use this feature to record the status of a process before you transition it to production.

Follow these steps:

1. Open the process from the Library tab.
2. In the Designer tab, click Process Documentation toolbar button.

   

   The Process Documentation Options dialog opens.

3. (Optional) Select options to include in the documentation.
   • Process Dataset
   • Operator Information
   • Pre-/Post-Execution Code
   • Operator Properties
   • Operator Dataset
   • Exception Handler (if selected, CA Process Automation generates documentation and an image file for any operators in the Exception Handler)
   • Lane Change Handler (if selected, CA Process Automation generates documentation and an image file for any operators in the Lane Change Handler)
4. Click OK.

   A dialog prompts you whether to open or save the file.

5. Click open to view the contents of the Zip file, or click Save to save the Zip file to a location of your choice.

   The Zip file contains:

   • A PDF file that contains the process documentation.
   • The full-size images contained in the process documentation. The PDF contains scaled images, so they may not be legible if the process is very large.
   • An XML file that contains the raw data used to generate the documentation in XML format. This file lets you transform the XML into other formats.