Guide Activation Conditions

One of the things that makes Iridize stand out is the ability to tailor guides to specific users and user segments by creating unique conditions for various parameters. This document provides a detailed description of the types of conditions Iridize supports.

If you have any questions about these guidelines, please contact us.

Accessing the Activation Conditions

The Guide Options page allows you to define which conditions should govern the display of each guide. To access the guide activation conditions for a certain guide you need to click on the gears icon next to the relevant guide.


Understanding the Activation Conditions

An Iridize guide can be activated in one of three ways.

  1. Autoload - the guide will be loaded automatically as soon as the web page is loaded.
  2. Help Widget - the guide will be displayed in the Iridize help widget; allowing one click access for the user.
  3. Javascript API - the guide will be launched using javascript code based on specific business logic. The Iridize Javascript API will not be discussed here. You can read more about it in this article.

Before you start implementing the activation conditions you need to first thing about when you want a guide to display in the help widget and when it should autoload.

Here are a few common examples:

  • I want the guide to always show in the help widget.
  • I want the guide to be launched automatically 3 times for each user but never twice on the same day.
  • I want the guide to launch when the user visits a page for the first time.

Above is an example of a simple condition; probably the simplest you can create but still very useful. It instructs Iridize to: 'always show the guide in the help widget'

Notice that this condition has no bearing on the autoload as the autoload checkbox is left unchecked.

A real life example - "Editor Overview"

Let's take a look at a real life example. The conditions below are those that govern the "Editor Overview" guide. This guide is shown to each and every user as he enters the Iridize editor for the first time.

There are 4 conditions here, before we take a look at each and every one, note that all 4 conditions apply to autoload while only the last one is relevant to the help widget. All 4 conditions must be met in order for the guide to launch automatically. 

Let's describe each condition:

  1. This tells Iridize not to launch the guide if the user has already engaged with it or deliberately closed it. Engagement is normally the act of advancing to the next step (or further) in the guide.
  2. This tells Iridize to only show this guide to the user if the last time he saw this guide was more than a day ago (86400 seconds).
  3. Tells Iridize to launch the guide only if the user has seen it less than 3 times.
  4. Tells Iridize to autoload the guide if the user is on the /account/fe page. This same conditions tells Iridize to also put this guide in the help widget if the user is on this (/account/fe) page.

Creating your first condition

This is what a condition form looks like:

1. Condition type drop down

Use this to select the type of condition you want to create. Iridize supports 3 types of conditions:

  • Page Conditions - Conditions that are triggered if a certain pages matches certain criteria (e.g. URL contains a specific word)
  • User Conditions - Conditions that are triggered if the current user matches certain criteria (e.g. user role or permission level)
  • Always - this is not really a condition type but merely a way to tell Iridize to always show the guide in the Help Widget or to always Autoload it.

As you make your selection you will see that the condition gets populated with more relevant fields for you to fill.

2. Condition status

Can be either Active (green) or Inactive (red). Only Active conditions are evaluated when your users are using your application. Deactivating a condition can be very useful in debugging the conditions.

3. Autoload / Help Widget

  • Autoload - check this box if you want this Condition applied when the guide is automatically loaded.
  • Help Widget-  check this box if you want this Condition applied when the guide is listed in the Start Panel.

4. Done / Cancel

Click Done to save the changes you have made to the Condition. These changes will only be stored in the server once you click "Save Conditions". Click Cancel to discard all changes you have made to the condition since it was last saved.


User Condition Types

The User Condition Types can be looked upon as 2 distinct groups. The first group contains only one type -the Field- and is the most powerful and flexible type of condition you can use. The second group allows you to govern a guide based on the user's interaction with other Iridize guides; for example you can launch a guide only after the user has completed another guide.


Will match against a a user specific Field as it was relayed to Iridize using the api.field.set call. You can either test the existence of a user field or test its actual value. Use this to govern your guides based on user roles, permission level or even geolocation - the possibilities are endless.

Seen Guide

Will match if the user has seen the provide guide in the past. You can also specify the number of times the guide was seen by the user.

Seen Guide (timed)

This type of condition is similar in essence to the Seen Guide condition but it allows you to state how long ago the guide was seen last.

Advanced in Guide

Will match if the user has engaged with the guide at least once. A user is considered to have engaged with a guide if and only if s/he has advanced passed the first step in the guide.

Advanced in Guide (timed)

This type of condition is similar in essence to the Advance in Guide condition but it allows you to determine how long ago the user last engaged with the guide.

Closed Guide

Will match if the user has decided to manually close the guide by clicking on the 'X' button at the right hand corner of one of the tooltips.

Closed Guide (timed)

This type of condition is similar in essence to the Closed Guide condition but it allows you to state how long ago the guide was last closed by the user.

Advanced in or Closed Guide

This condition is a combination of the Advance in Guide and the Closed Guide conditions. It will match if the user has either engaged with the guide or closed it manually.

NOTE: clicking the "Remind me later" button does not count as closing the guide. So using this condition in combination with the Seen Guide condition "completes" the remind me later functionality.

Finished Guide

Will match if the user has gone through the whole guide from start to finish.

Finished Guide (timed)

This type of condition is similar in essence to the Finished Guide condition but it allows you to state how long ago the guide was completed by the user.

Page Condition Types

The Page condition types allow you to control guide activation based on properties of the page, such as URL, element existence or visibility etc.

For a complete list of page condition types please read this knowledge-base article.

Have more questions? Submit a request


Please sign in to leave a comment.