Sometimes it is annoying to add the test mode line in development and staging servers and remove it in production server. And it is easy to forget to add or remove the line. So we highly recommend that you put a check around it to detect the server and enable test mode. Example:

Normally, when a tour is run, the tour data is downloaded from the server and then displayed on the screen. This process may lead to a short delay (usually less than a second) while the tour data is downloaded. When we know that the user is likely to trigger a particular tour on a page, we can preload the tour data so that the tour can be displayed immediately. Here is an example:

The page contains a help button

When the user clicks help, a tour is triggered to walk the user through the page

If we preload the tour, the required data will be downloaded in the background immediately after the page loads

So when the user clicks the help button, the tour is displayed immediately without needing to download the data

The way to preload a tour is to add this line just after the tour.start() line in the integration:

tour.preload("<tour_id>");

Use the preloading feature only for cases which require a user interaction to run a tour. It is not needed for tours that are run automatically when a user visits a page. (Click here for more on different ways to trigger a tour)

The Tour My App activity stream shows a report of the steps completed by each user. To display this report, Tour My App automatically generates a random id for each user in the format user-xxxxxxxxx. The report will then display something like

user-2393476 has started the tour.
user-2393476 has completed step 1.
user-2393476 has completed step 2.
user-2393476 has completed step 3.
user-2393476 has completed the tour.

Sometimes (especially when the user is logged in), you might want a more readable ID, such as the username or their email address.

Tour My App allows you set a specific user reference, which will be used in the activity stream report. To enable this functionality, add the following line just before tour.start():