Guided Tour Builder

General Configuration page

Specify the product family and module. 

Optionally, select the Auto Notify checkbox to automatically notify users about the guided tours existence when they navigate to the feature or application the guided tour is configured on. 

Guided Tour Steps page

Create the tour steps and title. Each step highlights a single component of the application, such as a field, button, page, or row. The types of features you can highlight depends on whether you are configuring a platform feature or a conventional application. 

Once the application element has been selected, select the Guided Tour Step Content field action to create or select the content for that step. Create the guided tour menu title by opening the Guided Tour Title Content field action. Learn more in Guided tour configuration.

Once a guided tour has been configured, users can access it from the Guided Tours menu on the main menu bar. 

Guided Tour Content Builder

To create your content and titles, you must:

• Create an internal topic name. This is not visible or used in the tour itself. Copy the internal topic name for use in the authored content. 
• Create a topic title:
  • For title content, this is the label which is shown for the tour in the Guided Tour menu. 
  • For step content, this is the name of the component being highlighted in that step. 
• Select Concept in the topic type field, and change the classification to Available. 

In the Authored Content section, enter the internal topic name for existing content you want to use, or select the Configure Content, then:

• Paste the internal topic name in the Authored Content Name field. 
• In the Short Description section:
  • For title content, this is a short description of your guided tour. 
  • For step content, this is the information you want visible in the dialog box for that step. 

Guided Tour best practices

Steps overview

Guided Tour is a feature that helps orient and navigate users through an application's different features. To ensure that guided tours across the platform are consistent, you should review the following guidelines:

• Try to minimize the number of steps in each tour, if possible. Use 3-5 steps for simple applications or features, and 6-7 steps for more complex processes. 
• Don't create a step for every part of the application. Highlight key features, as well as any areas that are unintuitive and may require additional explanation. 
• Keep the written content succinct. If it requires more than a paragraph or two of explanation, it probably belongs in Nextworld Help or the field level help. 

Steps content

Review the following best practices for writing guided tour step content:

• If the guided tour highlights an application or complex feature, use the name format of <Application Name> Overview. For example, Application Builder Overview. 
• If the guided tour highlights a simple feature, use the name format of <Feature>. For example, Ed or Main Menu bar. 
• If the step highlights a feature with a tooltip or feature name, ensure you use the name for the step's title. For example, the tooltip for the Sidebar menu is "Toggle sidebar menu" and the guided tour step is called "Sidebar menu."
• If the step highlights a larger component of the application, refer to the navigation section of Nextworld Help to determine if there is a name for the region you are highlighting. For example, the Viewer panel in the Application Builder, or the Report Data and Row Detail tables in the Interactive Report Builder. 
• Use active voice.
• Avoid acronyms or slang. Consider how your content translates. 
• If your step highlights an action or button, refer to them by their appropriate name and location. For example, you could say, "Select the Save and Stay form action..." or, "Select the Execute row action..."
• Use the inline style Button or Field Name for any buttons or field names mentioned in your step. 

Example steps

1. Navigation Menu

Open the Navigation Menu to access applications and reports. You can type in the search bar, or navigate through the pages and sections of the menu.

2. Fields panel

Use the Fields panel to view, manage, or configure the fields associated with your application. Drag and drop fields from the Fields panel into the Viewer panel during configuration. 

Guided tour configuration

Create a new record and select the type of tour you are configuring. You can create a guided tour for an application, or for a new platform feature. 

For guided tours over applications, navigate to the Guided Tour Steps page and enter the application name and application setting. Then, in the Guided Tour Steps subtable, you must:

• Add a row for each step you want included in the tour. Each step highlights one component of the application and provides a brief description of its use. 
• Select the form where the component is located, and what type of element it is. If it is a field, provide the data item name. 
• Enter the application name and setting for each step. This enables you to highlight components of inline applications within your tour. 

The title of your guided tour and the content for each step must be configured within a mini app. To create your guided tour title, select the Guided Tour Title Content field action underneath the Guided Tour Title field. To create your guided tour step content, select the Guided Tour Step Content field action in the Guided Tour Steps subtable, then:

• Create an internal topic name. This is not visible or used in the tour itself. Copy the internal topic name for use in the authored content. 
• Create a topic title:
  • For title content, this is the label which is shown for the tour in the Guided Tour menu. 
  • For step content, this is the name of the component being highlighted in that step. 
• Select Concept in the topic type field, and change the classification to Available. 

In the Authored Content section, enter the internal topic name for existing content you want to use, or select the Configure Content, then:

• Paste the internal topic name in the Authored Content Name field. 
• In the Short Description section:
  • For title content, this is a short description of your guided tour. 
  • For step content, this is the information you want visible in the dialog box for that step.