Generating process documentation reports

This section describes all options for this function. Which options are available depends on your license.

In SAP Signavio Process Manager you can generate process documentation reports. These reports contain all your diagrams, including all element descriptions, and dictionary entries.

You can generate process documentation report in a PDF or Microsoft Word format.

Generate a process documentation (PDF) report

Follow these steps:

  1. Open the explorer and click Reporting > Process documentation (PDF).

    The Process documentation (PDF) dialog opens.

  2. Select the required diagrams.

  3. To add a filter, click Add filter.

    The Edit filters dialog opens.

  4. Select a folder from the drop-down list where you want to search in.

  5. Define the rules for the filter query.

  6. Click OK.

    Diagrams discovered by the filter query are selected for the process documentation (PDF) report.

    The Edit filters dialog opens and displays the number of results returned from your filter query.

  7. Click OK.

  8. In the Configuration section, select a template for the report from the Template drop-down list.

    If there are existing custom process documentation templates, you can use them when creating a process documentation report. Otherwise, the SAP Signavio template is set by default.

  9. Select the required language for the report from the Language drop-down list.

  10. Enter information for the Title, Organization, Author, Date, and Version fields.

  11. In the Export linked subprocesses section, select which linked subprocesses must be included in the report from the drop-down list.

    The following options are available:

    • No linked subprocesses

    • Linked subprocesses of all levels

    • Linked subprocesses of the first level

  12. Click Generate documentation.

The Process documentation report in PDF format generates. Access the report from your browser's downloads folder.

Generate a process documentation (Word) report

Follow these steps:

  1. Open the explorer and click Reporting > Process documentation (Word).

    The Process documentation (Word) dialog opens.

  2. Select the required diagrams.

  3. To add a filter, click Add filter.

    The Edit filters dialog opens.

  4. Select a folder from the drop-down list where you want to search in.

  5. Define the rules for the filter query.

  6. Click OK.

    Diagrams discovered by the filter query are selected for the process documentation (Word) report.

    The Edit filters dialog opens and displays the number of results returned from your filter query.

  7. Click OK.

  8. In the Configuration section, select a template for the report from the Templatedrop-down list.

    If there are existing custom process documentation templates, you can use them when creating a process documentation report. Otherwise, the SAP Signavio template is set by default.

  9. Select the required language for the report from the Language drop-down list.

  10. Enter information for the Title, Organization, Author, Date, and Version fields.

  11. In the Export linked subprocesses section, select which linked subprocesses must be included in the report from the drop-down list.

    The following options are available:

    • No linked subprocesses

    • Linked subprocesses of all levels

    • Linked subprocesses of the first level

  12. Click Generate documentation.

    The Important information dialog opens.

  13. The dialog indicates that the table of contents won't be up-to-date when opening the generated report. Click OK and follow the steps described below after the report generation is complete.

The Process documentation report in Word format generates. Access the report from your browser's downloads folder.

Updating the table of contents in Microsoft Word

Follow these steps:

  1. Open the Process documentation (Word) report.

  2. Select the table of contents and push F9 or right click on each table of contents entry and click Update Field.

The table of contents updates with the correct page numbers.