Contact Us

Guides

Pendo Help CenterGuidesGuide Activation Options

Guide Activation Options

note: This article covers the Guide experience launched Feb. 18th 2019. If you were a customer before this date and would like to use the Legacy Designer, you can refer back to the previous version.

Overview

Guides can be presented to users through a few different methods. A guide can simultaneously utilize these different activation methods to achieve the desired behavior. ​Activation can be setup during Guide creation under the Activation settings in the action bar:

activation.png

Automatic

The guide will automatically display to the targeted segment upon page load or previous step completion (if building a Walkthrough).

The default nature of a guide that is set to "Automatic" activation is to never display to a user again once it has been seen and dismissed by that user, either via the ‘X’ in the upper-right corner or a dismiss button within the guide. Unless your guide has any custom JavaScript that overrides the default Pendo functionality, you should expect your users to only see a guide set to "Automatic" activation until they dismiss it.

activation.png

Badge

Badges let you place a small icon next to an element on your page. When your visitors click that element, the guide will be shown. This is a fantastic way to add inline support to your web application - your users can request information at the moment they need it.

Badge Target Element

When you choose the badge option, you will be in "Target Mode" to choose the element. The badge will appear next to the chosen element.

If the guide is a walkthrough, the badge location will be determined by the target element and location determined by the first step of the guide so you will see this warning message:

badge-settings-warning.png

Badge Icon

Choose from one of our provided badge icons or upload one of your own. The color of our provided icons can be modified with the color input below the icon dropdown.

badge-icon-options.png

Badge Position

This determines where the badge appears in relation to the target element. Choose Top-right, Top-left, or inline.

Badge Offset

The Top and Right offset allow you to adjust the positioning of the badge in relation to the target element. Both positive and negative pixel values are accepted.

Badge Guide Behavior

"Show on badge hover or click" will display the Guide if the badge icon is hovered over or clicked. "Show only on badge click" will not display the Guide when the badge is hovered over.

guide-behavior.png

Badge Behavior

"Always show badge" will display the badge next to the target element no matter what the user is hovering over. "Show badge only on element hover" will only display the badge when the mouse is hovering over the targeted element.

badge-behavior.png

Badge Frequency

"Always show" will leave the badge in place even if a user has seen the guide before, allowing them to reference the information again and again. "Show only once" will cause the badge to disappear for a user if they have already seen the guide.

badge-frequency.png

Target Element

elementclick.png

This method will launch a guide when a user clicks on a designated element within your application.

Location

The location is inherited from the first step of the Guide. To change the location, edit the location from Step 1.

elementclick-location.png

Guide Behavior

"Show on badge hover or click" will display the tooltip if the badge icon is hovered over or clicked. "Show only on badge click" will not display the tooltip when the badge is hovered over.

elementclick-behavior.png

Frequency

"Always show" will leave the badge in place even if a user has seen the guide before, allowing them to reference the information again and again. "Show only once" will cause the badge to disappear for a user if they have already seen the guide.

elementclick-frequency.png

No Activation Method

By choosing none or deselecting all options, you will see this message:

no-activation-chosen.png

Other than launching the Guide via API, it can also be activated via the Guide permalink or if it’s added to the Resource Center.

Scheduling

Regardless of activation method, if you want a guide to display for a specific period of time, you have the option of adding a "Guide Start Date" and "Guide Expires" date and time from the Guide Details Page.

schedule.png

If you select a start date for a guide, the guide status must be set to Scheduled in order for the guide to publish on the selected date.

note: For customers who are used to the Legacy Designer, the "Schedule" options inside the designer under the "Scheduling" section.

© 2019 Pendo  |  Terms of Service  |  Privacy Policy