Editing Step Branches

One of the strong points of the Iridize solution is how simple it is to create and manage guides for the most complex processes. At the heart of this lies the Step Branches editing page the Guide Editor. The Step Branches editing page empowers you to control the flow of the guide based on various page conditions, setting multiple branches all from the a single place.

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

How Branches Work

You can set one or more branches for each step in the guide. For each branch you can optionally set one or more page conditions to limit when that branch could be chosen.  When the guide advances from a step which has branches, the first branch that can be chosen (considering each branch's conditions) is selected and the guide continues along that branch. Thus, the order in which branches are set in the Edit Branches page is important. Additionally, adding a branch after a branch without conditions will have no effect (see Keep Current Guide Open below for an important exception). If no branch is chosen, the guide will continue to the default next step, just as if no branches were set.

NOTE: If you have multiple Tips in parallel within a Step, the branches are set for each Tip separately.

The Edit Branches Page

The Edit Branches page lists the branches for the current step, you can add and archive branches as well as edit branch settings. To open the page click the "Step Branches: Add" setting in the Advanced Settings Panel of the current step in the Guide Editor.

A step with two branches. The first branch is a Jump to Step branch with conditions and the second is a Launch Guide branch.

1. Done/Cancel

Click Done to save the step branches or click Cancel to discard your changes.

2. Action Buttons

The action buttons (Activate/Deactivate/Delete) allow you to perform an action on all selected branches. You can select all branches by checking “Select all branches” box (labeled 3 in the image above) or by manually selecting each branch using the selection checkbox at its top right corner.

  •  Activate – Click to activate all selected branches. Only active branches are evaluated.
  • Deactivate – Click to deactivate all selected branches. Inactive branchesare not evaluated and will not affect the flow of the guide.
  • Archive– Delete all selected branches. This action cannot be reversed once Done is clicked.

3. Check to select all Branches

Check this box to select all the branches in the Edit Branches page. Helpful if you would like to perform a mass action.

4. Branch Editing Area

See below for more details on editing branches . The image above displays 2 branches.

5. Edit Branch

Click to edit the branch.

6. Show/Hide Advanced Settings

Click to toggle whether advanced branch settings are visible. This option is visible for Launch a Guide type branches only.

7. Reorder Branches

Drag the up & down arrow to drag and drop a branch and change the order of branches.

8. Add Branch

Click to add a new branch.

Jump to Step Branch Type

Jump to another step within the same guide.

Editing a Jump To Step branch. This branch is set to Jump to Step with step API Id "3" when the set Conditions are fulfilled.

1. Select Branch Type

Branch type select box.

2. Step API id

The API id of the step to jump to. The step API id may be found in the Step Settings Panel of the Guide Editor.

3. Add/Edit Conditions

Click to open the conditions editor, where you can add/edit Conditions to the branch.

4. Done/Cancel

Click on Done to finish editing the branch and keep your changes. Click on Cancel to discard the changes made to the branch.

Launch a Guide Branch Type

Choose the Launch a Guide branch type to launch another guide from within the current guide. When used without branch conditions, this is often used to string together several guides into a unified guide. When branch conditions are used this is often used for forking a guide based on user choices or application state.

Editing a Launch a Guide branch with advanced settings. This branch is set to Launch a Guide with apiName "98j68vyj".

1. Select Branch Type

Branch type select box.

2. Guide apiName

The apiName of the guide to launch. The apiName of a guide can be found in the guide's listing on the Guides page of the iridize dashboard.

3. Step API Id

By default the launched guide is started from its first step. When this textbox is not empty, the launched guide will start from the step with the API id in the textbox. The step API id may be found in the Step Settings Panel of the Guide Editor.

4. Keep Current Guide Open

The Launch a Guide type of branch normally launches the guide and then closes the current guide. When the Keep Current Guide Open checkbox is checked the current guide is kept open. Additionally, the branch choosing process continues on to the following branches (if any) and to the default next step if no other branch is chosen. This is often useful when launching a guide which is run in a popup window (see Popup Window Name setting below), where the current guide stays open waiting for the user to get back from following the launched guide on the popup window.

5. Add/Edit Conditions

Click to open the conditions editor, where you can add/edit Conditions to the branch.

6. Show/Hide Advanced Settings

Click to toggle whether advanced branch settings (items 7-11 below) are visible.

7. Wait for Page to Load

When this checkbox is checked the launched guide will not start until a page load takes place (either a full page load or a SPA route load on a properly integrated SPA). This is almost always necessary when launching a guide in a popup window (see Popup Window Name setting below). Another use for this setting is when combined with the Redirect to Page or Reload Page settings.

8. Redirect to Page

When the textbox is not empty, the user will be redirected to the URL specified in the textbox when launching the guide. Please note that it is almost always a good idea to also set the Wait for Page to Load setting when using Redirect to Page.

9. Reload Page

When this checkbox is checked, the page will be reloaded when launching the guide. Please note that it is almost always a good idea to also set the Wait for Page to Load setting when using Redirect to Page.

10. Popup Window Name

By default the launched guide starts in the current browser tab/window. When this textbox is not empty the guide will be launched in a tab/window with the Javascript window.name property matching the text in the textbox. This is useful for launching guides within a popup window or another tab. For use with a popup window, this setting almost always requires also setting the Wait for Page to Load setting to work properly.

If you don't know the name of the popup window, refer to this video

11. On Close Return-Here/Launch-a-Guide

This setting sets an action to take place when the launched guide is closed (either by the user or by finishing the guide).

  • Return Here - with this setting the launcher guide is suspended upon launching the guide. When the launched guide is closed the launcher guide resumes from the same step it was when suspended.
  • Launch a Guide - with this setting the launcher guide is closed as usual. When the launched guide is closed, the guide with the apiName set in the textbox is launched.

12. Done/Cancel

Click on Done to finish editing the branch and keep your changes. Click on Cancel to discard the changes made to the branch.

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.