User Console Design Guide › Custom Help › How Help Determines Which Link To Use

Previous Topic: Custom Help Expressions

Next Topic: How to Customize the Help

How Help Determines Which Link To Use

When a user clicks on a help link, CA Identity Manager performs checks to determine which help URL to use. These checks are made for the most specific case and then become more general. The bundle with the best match to the user's locale will be used.

The order of checks for a help link are as follows:

  1. [TaskTag].[PageTag]
  2. [TaskTag].@[PageDefinitionTag]
  3. *.[PageTag]
  4. *.@[PageDefinitionTag]
  5. [TaskTag].*
  6. *.*

Example:

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

This matches anything without a more specific match and includes active task and page tags in the generated help link.

Example:

ModifyUser.Profile=/iam/im/userprofile.html

This matches the Profile tab on the Modify User task and directs the user to the relative URL /iam/im/userprofile.html

Example:

*.@Profile=/iam/im/profile.html

This matches all tabs derived from the Profile tab definition without a more specific match and directs the users to the relative URL /iam/im/profile.html.