Create custom overview help

You can edit existing overview help pages to display your own custom panels to selected users.

Before you begin

Role required: admin

Procedure

  1. Navigate to System UI > Overview Help and edit the help page for your version.
  2. Modify the Overview Help Page form using the fields in the table.
    Table 1. Overview help page fields
    Field Description
    Title Unique title of this page.
    Subtitle General introduction for the subject of this page. This content appears as the description of the first panel that users see.
    Application Scope of this help page. All overview help pages are created in the global scope, so that they are visible from anywhere in the system. This field is read-only.
  3. Save the page.
    Figure 1. Overview Help Page form
  4. Click New in the Overview Help Panel related list and complete the form using the fields in the table.
    Figure 2. Overview Help Panel form
    Overview Help Panel form
  5. Click Submit.
    Table 2. Overview help panel fields
    Field Description
    Title Unique name for this panel. This name is the title of the panel shown to users.
    Page Names the overview page to which this panel is connected.
    Order Controls the sequence of the panels in the page. When using icon buttons, the button for the lowest order number appears on the left, and the button for the highest order number appears on the right. When icon buttons are disabled, the lowest order number panel begins the scrolling sequence.
    Roles Names all the user roles that are entitled to see this panel.
    Condition Defines the conditions under which this panel is viewable. For example, you can configure this panel to display only when a specific plugin is activated.
    Image Background image to use when this panel is displayed. Supported image formats are:
    • .jpg
    • .png
    • .bmp
    • .gif
    • .jpeg
    • .ico
    • .svg
    Icon Icon used as the access button for this panel from the page. This field is read-only. You cannot specify an icon for your custom panels.
    Is title Controls the display of the title on the initial slide. The field is not used for panels.
    Show title Controls the display of the title on the initial slide. This field is read-only and is not available for panels.
    Text Text describing what is shown in the image for this panel. This content appears below the panel title.