Confluence Integration

Starting with version 20.1 it is possible to integrate the created documentation into Confluence.
This function works for all supported components (BW/BO/HANA/SAC).

There are two approaches for Confluence documentation: Confluence integration based on the specific or general path:

Open

In order to use the Confluence documentation, parameters have to be added to the Confluence Integration Settings first.

Specific Path

Assign a Confluence Page to SAP Objects

A specific, existing Confluence page can be assigned to each Object and Scenario.

The assignment can be done in two ways:

• Assignment via the context menu:
  Select one or more Objects to which you want to assign a Confluence page

  Open

  

• Assignment via the "Confluence Page" column
  Use the Column Chooser to add the "Confluence Page" column to the Entity Grid

  
  Double-click on the field of the "Confluence Page" column of the Object to which you want to assign a specific Confluence Page.

Next, a window opens in which a Confluence Space can be selected:

After the selection of the Confluence Space, the Performer Suite loads all existing Confluence Pages of this space:

Next, you can select a specific page by activating the radio button of the respective Confluence Page. The assignment can be confirmed with "Save".

The selection (<Space>\<Page>) is then displayed in the "Confluence Page" column for the respective Object:

Assign a Confluence Page to Scenarios

For Scenarios the assignment of the Confluence page works in the same way:

The specific page can also be considered for automated export via the AutomationTool. To do this, the Confluence page for the selected Scenarios must be selected in the "Scheduled Scenarios" window:

Unassign Confluence Pages

The unassignment of a Confluence page can be done for SAP Objects and Scenarios via the context menu ("Others" > "Unassign Confluence page") or by deleting the values in the field of the column "Confluence Page":

Documentation based on the specific path

The documentation of SAP objects or scenarios to which a specific Confluence page has been assigned can be started via the context menu:

The documentation is then uploaded to the existing page:

The Confluence documentation can also be done for several Objects at the same time so that the Objects are distributed on the pages assigned to them.

If the specifically assigned Confluence pages of the Scenarios are to be considered for automated export by AutomationTool, at least the parameters "User Name/E-Mail", "Password/Token" and "URL" must be entered:

General Path

If no specific path is defined for an object or Scenario, Docu Performer uses the general path based on the inserted parameters of the settings.

Docu Performer considers the defined parameters in the Confluence Integration Settings area and creates sub-pages under the defined Parent Page within the defined Confluence Space.
In this example, the page "Confluence Documentation" was defined as a parent page and a Query was then documented. Docu Performer creates the following page structure:

• Defined Parent Page

  • System SID of the documented Object

    • Object type of the documented Object

      • Documentation of the documented Object

This is what it looks like in Confluence:

If the selected Scenarios should be automatically integrated into Confluence based on the general path, at least the parameters "User Name/E-Mail", "Password/Token", "URL", "General Path", "Confluence Space Key" must be activated/entered:

Troubleshooting

Please check your application Firewall, if you get the "Error while uploading attachment".