Create an onboarding modal

Create your own onboarding modals 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.

      Field	Description
      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 the 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.

   2. On the Help Guidance Steps related list, select New.

   3. On the form, fill in the fields.

4.  Select **Submit**.

1. To create help contents for your help guidance steps, do the following:

   1. Select your help guidance step in the related list.

   2. On the Help Contents related list, select New.

   3. Note: Form fields are different for each type of guidance. Refer to the correct form for your guidance.

      On the text form, fill in the fields.

      Field	Description
      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.

   5. On the video form, fill in the fields.

6.  Click **Submit**.

7.  On the image form, fill in the fields.

    |Field|Description|
    |-----|-----------|
    |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.|
    |Image|The image selected to display in your guidance.|
    |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.|
    |Provide Image Link|The image link is displayed in the guidance.|
    |Alternate Text|Alternate text that displays in the modal of the help content in the UI.|

8.  Click **Submit**.

9.  On the question form, fill in the fields.

    |Field|Description|
    |-----|-----------|
    |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.|

10. Select **Submit**.

11. Select **New** in the Help Question related field.

12. Select **New** in the Help Answers related field to create answers.

    |Field|Description|
    |-----|-----------|
    |Label|The label for the answer.|
    |Value|The value for the answer.|
    |Order|The order of the answer.|
    |Application|Application scope for the guidance.|
    |Question|The question the answer is created for.|

13. Select **Submit**.

1. Create any additional guidance that you want to build your onboarding experience.

2. When you're done building your onboarding guidance, confirm that the status of your guidance is set to Published on the Guidance form.

3. On the Guidance form, select Update.

Parent Topic:Configure