Configuring the Documentation
Editor
Use
When documenting objects in the Enterprise Services 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 (refer to the example below)
○ DOCU:KW:<LOIO> − For hyperlinks to documentation in the Knowledge Warehouse
More
information:
Entering
Hyperlinks.
You specify base locations with the administration tool of your Enterprise Services Repository.
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 Enterprise Services Repository.
Refer also to the examples below.
Defining New Base Locations
...
1. To call the administration tool, on the Enterprise Services Repository 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.
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 |
Settings |
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 your Enterprise Services Repository start page) · In the case of all other hyperlinks, enter the first part of the URL (up to the start of the relative path). Below you find examples about how the basis address and actual URL are related. |
Additional Parameters |
You can specify further standard parameters for the URL in the fields Key and Value. |
7. Choose Save.
Defining Base Locations for the Documentation of BPM Patterns and Demo Examples
The documentation editors of the example process 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: http://help.sap.com/saphelp_nwpi71/helpdata/
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 Enterprise Services 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 Enterprise Services 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 Manage Documentation Bases.
3. Under Export, choose Download and download your base location settings.
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 Upload.
Defining the Base Location for Documentation in the SAP Solution Composer
To call up documentation provided for Enterprise Services Repository objects in the SAP Solution Composer, you have to use the following property to specify the base location of the host where your SAP Solution Composer is running:
com.sap.aii.ib.core.docu.repository
The base location depends on whether your target documentation is located in a locally installed SAP Solution Composer or at the ES Workplace.
The correct base locations are published on SAP Developer Network (SDN) at https:/sdn.sap.com → SOA Middleware → Repository-Based Modeling and Design. In the Knowledge Center on page Repository-Based Modeling and Design, select Enterprise Services Repository and Registry. On the page Enterprise Services Repository and Registry, select the document Basic URLs for Links From ES Repository to Object Documentation in SAP Solution Composer.
More information:
Navigating to
Object Documentation in SAP Solution Composer.
Examples
Example of URLs
Settings in the Administration Tool |
Syntax in the Documentation Editor |
Determined URL |
Docu Storage Type: Knowledge Warehouse (File System) Base-URL: http://help.sap.com/saphelp_nwpi71/helpdata |
<ahref="DOCU:KW: 887ADB7A030B424B8EF29B99461E52A8"> |
http://help.sap.com/saphelp_crm40sr1/helpdata/EN/2A/ADA4D0F0E99843B3AA305AA68E6E63/frameset.htm (Enterprise Services Repository logged onto in English) |
Docu Storage Type: HTTP-Server Base-URL: http://www.<mycompany>.com |
<ahref="DOCU:PLAIN:Home/Documents/document1.doc">Plain Link</a> |
http://www.<mycompany>.com/Home/Documents/document1.doc |