Redirecting help content

We can redirect help requests to our own website to deliver custom help content for the administrative console user interface.

Editing the ready to use help content that is shipped with the administrative console user interface is not supported. But it is possible to redirect help requests to our own website to deliver custom help content.

The helpmappings.properties file specifies the base URL that help requests are sent to. The following table shows the property and property description for help.

Property Description
url.contexthelp Base URL to send help requests to. A blank value indicates that help goes to the default URL for the administrative console 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 url.contexthelp + locale + relativeHelppageUR. For example:

url.contexthelp=http://myserver:80
locale = en_US
Locale is determined by matching the current logged in user's browser settings with the currently installed IBM Security Identity Manager language packs. 
loginID/relativeURL = login_help_url=ui/ui_eui_login.html

Therefore, the final URL is http://myserver:80/en_US/ui/ui_eui_login.html.

To redirect help...

  1. From the top level of the Appliance Dashboard, click Configure > Advanced Configuration > Update Property.

  2. From the All Files tab, select a property file helpmappings.properties.

  3. Change the url.contexthelp property in the helpmappings.properties file. Customers must not change the helpIDs. They are what the ISIM user interface panels use to find the appropriate help.
  4. Update helpID mappings to use the relative URLs for your server.
  5. Add pages to your server for the appropriate locales.
  6. Restart ISIM application for these changes to take effect.

    1. From the Server Control widget, do these steps.

      1. Select Security Identity Manager server.

      2. Click Restart.
      See View the Server Control widget.

Parent topic: Administrative console user interface customization