Embedded help provides targeted help content to a user in a UI page, based on their role. Some embedded help content comes with the base instance. Your organization can add or replace embedded help content.

Overview

Note: Required: Embedded help is only available in Core UI. For configurable workspaces, use Help Center.

The Embedded Help plugin (com.glide.embedded_help) is active by default for all new and upgraded instances. Embedded help content appears in the right sidebar when the user clicks the help icon. If embedded help exists for the current UI page, the help icon has an indicator (Embedded help indicator on help icon).

Figure 1. Embedded help for the Catalog Task page
Catalog task page with embedded help

If there is no embedded help for a list or form, the sidebar displays links to the User Guide and the documentation site search. Click Search Documentation to search for documentation about that feature.

Users with the embedded_help_admin or admin role can add help to the page. They can also edit custom content that appears for a page. The following image shows what the admin sees when there is no help article, and how to open an existing article. If you want to edit base system help content, follow the steps in Add custom Embedded Help from a copy.

Figure 2. Embedded help administrator features in the help panel
Add content or edit existing content

Embedded help is displayed based on the user's role. If the content has no associated role, all users see it. If the role is different than admin, users with the specified role and above see the content. For example, content with the itil role appears for itil, itil_admin, and admin.

Get started

Troubleshoot and get help