Start of Content Area

Function documentation Linking Content Objects with the SAP System  Locate the document in its SAP Library structure

Use

To show the user information objects for the application context in the Application Help, you must create a link between content objects and contexts in the SAP system. You can set up this link with help links. Help links are defined by entries in a control table that are evaluated at runtime by the SAP system help processor. You can create a help link to:

...

       1.      a context in the SAP system (e.g. an application transaction),

       2.      a content object

       3.      the structure to which the content object is linked.

Note

Content objects that are not assigned to any structure cannot be linked with the SAP system.

Use the Link Assistant to create such links without having to edit the control table directly.

Integration

Transport Connection

Help links are not stored with the management data in the SAP Knowledge Provider like hyperlinks between content objects. They are stored in the SAP application system. You must therefore maintain the help links in the relevant SAP development system. The Link Assistant provides a link to the development system where a transport request can be created. After maintaining the help links, you must use the Workbench Organizer to release the change request directly in the relevant SAP development system.

Contexts in the SAP System

The SAP system help processor evaluates the current application and help link control table context when Application Help is called. If there are help links for the current context, the content objects they specify are displayed.

The standard contexts evaluated by the help processor are based on SAP system application objects. The following contexts in the SAP system can be defined (in order of their resolution):

·        a screen of a program in a transaction

·        a screen of a program

·        a program in a transaction

·        a program

·        a transaction

·        a package of a program

Note

You can identify the transaction, program and screen number of the current context at any time in the SAP system by choosing System  ® Status: The data is displayed in a dialog box. If the screen and GUI programs displayed are different, always use the screen program for help links.

These contexts can be general or specific to different degrees. For example a transaction is a more general context than a screen in a program in this transaction. If the context applies to several content objects when Application Help is called, the content object linked with the most specific context is displayed. In the example the document linked to the screen of the program of the transaction is displayed, rather than the document linked to the transaction.

Programmed Help Links

In addition to help links referring to such standard contexts, the Link Assistant can also define special help links to an Application Help directly from the program, independently of the help processor. The activation of such help links requires program changes.

Prerequisites

The table entries for help links must be transported from the development systems. You must have the required authorization to create a change request in a development system with the Link Assistant.

You can only maintain help links for information objects in productive folders.

To be able to display the content objects with help links, there must be a released version of the content object.

Features

The Link Assistant functions are:

·        In the preview: (only for book structures)

-         Create help links for a chosen content object in the structure

-         Change help links for a chosen content object in the structure

-         Delete help links for a chosen content object in the structure

-         Create help links for a chosen content object within a structure include

-         Change help links for a chosen content object within a structure include

-         Delete help links for a chosen content object within a structure include

·        In structure maintenance: (only for book structures)

-         Create help links for a chosen content object in the structure

-         Change help links for a chosen content object in the structure

-         Delete help links for a chosen content object in the structure

·        In the Info Object List:

-         Display help links to chosen content objects or to a package

-         Delete help links for chosen content objects

A content object can be linked to several different contexts.

Caution 

Help links are not automatically adjusted for subsequent structure changes. This can result in an incorrect help display.

-         If a substructure containing a content object referenced by a help link is split off, it is assigned to the new (sub)structure. In the online help it is still displayed with the structure to which it was assigned when the help link was created.

-         If you assign the content object to another structure or remove it from the structure, the referenced combination of structure and content object no longer exists. An incorrect content object or no content object at all is displayed.

-         If the old structure is no longer delivered to customers, the content object is displayed in the Application Help without a structure. An error message appears in the structure frame.

The function Check Help Links can be used to prevent an incorrect help display.

 

 

End of Content Area