Home Kingston Platform User Interface Now Platform User Interface User interface configuration Context-sensitive help

Context-sensitive help

By default, the help link available in the product opens the welcome page of the help system, allowing you to enter search criteria for the information you want to find. With context-sensitive help, you can set a base URL for an external help system. The context-sensitive system properties define the base URLs for the default and custom help systems.

The ServiceNow system provides several preconfigured help contexts connected to this link that display the exact information you need for the current list, form, or record. You can define your own help topics and configure them to appear when you click the help icon in a ServiceNow record.

Users click the help icon to open the default help pages provided in the base system. For any page that does not have context-sensitive help defined, the instance displays the help system welcome page. Users can use the search feature or the index to find the correct help topic. The location of the help icon depends on the user interface version you are using.

UI15

Click the gear icon in the banner frame to open the menu containing the help icon. The appearance of the menu and icons might be different, depending on the UI scheme you have configured for your instance.

UI16

Click the help icon in the right corner of the header bar and select Search Product Documentation from the menu.

Alternatively, administrators can create custom context-sensitive help to suit the needs of their organizations. Create a help context that links the help icon to a topic describing a list, form, or specific record. You may initially want to set a base URL to direct to a help system other than the default ServiceNow help system.

Set base URLs

To create numerous help contexts that direct to a single server other than the ServiceNow help system, enter the base URL in the help.base.default property.

Figure 3. Base URL for custom help contexts

On the Help Context form, when the ServiceNow Product Documentation check box is cleared and you enter a value in the URL or page name field that does not contain the string ://, that value is appended to the base URL defined by help.base.default property.

Note: When the ServiceNow Product Documentation check box is cleared and the URL or page name field contains an absolute URL (distinguished by the string :// in the value), the value in the help.base.default property is ignored. This allows you to create help contexts that link to several different servers.