Create your own onboarding modal to introduce your users to a new experience or application.

Before you begin

Role required: admin

Procedure

  1. Navigate to All > Adoption Services > Create Guidance.
  2. To create your onboarding modal, do the following:
    1. On the form, fill in the fields.
      Table 1. Guidance form
      FieldDescription
      Order Order that the guidance displays. The lowest number displays first and the next chronological number follows.
      Name Name of the onboarding experience.
      Type Type of guidance that appears in the UI. Select Modal.
      Roles Roles for this guidance.
      Application Application for the guidance.
      Status Status of the guidance.
      Active Select to enable or disable the guidance.
    2. Select Submit.
  3. To launch an Onboarding modal once created, do the following:
    1. Create a client script in UIB.
    2. Under code snippet enter api.emit('SN_HELP#GUIDANCE_START_REQUESTED',{guidanceId:"ID"});
    3. Replace the ID with the sys_ID of the modal guidance to be opened.
    4. Save the page.
    5. Select Body in the left panel of the UIB page.
    6. In the right panel, select the Events tab.
    7. Under Dispatched Events select Add.
    8. In the event name, add SN_HELP#GUIDANCE_START_REQUESTED and give the label with a name.
    9. Select Save.
  4. To create embedded help guidance steps, do the following:
    1. Select your guidance from the Guidances list.
      test2 is displayed in Guidances list.
    2. On the Help Guidance Steps related list, select New.
      test2 Help Guidance Step list is displayed.
    3. On the form, fill in the fields.
      Table 2. Help Guidance Step form
      FieldDescription
      Name Name of your guidance.
      Layout Selected layout of the guidance.
      Order Order that the guidance displays. The lowest number displays first and the next chronological number follows.
      Action Label Button labels that enable the user to navigate the guidance modal.
      Application Application scope for the guidance. This guidance applies to the Global scope.
      Guidance The guidance that this Help Guidance Step applies to.
    4. Select Submit.
  5. To create help contents for your help guidance steps, do the following:
    1. Select your help guidance step in the related list.
      test2 Help Guidance Step list is displayed.
    2. On the Help Contents related list, select New.
      help contents related list is displayed.
    3. On the form, fill in the fields.
      Table 3. Help Content form
      FieldDescription
      Title Title of the help content.
      Subtitle Subtitle that's displayed in the modal of the help content in the UI.
      Type Type of guidance that's selected.
      Application Application scope for the guidance.
      Guidance Step Help Guidance Step that this Help Content is associated with. For example, Intro/welcome, All menu, and History.
      Default Help content that is the default for the guidance step.
      Footer Footer that's displayed in the modal of the help content in the UI.
      Provide Custom HTML Custom HTML for your help content.
      Text Text that displays in the modal of the help content in the UI.
    4. Click Submit.
  6. Create any additional guidance that you want to build your onboarding experience.
  7. When you're done building your onboarding guidance, ensure that the status of your guidance is set to Published on the Guidance form.
  8. On the Guidance form, select Update.