Previous Topic: How Customized Help WorksNext Topic: How Help Determines Which Link To Use


Custom Help Format

The help link resource bundle uses a key/value pair to determine which help page to direct the user to. For custom help, tags are used for Key IDs and the custom web page URL is the value. The syntax for the help link resource bundle may be one of the following:

TaskTag.PageTag=Help URL
TaskTag.@PageDefinitionTag=Help URL

A tag is the unique identifier for a task, screen, or tab. The parameters for the key/value pair are defined as follows:

Task Tag

The active task tag.

Page Tag

The active search or tab tag.

Page Definition Tag

The active search definition or tab definition tag.

Help URL

The help URL is either an absolute URL (http://www.neteauto.com) or a relative URL that points to content on the Identity Management server (/iam/im/help/customhelp.html)

Example:

ModifyUser.Profile=/iam/im/userprofile.html
Custom Help Expressions

The following expressions have specific meaning when used in custom help resource bundles:

Expression

Meaning

*

Used to match any task tag, page tag, or page definition tag.

${task}

Used in the help URL. Replaced with the task tag of the active page.

${page}

Used in the help URL. Replaced with the page tag of the active page.

${pagedef}

Used in the help URL. Replaced with the page definition tag of the active page.

Example:

*.*=http://www.help.com/Wiki.jsp?page=${task}_${page}

The $task and $page expressions are replaced with the task tag and page tag for the current web page where the user clicked the help link. For example, if a user clicks the help link from the Profile tab of the Create Group task, the help URL would open the following help page: http://www.help.com/Wiki.jsp?page=CreateGroup_Profile