Redirecting help content

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

We must have read and write access to the customizable files and the directories where they are maintained. See Location of Identity Service Center customizable files and Customization of Identity Service Center files for details of where these files are located. Contact the system administrator if we do not have the necessary permissions.

Use the following sections to work with the configuration files or the configuration properties from the IBM Security Identity Manager virtual appliance console:

• To go to a custom file and edit, download, upload, or search it, see Manage custom files.

• To go to a property file and edit, upload, or search it see Manage the server properties.

Editing the help content that is shipped with the Identity Service Center user interface is not supported. But we can redirect help requests to our own website to deliver custom help content in line with your corporate appearance.

The UIHelp.properties file specifies properties that control the redirection of help file requests. The following table shows the property and property description for Identity Service Center help.

Property	Description
helpBaseUrl	Base URL to which to send help requests. A blank or null value indicates that help goes to the default URL for the help files in the Identity Service Center.
helpLocales	Restricts the locales for which help is supported. For example, helpLocales=en,fr restricts help support to English and French regardless of the number of available locales. If the attribute is not specified or null, the supported help locales are the same as the supported locales for the Identity Service Center user interface. These locales are specified by the isim.ui.supportedLocales property in the UIconfig.properties file.
Help Id mappings: helpId = relativeHelppageURL	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, if your custom config/UIHelp.properties file contains:

helpBaseUrl=http://myserver:80/helpfiles
login_help_url=ui/ref_ui_login.html

Then for a user who selects the English (en) locale, the request for the Login help page is redirected to http://myserver:80/helpfiles/en/ui/ref_ui_login.html.

1. Edit the config/UIHelp.properties file. See Manage the server properties.

2. Change the helpBaseUrl property in the file.
3. Update helpId mappings to use the relative URLs for your server.

4. Optional: To restrict the list of supported help locales, uncomment the helpLocales property. Modify it to specify the list of locales for which help is supported in the environment.
5. Add pages to your server for the appropriate locales.

The help requests are now redirected to your customized help files.

In a managed-cluster environment, we 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. Log in to the Identity Service Center. Start the Identity Service Center in a browser to verify the customized file is being used.

Parent topic: Identity Service Center user interface customization