Skip to main content

Automated Export


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.

Automation Tool exporting all scheduled Scenarios with specific settings at a given time

Schedule Scenario Export

In order to document automatically, the required Scenarios must first be set in the Performer Suite itself:

Schedule Scenario option in the Scenario Dictionary of the Performer Suite

The specific Scenarios you want to export and other settings can be specified here (Settings Variant, Doc. Language, Word Template, Comment Variant, Comment Language):

Scheduled Scenarios with settings for Settings and Comment Variant, Languages, Template

Scheduling the Document Generation

The document generation can either be scheduled for all your SAP systems or only selected ones.

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).

Specify the export path to which the automated Scenarios should be exported:

Export path set in the Automation Tool

The documents will be exported to the export path:

Exported Scenarios in the set folder

If the exported Scenario should be uploaded into your Confluence, the setting "Confluence Integration" has to be activated.
Set the "Export Path" below and set the remaining Confluence parameters: Email, Token, Confluence URL, Confluence Space Key, and Parent Page.

Via the gear button you can open the "Schedule Settings":

Schedule Settings button for scheduled Scenarios

Set the interval and time you wish the Scenarios to be generated:

Schedule Settings window with settings for Frequency and time

After you confirm the settings with OK, the details are shown in the column "Scheduled":

Scenario export scheduled for every day at 3 30 p.m.

The status of the last document generation is displayed in the column "Status of last Doc.". 

  • = Document generation was successful

  •  = Document generation was unsuccessful and had errors

Check the log file, if the document generation was not successful.

The date and time at which the next document generation will be performed is shown in the column "Next Doc.".

Status of last export successful

Limitation

  1. The table of content cannot be created, because the AutomationTool runs as a service (not as an actual Windows user).

  2. It is not possible to export images of entities.

    1. the Data Flow Network grafic as an image of an InfoProvider

    2. the scheme network of Process Chains

    3. all other illustrations of entities

  3. BO: The technical documentation of a BW DataSource in a BO documentation is not considered for the automated export.

  4. SAC: Only the Auth. Grant Interactive Usage & API Access (Client Credential Grant) can be used.

  5. In the file name it is not possible to display the version of the Scenario documentation.

  6. If the file name is identical, the export of the Scheduled scenario will always overwrite the current file.

Schedule the 'Analysis for Office' Excel Documentation

Scheduling of Analysis for Office Excel documentations via the Automation Tool

Exports all your AfO Workbooks into one EXCEL file.
Recommendation: Run a BO sync first, to have the AfO Workbooks fully up to date before you start this AfO export.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.