Setting Hyperlinks to External Documentation 

Use

You can set a hyperlink from the documentation editor of the Integration Builder to external documentation.

You can use the HTML editor to enter simple documentation for an object. If this object requires comprehensive, complex documentation, you can record this documentation externally. You can then set a hyperlink from the documentation editor of the Integration Builder to this documentation. An internal company Intranet or the SAP Knowledge Warehouse can be used for external documentation storage.

Prerequisites

You have opened the object to be documented. You have displayed the documentation editor.

Procedure

...

       1.      To switch to change mode, choose Change Documentation( ) in the documentation editor.

       2.      Select the keyblock in which you want to set the hyperlink in the top half of the screen (HTML editor) (refer to the Creating Documentation for an Object).

       3.      Set a hyperlink to the external documentation in the HTML source code.

You now have the following options:

¡        Hyperlink to any external documentation; specify the relative URL

Use the following syntax: DOCU:PLAIN:<relative path>. The complete syntax for the hyperlink in HTML source code is then in the following form (example): <a href="DOCU:PLAIN:dir/support/index.html">Plain Link</a>)

You can link documentation that is recorded on your internal company Intranet.

¡        Hyperlink to documentation in SAP Knowledge Warehouse; specify the LOIO

You can link documentation that you have recorded in the SAP Library.

Use the following syntax for the hyperlink address: DOCU:KW:<LOIO>. The complete syntax for the hyperlink in HTML source code is then in the following form: <a href="DOCU:KW:<LOIO>">Link-Text</a>.

The LOIO is the 32-figure GUID for the respective information object in the Knowledge Warehouse. You can determine this GUID from the browser preview for the information object in the Knowledge Warehouse.

Example of a hyperlink in HTML source code: <a href="DOCU:KW:086D143F4320D036E10000000A114084">KW-Link</a>

¡        Specify an absolute Internet address

If you specify the absolute internet address when you link to an Internet page, you can specify the Internet address in HTML source code by using the usual syntax.

<a href="http://www.sap.com/index.htm">Link-Text</a>

To specify optional parameters, you can extend the syntax as follows: DOCU:PLAIN:<relative path>[?<optional parameter>] or DOCU:KW:<relative path>[?<optional parameter>]. You can specify the documentation release by setting a hyperlink to documentation in the SAP Knowledge Warehouse.

<a href="DOCU:KW:086D143F4320D036E10000000A114084?release=640”>Link (SAP Knowledge Warehouse, Release 6.40)</a>

Note however, that in this situation, the system does not automatically redirect the hyperlink to the new version following a release transfer.

To ensure that a complete URL can be generated from your entries, the basic URL (e.g. http://www.sap.com/) address must be defined correctly by the administrator. If your hyperlink does not link to the correct target document, contact your administrator. For information about specifying the basis address of the URL, see the SAP XI Configuration Guide ( Configuration of Usage Type Process Integration (PI)).