Skip to main content

Automated Export


General

With the AutomationTool you can schedule an automated background export of SAP objects and 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 Exports

To document automatically, the required Scenarios or objects must first be collected in the Performer Suite itself. The documentation scheduling can be found in the Administration area under “Documentation > Documentation scheduling”.

Documentation Scheduling in the Administration ribbon

The specific elements you want to export and other settings can be specified here. When clicking the “Add”-button objects and scenarios can be selected for scheduling in the pop-up. Elements can also be added to the schedule in other areas via the context menu under the “Others > Schedule documentation”.

Element selection
Scheduling3.png

The export settings can be maintained in the grid. Settings variant, comment variant, languages, Word template, a specific confluence page, and, in case of scenarios, the export source can be set here.

Scheduled document list and settings

When all objects and scenarios are scheduled and all settings are made, the list has to be saved.

Scheduling the Document Generation

The schedule for the automatic documentation is done in the AutomationTool.

The automated document export in the background can only be performed if:

  • Scenarios & Objects and their settings have been selected.

  • Services have been installed and started (learn more).

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

Standard export path

The documents will be exported to the export path and sorted into different folders according to the source system:

Folder Structure

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.

Confluence Export path

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

Schedule Settings

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.

Show logfile button

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

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

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

  4. DSP: It is not possible to document Datasphere objects automatically, because a manual login is required to connect to the system.

  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.