Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

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

...

Schedule Scenario Export

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

...

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

  • Image Removed = create a new row
  • Image Removed = delete a row
  • Image Removed = save and exit

...

Scheduling the Document Generation

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

Note

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:Image Removed

...

The documents will be exported to the export path:Image Removed

...

Info

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

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

...

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

...

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

...

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

  • Image Modified = Document generation was successful

  • Image Modified =

     Document

     Document generation was unsuccessful and had errors

Info

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

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

...

Limitation

The following restrictions exist in this version for automated documentation:
Note
  1. The table of content cannot be created, because the AutomationTool runs as a service

    and not under a

    (not as an actual Windows user).

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

    This restriction applies, for example, to:

    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 

      entities

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

    .It

    .

  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

    insert

    display the version of the Scenario documentation

    into

    .

  6. If the file name

    .The documentation of the scheduled Scenario is always overwritten if the filename is identical

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

Schedule the 'Analysis for Office' Excel Documentation

...

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.