To integrate published help content with SAP GUI clients, you must perform the following steps:

For the installation, an SAP Service Marketplace user with administration rights is required. In the target SAP system, a user with developer rights, registered as a developer, is required.

 

Register an Object in the SAP Service Marketplace System 

An SAP Administrator or someone who has administrative rights for the target SAP installation in the SAP Marketplace must perform this procedure.

 

Register the following object: "PgmID:R3TR, Object:FUGR, ObjectName:SHL2" and make a note of the access key.

 

Copy the Transport Files to the SAP Server 

The transport file contains two files, Kxxxxxx.nnn and Rxxxxxx.nnn, where x and n will vary, depending on the version of the Developer that the transport is from. These files must be copied to the SAP server. They are contained in a file called HEMITransport.zip and are located in the front folder in the Developer installation.

 

Note: You will need an unzip utility such as WinZip to unzip the files.

 

Import the Transport Files 

The transport files that you copied to the SAP server need to be imported into the SAP system. A Basis administrator should perform this step.

 

All objects in this transport are located in the registered development namespace /GKOD/. This development namespace ensures that no naming conflicts can arise in your SAP system due to the transport.

 

Note: If you want to check the import logs of the transport, select the Goto menu and then the Import History command. A return code 4 (Warning) and below is acceptable.

 

Special Note for SAP Unicode-based Systems 

If your SAP System is Unicode-based, please apply the transport in the following manner via the command line.

 

Verify that your instance profile has the following parameter set: abap/unicode_check=on.

 

Apply the transport using the following procedure from the command line:

  1. Go to your \usr\sap\trans\bin directory.
     
  2. Type the following:
     
    tp addtobuffer nnnKxxxxxx <SID>
     
  3. Type the following:
     
    tp import nnnKxxxxxx <SID> -Dsetunicodeflag=true client<num> pf=TP_DOMAIN_<SID>.pfl

    Example:
     
    tp import D6CK900100 UC3 -Dsetunicodeflag=true client800 pf=TP_DOMAIN_UC3.pfl

If you system is Unicode, refer to SAP Note 330267 before importing the content.

 

Customize the SAP Help Menu  

Once the transports have been imported into the SAP system, you must customize the SAP Help menu. Using transaction se43, customize the SAP System Help menu to launch Player content by creating a menu item with 'Code' ZOND and 'Functional Type' H.

 

To customize the SAP Help menu: 

  1. Using transaction se37, modify the HELP_START function module. You will need the access key obtained earlier. (Note: the status message...)
     
  2. Insert a modification above the line with statement "when 'GLOS'."
     
  3. Enter the modification, "include /GKOD/..."
     
  4. Save and activate the modification.

Customize the HELP_START Function in SAP  

In this step, you must edit code to customize the “help_start” function in SAP. This function launches SAP Help menu commands and must be modified to launch the Player with special parameters.

 

Note: The status message "Object FUNC_HELP_START is part of the Basis interface; further development not allowed" may appear. This message is not an error, and you should continue with the procedure.

 

To Customize the HELP_START function: 

  1. Enter *OnDemand Include.
     
  2. Press Enter.
     
  3. Type include /GKOD/Y_START_ONDEMAND.

The space between “include” and the / in the statement above, as well as the period at the end of the statement, is required.

 

Configure the Gateway URL 

In this step, you configure the help menu entry you created to point your deployed content. The content must be installed on a Web server to determine the correct URLs to enter into the system.

 

You can set up the URL to call Player content in any client, or you can set up client-dependent base URLs. When you enter a Default Base URL and select the Enabled option, the entry is used to call Player content in any client by default. If you save the entry with the Enabled option deselected, the Default Base URL is not used in the system. If you do not want to use the Default Base URL, you must still enter an empty string in the table. If the entry is not defined, you will receive an error message.

 

You can create client dependent base URLs as well. If there is no entry in the Client Dependent Base URL table for a specific client, the Default Base URL is used for that client. When the Enabled option is selected for a client, then the URL for the client is taken as the Base URL. When the Enabled option is deselected for a client, then Player content is deactivated in the client, and users will receive an error message when calling Player content.

 

You must log in to the SAP system as a user with developer rights. Since the table you will be using is defined as client independent, you can log in to any client to change the entries.

 

To configure the Gateway URL: 

  1. Go to transaction /n/GKOD/SS.
     
  2. On the Setup menu, choose Default Base URL.
     
  3. In the Default Base URL field, enter the path to the sap_gateway.html page in the content for SAP on the Web server. This must be a fully-qualified URL containing the sap_gateway.html page. The sap_gateway.html page is located in the front\hemi folder within the Player installation.
     
  4. Click the Enabled option to select it, if necessary.
     
  5. Click Save Save.
     
  6. Click Continue Continue.
     
  7. On the Setup menu, choose Client Dependent Base URL.
     
  8. In the Table/View field, enter /GKOD/YEXTHLPURM if necessary.

Translate the Help Menu 

You can translate the SAP menu items into different local languages. The Help menu will then appear in the language that the user specified while logging in to the SAP GUI.


Table of Contents