Generating process documentation

The process documentation generation feature in the BMC Atrium Orchestrator 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 BMC Atrium Orchestrator 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 BMC Atrium Orchestrator Development Studio, in location you choose. You can review the documentation in a web browser or an application that displays PDF files.
  Unknown macro: {multi-excerpt}

  To generate process documentation

  1. In the BMC Atrium Orchestrator Development Studio Project Navigator, right-click on a process.
  2. Select Generate documentation.
  3. In the Workflow Doc Gen window, select the file format, either HTML or PDF.
  4. Specify the file path or click the Browse button and navigate to a location.
  5. 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.