Chapter Overview:
General
With the AutomationTool you can schedule an automated background export of the Scenarios you have created in the Performer Suite.
This tool can perform a documentation export that runs automatically, for example overnight. This has the great advantage that up-to-date documentation is always available to all users without the need for a manual export.
Perform automated Documentations
To document automatically, the required Scenarios must first be set in the Performer Suite itself:
The specific Scenarios you want to export and other settings can be set here (Settings Variant, Doc. Language, Word Template, Comment Variant, Comment Language):
- New rows can be added via the
button - Select a row and press via right-click
to delete - Save via
Scheduling of the Document Generation
The automated document export in the background can only be performed if:
- Scenarios and their settings have been selected (see chapter below)
- Services have been installed and started (learn more).
The document generation can either be scheduled for all listed systems or individually planned for each of them.
Scheduling the Document Generation
Specify the export path to which the automated Scenarios are to be exported:
If the exported Scenario is to be uploaded directly into Confluence, the path setting "Confluence Integration" needs to be activated.
Maintain the "export path" below and set the remaining Confluence parameters as Email, Token, URL, Space Key, and Parent Page.
Via the gear button you can open the "Schedule Settings":
Set the interval and time you wish the Scenarios to be generated:
After you confirm the settings with OK, the details are displayed in the "Scheduled" column:
The status of the last document generation is displayed in the column "Status of last Doc.".
= Document generation was executed successfully
=
The date and time at which the next document generation will be performed are displayed in the "Next Doc." column.
If the document generation was not successful, we recommend checking the log file.
The documents will be stored in your defined folder:
The following restrictions exist in this version for automated documentation:
- It is not possible to export images of entities. This restriction applies, for example, to:
- the Data Flow Network as an image of an InfoProvider
- the scheme network of Process Chains
- all other illustrations of entities
- The technical documentation of a BW DataSource in a BO documentation is not considered for the automated export.
- It is not possible to insert the version of the Scenario documentation into the file name.
- The documentation of the scheduled Scenario is always overwritten if the filename is identical.