Online Help Links in CRM UI

[Former Member]

The information below explains how to set up online documentation links in the CRM UI, how to maintain documenation links, and how to debug a system where the links do not work as expected.

IMG Configuration

Standard configuration of online help must be completed:

 

An entry must exist for Platform = ITS and Area = XML_DOCU (IWBHELP also appears to work)

• Either DynamicHelp or PlainHtmlHttp can be used. PlainHtmlFile may be supported; most likely HtmlHelpFile is not.

Main Help Center Link

The standard "Help Center" link will automatically appear when the above configuration is completed:


Knowledge warehouse object IDs are retrieved from table IWREFERENC with the following selection:

• PROGRAMM = CL_BSP_WD_HELP_UTIL===========CP


• Industry = BBPCRM

Work Center Links

• Note: this is usually reserved for customers' own documentation. We do not deliver additional help context entries ourselves.

If additional help IDs are maintained for Web UI components, additional "?" icons will appear in the toolbar:

 

For the Incident Management work center, for example, the following must be maintained in table IWREFERENC:

• PROGRAMM = CL_WCC_AI_I_SUPPORT_IMPL======CP


• Industry = BBPCRM


• Industry = BBPCRM is used as a default; an extension may be set in Business Role configuration.

IWREFERENC IDs are normally maintained by documentation coordinators.

Business Role Configuration

The "spec_text" entry used for the extension selection in IWREFERENC can be set in the Business Role configuration:

 

Example of an overridden help context for the main 'Help Center' link:

 

(Note that the first "Program Name" entry must be left blank.)

The corresponding entry in the Business Role:

 

(The 'SpecHelpFallbck' checkbox allows the CRM UI to check the standard documentation if no help link is found in IWREFERENC for the overriden context.)

User Parameter to Display UI Classes

When the user sets parameter BSP_WD_SHOW_HELPID = X, the CRM UI will display the class names. Documentation developers can then easily see which entries they have to set in IWREFERENC.