Configuring the Integration Builder Documentation Editor

When documenting objects in the Integration Repository, you have the option of setting hyperlinks to external documentation. For this purpose, you can enter either absolute paths (internet addresses) or relative paths in the documentation editor (HTML editor). If you use relative paths, you must define a base location for the URL so that the hyperlinks reference the correct target document.

To enter a relative path in the documentation editor, you can use the following syntax:

Ў        DOCU:PLAIN:<relative path> ? For hyperlinks to external documentation on a server or in the Internet/Intranet (see example below)

Ў        DOCU:KW:<LOIO> ? For hyperlinks to documentation in the Knowledge Warehouse

For more information, see Setting Hyperlinks to External Documentation.

You can define the base location centrally for all software component versions or you can define different base locations for different software component versions.

You specify base locations in the administration tool of the Integration Builder.

You have saved documentation on your corporate Internet page (http://www.<mycompany>.com) and want to link to one of these documents from the documentation editor in the Integration Builder.

See also the examples below.

Defining New Base Locations


       1.      To call the administration tool, on the Integration Builder start page, choose Administration from the menu bar.

       2.      Log on to the administration tool.

       3.      On the Repository tab page, choose Manage Documentation Bases (under Documentation Bases).

       4.      Choose Add to Entry to List.

The Change/Add Base Location dialog is called.

       5.      In the Software Component field, select the software component version for which you want to specify the base location.

       6.      Use the table below to enter the remaining information.

Entries for Specifying the Base Location

Input Field


Docu Storage Type

Specify the type of hyperlink that the settings are to refer to.

·         Knowledge Warehouse (File System) for hyperlinks to Knowledge Warehouse documentation that is saved on a file server or on the SAP Help Portal

·         HTTP Server for all other types of hyperlinks

Base URL

Specify the base location.

·         For hyperlinks to Knowledge Warehouse documentation that is saved on the SAP Help Portal, enter the part of the URL preceding the language ID (for example, EN). The language of the target document is the same as the logon language (with which you have logged on to the Integration Builder)

·         In the case of all other hyperlinks, enter the first part of the URL (up to the start of the relative path).

For examples about how the basis address and actual URL are related, see below.

Additional Parameters 

You can specify further standard parameters for the URL in the fields Name and Value.

       7.      Choose Submit Changes.

Defining Base Locations for the Documentation of BPM Patterns and Demo Examples

The documentation editors of the example integration scenarios (demo examples) and the BPM pattern (in software component version SAP BASIS 6.40) contain hyperlinks to further documentation in SAP Help Portal.

To ensure that these links work properly, you have to configure the following base location for software component version SAP BASIS 6.40:

·        Docu Storage Type: Knowledge Warehouse (File System)

·        Base-URL:

Editing or Deleting Base Locations

In the Manage Base Locations for External Documentation dialog

·        Choose Edit to edit an existing base location

·        Choose Delete to delete an existing base location

You must restart the Integration Builder (Integration Repository) for the settings made for the base location to take effect.

Importing/Exporting the Base Location

If you want to reuse the settings made for the base location in another Integration Repository (target system), you can export them from the source system in a directory as an XML file, and then import this XML file into the target system.

To export the settings, proceed as follows (in the administration tool of the source system):

       1.      Call the administration tool in the system in which you want to make the settings for the base location.

       2.      Choose Import/Export DocuBases.

       3.      In the Import/Export External Documentation Locations dialog, position the cursor on Export and in the context menu, choose Save Target As.

       4.      Enter the target directory.

The settings are saved as an XML file in the specified target directory.

To import the settings, proceed as follows (in the administration tool of the target system):

·            ...

       1.      Open the XML file in which the settings are saved.

       2.      Enter the target directory.

       3.      Choose Import.


Example of URLs

Settings in the Administration Tool

Syntax in the Documentation Editor

Determined URL

Docu Storage Type:

Knowledge Warehouse (File System)


<ahref="DOCU:KW: 887ADB7A030B424B8EF29B99461E52A8">

(Integration Builder logged onto in English)

Docu Storage Type:




<ahref="DOCU:PLAIN:Home/Documents/document1.doc">Plain Link</a>