Thank you for your feedback.
Form temporarily unavailable. Please try again or contact to submit your comments.

Add a guided tour

Log in to subscribe to topics and get notified when content changes.

Add a guided tour

After you outline the guided tour, use the Guided Tour designer to enter the steps using callouts and triggers.

Before you begin

Role required: sn_tourbuilder.tour_admin or admin. If the user with embedded_help_admin is not an admin, the user needs the role that provides access to the page where the tour is being added or modified.

About this task

Guided tours require careful planning before entering the tour into the instance. You can create an outline and include any assumptions to guide you when you create the guided tour. List each step, callout, and trigger.

Note: The Guided Tour Designer is only available in UI16. The designer is not compatible with UI15. For more information, see Activate UI16.


  1. Navigate to Embedded Help > Guided Tour Designer > Create Tour.
  2. Complete the form.
    Field Description
    Tour Name Enter a name for the tour that describes what the user accomplishes by completing it.
    Application Page Name Enter the application page the tour starts on. The application page is listed in the URL displayed in the address bar of the browser. The following image is an example of the Delegates list view page. Do not include the .do extension.

    Delegates list view page name

    You can begin typing the UI page name to display a list of matching pages, and then select it from the list.

    Roles this tour is for Select the roles who can access this guided tour and move them to the Selected Roles list.
  3. Click Create.
    The Guided Tour Designer opens in a new tab or window.

    Guided tour designer

  4. Complete the following steps to add a tour step with a callout and trigger.
    1. Drag a callout shape from the upper right and drop it on top of the UI element.
      The element is highlighted when the callout is positioned correctly.

    2. In the callout that appears, enter the instructions and select the trigger. Only triggers that you can use for the selected element appear in the list.

    3. (Optional) To apply text formatting, such as bold or italic, add html tags around the text to format.
      For example, Click <b>New</b> to set up a delegate....
    4. Click Save.
  5. Continue adding steps until you have completed the tour.
    The tour is saved as you save each step.
  6. To test the steps, click Play below the steps at any time.
    The page opens in a new tab or window, and the first callout appears. When you are at the last callout, the Next button displays the end of the tour. It is a good practice to have a closing statement in a callout to reinforce what the user accomplished, and to trigger it on the Next button.

What to do next

As you test the guided tour, note the steps that are not working properly or that need correction. Edit the tour or the steps as described in Edit a guided tour.

You can review tour failures from the Guided Tours Overview page. These failures can provide insights into which users experience problems with the tour, on which step the tour failed, and what the error message was. You can then use this information to troubleshoot and resolve issues as needed