Redirecting help content

Edit online

You can redirect help requests to your own website to deliver custom help content.

Before you begin

Depending on how your system administrator customized your system, you might not have access to this task. To obtain access to this task or to have someone complete it for you, contact your system administrator.

About this task

Editing the out-of-the box help content shipped with the self-service user interface is not supported. But it is possible to redirect help requests to your own website to deliver custom help content in line with your corporate appearance.

The SelfServiceHelp.properties file specifies the base URL that help requests are sent to. These files are in the IM_HOME\data directory.

The following table shows the property and property description for self-service help.
Table 1. Self-service help properties and description
Property Description
helpBaseUrl Specifies the base URL to send help requests to. A blank value indicates that help goes to the default URL for the self-service user interface.
Help Id mappings: helpId = relative page URL The help mappings section maps IDs from specific pages to a relative URL sent to the help server.

The Help URL is the combination of the helpBaseUrl + locale + relativeHelppageURL

For example:
helpBaseUrl=http://myserver:80
locale = en_US
Locale is determined by resolving the SelfServiceScreenText.properties resource bundle for the current logged in user and with the associated locale.
loginId/relativeURL = login_help_url=ui/ui_eui_login.html
Therefore, the final URL = http://myserver:80/en_US/ui/ui_eui_login.html.

To redirect help, complete these steps:

Procedure

  1. Make a backup copy of the SelfServiceHelp.properties file in the IM_HOME\data directory.
  2. Change the helpBaseUrl property in the SelfServiceHelp.properties file.
  3. Update helpId mappings to use the relative URLs for your server.
  4. Add pages to your server for the appropriate locales.
  5. Restart the IBM Verify Identity Governance application in WebSphere® to make the changes effective.