Enabling Help For SAP CRM 2007 – uPerform On-Premise Manuals

To implement and use context-sensitive help for SAP CRM with the application, you will perform four procedures:

Create a template.
Configure SAP CRM to send help requests to the application's website.
Record an SAP CRM document with the application and republish the website to make the document available for context-sensitive help.
Request context-sensitive help from SAP CRM.

Creating a Template for Use with SAP CRM 2007

Context-sensitive help for SAP CRM is driven by context identifiers. Each screen in SAP CRM has a unique context identifier and these are gathered collectively for a procedure and automatically inserted into the transaction code property of a document. Context identifiers are used to call context-specific help on the screen in which the end user is working.

Transaction code is a term and property used to identify a process, and it is used in two separate instances:

Transaction code property: The Server matches this document property to the associated SAP CRM screen when a call for help is made from SAP CRM.
Transaction code block: In a document, this block displays the transaction code pertaining to the document created.

Create a template.

NOTE:

A project administrator typically creates and customizes templates. For more information, refer to Using Author Templates.
Select the Blocks tab.
Select Purpose.
Turn off the display of the Transaction Code block in a document.
Select the Properties tab.
Enable the Transaction Code property.
Select File > Save.
Click the Publications tab.
Select Website.
Select Transaction Code(s) from the Build from Property field.
Select Comma(,) from the Multiple Values Separated By field.
Select File > Save.

Publishing the Website

As part of website publishing, you will also generate quick launch pages to enable communication between the application website and SAP CRM. For information on publishing the website, refer to Publishing the Website.

Configuring SAP CRM to Send a Help Request to the Website

The SAP system administrator must configure SAP CRM to send help requests to the website. This configuration is specified by adding variants to the Plain HtmlHttp tab of the SR13 transaction code.

Log into SAP CRM via the SAP GUI.
Enter the transaction code SR13.
On the Dynamic Help tab, delete any existing entries.
Click the Save button.
Select the PlainHtmlHttp tab.

Complete the following fields:

Field	Description
Variant	Enter a variant name. Example: YourCompanyHelp
Platform	Enter a platform. Example: ITS.
Area	Enter an area. Example: XML_DocU
Server Name	Enter the webserver name. Example: MySite
Path	On the web server, locate the redirect.html. This file is found in http://[webservername]/[website name]/website/xml/assets/redirect.html. Copy the URL beginning with [website name], and paste into the Path field. Example: [website name]/website/xml/assets/redirect.html Append ?csh= to the end of the path name Example: [website name]/website/xml/assets/redirect.html?csh= NOTE: This path name cannot exceed 64 characters.
Language	Enter the language key. Example: For German, enter DE.
Default	Select this checkbox if the language specified is the default help language.

Click the Save button.

Recording an SAP CRM Document

Log into SAP CRM.

Perform one of the following options:

If You Want To	Then
Record and edit the entire document	Use the template created in Creating a Template for Use with SAP CRM 2007, to record and edit the document using the Editor and the procedures described in Creating Context-Sensitive Help. Go to Step 3.
Insert steps into a previously recorded document	Update the template associated with the document. Open the document. Select the Simulation tab. Select Insert > Steps > From New Recording. Record the steps in SAP CRM using the Editor and the procedures described in Recording Procedural Content. Go to Step 3.

NOTE:

The recorder does not automatically gather transaction codes for screens containing an embedded SAP HTML GUI; however, you can obtain the transaction codes in this environment if you have integrated ANCILE Help Launchpad with the SAP system you are displaying within the embedded HTML GUI.

In the above scenario, select Help > [Custom] Help within the transaction displayed in the HTML GUI. Review the web address field displayed in the new browser window, and identify the transaction code for this transaction. Copy the code and paste it into the Transaction Code property of the document you are currently recording.

In the application, select File > Properties.
Select Properties.
Ensure the context identifier(s) have been inserted into the Transaction Code value field.
Click OK.
Save the document.
Add the document to the website using the procedures described in Building a Website.
Publish the document using the procedures described in Publishing Content.
Republish the website using the procedures described in the Building a Website.

NOTE:

When the website is republished, the document will be available for the end user via the help icon in SAP CRM 2007.

Requesting Help from SAP CRM 2007

Log into SAP CRM as an end user.
Navigate to the desired screen.
Click the help icon (?) for the screen.

NOTE:

The website searches for available help for the screen based on the context identifier specified in the document.

SAP CRM 2007 will open a new browser window displaying the following potential help options:

If a single help document has been created, the document displays in the new browser window.
If more than one help document has been created, a list of documents displays in the browser window.
If no help document has been created, an HTTP 404 (Page Not Found) error displays in the new browser window.