Start of Content Area

Procedure documentation Navigate to the object documentation in SAP Solution Composer  Locate the document in its SAP Library structure

Function

For ES Repository Content, for which documentation exists in SAP Solution Composer, you can connect the corresponding ES Repository objects directly with the object documentation in SAP Solution Composer. In this case, you can navigate from the object editor in the ES Repository to the object documentation.

Regardless of whether you have installed SAP Solution Composer or not, you have the following options:

Options for Connecting External Documentation

Situation

Option

SAP Solution Composer installed

In this case you can navigate from an object in the ES Repository to the documentation for this object in the locally installed SAP Solution Composer.

SAP Solution Composer not installed

In this case you can navigate from an object in the ES Repository to the documentation for this object on the Enterprise Services Workplace (ES Workplace).

Since the ES workplace is accessible using the SAP Developer Network (SDN), this option is also available for customers who have not installed the SAP Solution Composer.

Note

For more information about ES Workplace see the SAP Developer Network (SDN) under https://www.sdn.sap.com/irj/sdn.

Prerequisites

To navigate from an object in the ES Repository to the corresponding external documentation, you must fulfill the following prerequisites.

Note

The configuration steps required are normally performed by the administrator.

Setting for Software Component Version

In the ES Repository you can decide separately for each software component version whether the software component version objects are to be connected with external documentation from the SAP Solution Composer.

In this case the Use External Documentation check box must be selected for the software component version in the editor.

More information: Editing Software Component Versions

Note

If this field is deselected, the integrated HTML editor is available for the software component version objects.

More information: Creating Object Documentation in the HTML Editor

Entering the Base Location

To find the target documentation, the administrator must specify the base location of the URL.

More information: Configuring the Documentation Editor

Ensure that the base location is valid for all software components for which the corresponding identifier is set.

Procedure

To display the object documentation, follow the following steps:

...

       1.      Open the object for which you would like to display the documentation,

       2.      In the menu bar of the object editor, choose Show/Hide Documentation (This graphic is explained in the accompanying text).

The documentation is opened in a separate browser window.

Note

If you are not taken to the right target document then refer to your administrator.

 

End of Content Area