Edit a guided tour

You can modify the settings of a guided tour, such as the roles that access the tour. You can also edit, add, delete, and reorganize the guided tour steps, and apply additional formatting to the instructional text.

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

Use the Guided Tour Designer (GTD) to add, delete, and reorganize guided tour steps. Use the Guided Tour form only to perform tasks you cannot do easily from the GTD.

Procedure

  1. Navigate to Embedded Help > Guided Tour Designer > Guided Tours, and open the tour to edit.
  2. In the Guided Tour form, take any of the following actions.
    • Edit the name.
    • Enter a different page name in the Context field. For example, if the form page is listed and you want the user to start on the list view to enter a new record.
    • Enter or edit the description.
    • Clear the Active check box to disable the guided tour. Consider inactivating the tour until you are finished editing it. Select the check box to enable the tour when it is ready.
  3. To apply text formatting in the step instructions, click the step number in the Guided Tour Steps related list and complete the following steps.
    1. Scroll to the Content HTML formatter.
    2. Edit the content and apply formatting as appropriate.
      Note: Do not add images or video to the text. These media types do not render in the callout text box.
    3. Click Update.
  4. To work with the tour steps, click Edit with Designer in the form header.
    The target UI page opens in the GTD in a new tab or window.
  5. Perform any of the following steps.
    ToDo this
    Edit the text or trigger in a step Navigate to the UI page the step is in and click the step in the list on the right. For example, if the tour starts in the list view but you want to edit a step in the form, open the form. The steps in the current view are numbered inside an orange circle.

    Complete your changes and click Save.

    Place the callout on a different page element
    1. Click the icon to delete the step with the incorrect placement.
    2. Create a step on the correct page element.
    3. Drag the step into the correct position in the order of steps.
    Rearrange steps Drag the steps to the desired order.
    Test the tour Click Play below the list of steps. The page opens in a new list or tab and you can test each step. Note any steps that need corrections.
    Exit the GTD and return to the Guided Tour form Click Exit below the list of steps. The tab or window closes.