You can create a new custom embedded help topic, for example, if you have a custom application and you want to provide help to users.

Before you begin

Role required: embedded_help_admin or admin

About this task

When you write content for your users, keep the following limitations in mind.
  • You cannot include images in embedded help content.
  • To embed video, you must code the video information in the source code <<>> view. Video content from YouTube and Vimeo are supported.
  • To add a related information link, you must use a full URL, not a relative URL.
  • Best practice is not to use the highlight text tool, as the color may make text unreadable depending on the theme the user has selected.
  • Any changes you make to embedded help are not automatically deployed to another instance.
  • Changes to the embedded help table are not captured in update sets, update_sync=false is set intentionally.
Note: Embedded help records are also used to create content for the Help Center within a configurable workspace. For more information, see Create Help Center content for configurable workspaces.

Procedure

  1. Navigate to All > Embedded Help > Help Content.
  2. Click New.
  3. Complete the form.
    Field Description
    Name Enter the embedded help topic name. A typical name is the title of the page to which it applies.
    Page Enter the UI page this content provides help for, without the .do file extension.

    Page name in the URL

    Note: If you are using the embedded help record to display in the Help Center, as described in Create Help Center content for configurable workspaces, enter the same value in the Name and Page fields, replacing spaces with underscores in the Page field.
    Modifier Select the modifier, typically Normal.
    • Normal content appears for any user with the appropriate role who navigates to the page.
    • Setup content appears when the page is accessed from a link in Guided Setup.
    Role Select the role that the topic is written for.

    All roles that contain the role also see the content, unless another topic targeted to their role exists for the same page. For more information, see Embedded Help roles
    Active Select the check box to make this content appear. Clear the check box to prevent the content from being available, for example, to have someone review it before it is accessed on the UI page.
    Product Enterprise is the default, and should not be changed.
    Qualifier The qualifier that provides custom embedded help for a common UI page.

    For example, the home.do page is opened for every Homepage module and for many Dashboard modules. Create the qualifier before you enter it into this embedded help record.

    Note: Dynamic IDs are supported in Embedded Help Qualifier route parameters. For example, adding $dynamic_value$ in the fragment field makes your content available for the same URL, even when the value changes. This can happen when selecting different languages for the same page.
    Version Select a version, if different from the current version of your instance. To provide content for a custom application or information relevant to your organization business process, select All.
    Order Change the default role, if needed. The order defaults based on the selected role. For more information about default order priority numbers, see Embedded Help roles.
    Domain Specify the domain this content is used for, if applicable.

    This field appears in the form if the administrator configured the form to display it.
  4. In the Content field, enter the text using the HTML formatting tools as needed.
    If you add a link, enter the full URL to the web page. A good practice is to select New window (_blank) as the Target.
    Note: Do not add images in an embedded help topic. Images are removed from the content section when the record is saved.

    To add an embedded video, see Embed video content in help topics.

  5. (Optional) To add another line below tables, videos, or related links, click the newline icon (⏎).
  6. Click Submit.