Generating Documentation Reports

You can generate an HTML Documentation Report of your Designer process at any point during process development. For processes that originate in ARIS Architect, you can also generate a Documentation Report from the Solutions view using the ARIS context (right-click) menu. This can either be an explicit documentation report upload to ARIS, or as an option when synchronizing with ARIS. For more information, see Working with ARIS Processes in the Solutions View and Synchronizing ARIS Processes.

Setting

Description

Report File Name

By default, the name of the process is used, but you can specify a different name. Type the name you want to use.

Note:

If you select an SVG Process Image Type, Designer requires that the Report File Name contain only ASCII characters.

Process Image Type

When you create a report, you also create an image file of your process. Click the button preceding the type of image you want the report to generate (PNG, JPEG, or SVG).

Note:

If you select an SVG Process Image Type, Designer requires that the Report File Name contain only ASCII characters.

Sort By

You can choose to list the steps in your process in several ways. Click the button preceding Ascending by Step Name, Descending by Step Name, or Task/Event Order.

CSS Style Sheet

You can format your HTML Documentation Report using a CSS. Click the button preceding Default Style, Classic Style, or Custom CSS.

If you choose to use a Custom CSS, your style sheet must be located in the same folder as the Save to Location. Specify the file name in the text box.

Save to Location

Documentation Report files are saved by default to the root of the workspace parent directory with the name of the process project (c:\Documents and Settings\<user name>\<process name>.html), but you can specify a name and location of your choice. Click Browse to navigate to and select the directory in which you want to save the report.