Help Id

A help Id specifies the HTML file name that contains the help topics for a screen in the client. To reference it, you enter the help Id name in the Help Identifier property of a view or screen. If the user chooses the Help menu and then clicks Contents, then Siebel CRM calls the GotoPage method of the Siebel Web Engine (SWE). This method uses SWE code to display the correct help topic in a separate browser window. For more information about help, see Siebel Object Interfaces Reference.

This object type occurs in the following location in the object hierarchy:

• Siebel Objects > Help Id

The following table describes properties that Siebel CRM uses with a help Id.

Property	Description
HTML Help URL (O)	Specifies the URL for HTML help. As of Siebel CRM 21.2 Update, the URL is relative to the SIEBEL_AI_ROOT/applicationcontainer_external/siebelwebroot directory on the Siebel Application Interface installation. This URL includes the HTML file that includes help content. For example, you can enter the following value in the HTML Help URL property: help/siebaccounts.htm
Name (R)	Specifies the string that identifies the help topic. This string must contain no special characters except for the underscore (_) symbol. It uses the following format: ID_type_object_name where: type is VIEW or SCREEN. You must use all upper case letters. object_name identifies the view or screen For example, you can use the following value for the Accounts screen help: ID_SCREEN_ACCOUNTS
Type (O)	Specifies the object type that can use this help topic. For example: View
Value (O)	Not used.