Redirecting help content

We can redirect help requests to our own website to deliver custom help content.

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 our 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. See Manage the server properties. The following table shows the property and property description for self-service help.

Property Description
helpBaseUrl 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 + relativeHelppageUR. 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...

  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 SelfServiceHelp.properties.

  3. Select a property name. For example, helpBaseUrl.

  4. Click Edit to open the Update property window or add the property if it does not exist.
  5. Update helpId or relative page URL mappings to use the relative URLs for your server.
  6. Add pages to your server for the appropriate locales.
  7. Restart ISIM application to make the changes effective.

In a managed-cluster environment, you must wait until after the configuration is synchronized to the application servers in the cluster. For information about synchronizing, see Synchronizing a member node with a primary node.

Parent topic: Self-service user interface customization