Create a new help context
- UpdatedJan 30, 2025
- 3 minutes to read
- Yokohama
- Navigation and UI
You can create new help contexts to supplement or replace the default help contexts. For example, if your organization has heavily customized a form, you might create a new help context for that form. The customized help context could link to more relevant information, such as a company knowledge base article.
Before you begin
Role required: none
Procedure
- Navigate to All > System UI > Help Contexts.
- Click New.
-
Complete the Help Context form from the fields in the table.
Table 1. Help context form Field Description Type Select Form, List, or Record.
If you select Record, the Table name field is replaced by the Document field.
Table name Select the table for which the help context is being defined.
If the Type is Record, this field is replaced by the Document field.
Note: The list shows only tables and database views that are in the same scope as the help context.Document Click the reference lookup icon (
) to open the document selection dialog box (pictured). Select the table and document (record) for this help context.
This field is only visible if you have selected Record as the Type.
Language Select the language of the help page to which you are linking. The choices available depend on which I18n Translation plugins you have activated. For more information, see Activate a language.
This field allows you to create multiple help contexts for the same form, list, or record, each directing to a help page in a different language. For example, you might have two help contexts for Form X: one for English and the other for Spanish. If a user whose language is set to Spanish clicks the help icon while viewing Form X, the help page defined in the Spanish help context opens.
Active Select this check box to have the system use the help context. This check box is selected by default for new help contexts. ServiceNow Product Documentation Indicates if this help was created by a customer or was provided by ServiceNow. Clear this check box to create custom help for your organization. Do not attempt to modify existing help topics provided by ServiceNow for your own use. The system is configured to use your custom records rather than the default help contexts, even when they are created on the same table.
URL or page name Identifies the topic to display when a user clicks the help icon while viewing a form, list, or record. You can enter the complete URL of the help page or just the target file name if you set a base URL in the help.base.default system property.
Note: If you reconfigure the fields on the form, you see the available fields Plugin ID and System Property Base URL. Do not use these fields. They are for internal use only. - Click Submit.
Related Content
- Help context types and prioritization
You can create a help context with the type Form, List, or Record, and link it to a particular table in your ServiceNow instance. If you have multiple help contexts, prioritization determines which help contexts apply to what a user views.