More about Guided Tour rules

Starting and continuing a tour

You configure any action control with an API script to start or continue a guided tour.

Do the following:

1. Open the Actions tab on the control cell properties panel.
2. Click the Create an action set button.
3. Click Add an event and select the event.
4. Click Add an action.
5. In the menu, click all actions and select Run script.
6. In the Function Name field enter one of the following (enclosed in quotes ""):
   • "pega.d.automation.support.startTour"— Displays the first tour stop defined on the Definition tab. When the user selects the control, the tour restarts at the initial stop.
   • "pega.d.automation.support.continueTour" — Starts the tour at the initial stop unless the user exited the tour at an intermediate stop. In this case, the function continues the tour where the user exited. As a best practice, use this function to start a tour.
7. In the Parameters area, specify the guided tour you want to run. Enter the following parameter values:
   • Identifier (name) key value
   • Apply to class
8. Save the control.

Tour stop navigation

The tour stop window contains the following navigation buttons based upon where it is displayed in the tour sequence:

• Next — First tour stop
• Next and Previous— Any intermediate tour stop
• Previous and Finish—Last tour stop

A window remains open until the user clicks either:

• A navigation button.
• The X icon to exit the tour.

Automatically starting a tour

You can automatically start a guided tour by including and configuring the pxGuidedTourAutoStart control in a section. To add the control:

1. Click in the cell where you would like to include the control and then click the gear to view the cell property panel.
2. Click change.
3. Select other.
4. In the Select a control field, select pxGuidedTourAutoStart.
5. Fill out the following fields on the Parameters tab:
   • TourClass - the class in which the tour is defined
   • TourName - the name of the tour to run
   • AutoLaunchAlways - set to true to start the tour every time the section that includes the control is displayed, set to false (default) to start the tour the first time the section is displayed.
6. Submit the cell properties configuration and save the section.

Users must have Data-Preference-Operator write permissions or the tour will not start. This is used to record a user's tour history.

Related Information

Open topic with navigation