Support Center

How to ensure my guide starts only on a certain page?

Last Updated: Apr 11, 2017 10:43AM WEST
To properly understand how guides display and behave, we will detail two distinct concepts that relate to guides and URL’s: visibility and failed behaviors.


At a given moment in time, Helppier’s widget contains a list of guides that have been previously created. Each guide in this guide's list can be clicked by the user, which leads the guide to start playing.

While you can have all guides visible in the guides list throughout all your website’s pages (this is the default setting), you may want to only show a certain guide in the guide’s list on a certain webpage.

Example: You have created a total of 50 guides but, in your website’s “Contact” page,  you only want to display a list of 5 guides that relate to information of that specific page.

You can easily configure each guide to show in the guides list for specific URL’s (pages). To do that:
1. Open the Helppier widget.

2. Go to the Guides tool.
3. Click the “edit guide” icon on the right of the guide you want to configure.

4. Enter the guide settings panel by clicking the gear icon.

5. In the widget’s footer, press the fourth icon - “edit guide pages”. 

In this panel, you can quickly set up if the guide should be hidden (not being listed in any page), visible in all pages, or visible only in a specific page. By selecting the latter, you can then specify the URL where the guide should exclusively be listed.

Example: “/contact.html” would configure the guide to be listed exclusively in "”.


Failed Behaviors

This parameter enables you to set up how a guide should behave if it fails to start.

Example: In your “Contact” page, your guides list contains a “Welcome” guide that is only playable in your Homepage - as it relates to that page’s specific elements.

If your visibility settings enable that “Welcome” guide to be listed in the “Contact” page, a user can attempt to play it - which will result in a failed behavior.
Then, by setting up custom failed behaviors, you can choose what should happen when that failed behavior is detected.

Here’s how you can configure failed behaviors:
1. Open the Helppier widget.
2. Go to the guides panel.
3. Click the “edit guide” icon on the right of the guide you want to configure.

4. Click the “failed behaviors” icon, just above the steps list.

5. Choose an action to be taken when the guide fails to start.


Fail Behaviour options:

Stop playing the guide - the default setting. If a guide fails to start, it is immediately stopped.

Display an error message - you can show a custom error message to your users. Learn more here

Reload the web page - the current page is reloaded in an attempt to restart the guide.

Redirect the user to a start page - the user is automatically redirected to a certain page. In the example above, trying to play the “Welcome” guide would fail, and could redirect the user to your homepage, where the guide would play flawlessly.

Start a new tutorial first - the user is automatically taken into another tutorial. This is useful if you wish that the user goes through a specific guide before starting the guide that produced the failed behavior.
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
Invalid characters found