Use qualifiers in Embedded Help

The embedded help administrator can use qualifiers to customize content for a common page in the instance.

Before you begin

Role required: embedded_help_admin

About this task

The home.do page is opened for every Homepage module and for many Dashboard modules. The specified query parameters in the URL define which homepage to open.

Imagine that your organization wants to provide specific instructions for the SLA homepage. You can write custom embedded help content and use a qualifier to accomplish that goal. Create the qualifier, and then associate it with custom embedded help content that you write.

Procedure

1. To get the information for the qualifier, open the module in a new browser window and copy the query parameter.
   Notice that the query parameter uses underscores between words instead of hyphens or dashes.

   

   You can also select the query parameter from the Arguments field on the module link type. To see the module link type, click the pencil icon beside the module in the application navigator, and then click the Link Type tab.

2. Navigate to Embedded Help > Help Qualifiers, and then click New.
3. Complete the form.

   Table 1. Embedded help qualifier form

   Field	Description
   Path	Enter the page to display the embedded help content. Do not include .do. For example, for the SLA homepage, enter home.
   Query params	Enter the query parameters or the link argument using the format id=query_parameters. Warning: If the query parameter contains more than one word, use underscores between words instead of hyphens or dashes. If you use hyphens or dashes, the system uses only the first word in the parameter and ignores the rest.
   Fragment	Enter the #<string> at the end of the URL. This is rarely found in the URL of a page in the instance. If you want custom help for a page that ends with #<string>, place it into this field. Note: The proven practice is to include at least a query parameter. If you do not, the custom help appears for every home.do page. You can use either the query parameter, the fragment, or both.
   Qualifier	Enter the qualifier to use, for example sla_homepage. Record the qualifier to use in the embedded help content record. Warning: If the query parameter contains more than one word, use underscores between words instead of hyphens or dashes. If you use hyphens or dashes, the system uses only the first word in the parameter and ignores the rest.

4. Click Submit.
5. Follow the steps in Add custom Embedded Help content to create the content, and include the following information.
   • Name and Page: The page you created the qualifier for, for example, home.
   • Qualifier: The qualifier you entered, for example sla_homepage.

   Note:

   You can also copy an existing embedded help topic and enter the qualifier in the copied record.
6. Test the qualifier by opening the page you added the content for, and then opening the help panel.
   Note:

   If you added a role to the embedded help content, ensure that you are logged in as a user with the role, or impersonate a user with that role.