Top
Define step completion rules
  • 19 Dec 2023
  • 4 Minutes To Read
  • Dark
    Light
  • PDF

Define step completion rules

  • Dark
    Light
  • PDF

Article Summary

Step Completion Rules in a flow helps you define when Whatfix must stop displaying one step and then show the next step of the flow. For example, users move to the next step when they click the next button, or on refreshing the page, or on selecting an option from a dropdown menu, etc.

Define a Step completion rule

Step completion rules are defined while creating a flow.

Use the following steps to define step completion rules:

  1. Log in to the application where you want to create content, and then launch the Whatfix Studio.

  2. Click Flow.
    clm_Studio_flows

  3. Enter the name of the Flow as you want it displayed to the users.
    Editor_flow_name6

  4. Click + Add Step.
    Editor_flow_addstep

  5. Click the desired element on the page that the user needs to select.

  1. After element selection, under the CONFIGURATIONS tab, scroll down to the Step Completion Rules section and select Manual option.
    Editor_flow_step_completion_manual

  2. Select the desired rule from the dropdown menu.
    Editor_flow_step_rules

  3. To add additional rules, click the Add Rule button and select the desired rule.
    Editor_flow_step_add_rule

Rule Description
On click of next button The next step is displayed when the "next" button in the tooltip is clicked. This can be used when users have to select multiple options using a checkbox or in text fields, and then move to the next step after giving inputs.
On click of selected element The next step is displayed when the users click the selected element. This can be used when the tip is created on a clickable button, link or HTML element. The flow expects the user to click on the element to move to the next flow step.
On hovering over selected element The next step is displayed when the users hover the cursor over the selected element.
On page refresh (in case of change in URL) The next step is displayed when the users refresh the page. This can be used in payment pages after successful payment where the page automatically refreshes.
On typing text (for text boxes) The next step is displayed when the users stop typing for a couple of seconds. This can be used on text boxes where users enter values like sign up page, login page, and any other pages where users input is required.
On selection change The next step is displayed when users click the selected element in a drop-down or set of options. This can be when users are expected to click an element in a drop-down (in the collapsed state) or from a given set of options.
On Right Click of Mouse The next step is displayed when users do a right-click on the mouse. This can be used when users are expected to click an option after right-clicking on a page.
On Keyboard - Enter, Tab, or Esc The next step is displayed when users click Enter, Tab, or Esc keys on the keyboard.
  1. Click Save Step to finish creating the step, and then continue creating the flow.
    Editor_flows_save_step

Find a Step completion rule using an action

Action Suggested Step Completion Rule
Selecting an element in a drop-down On selection change
Selecting an option from a set of options On selection change
Clicking a button On click of selected element
Clicking an icon, text, or any element On click of selected element
Selecting multiple options using checkbox On click of next button
Entering value in a text or number field On click of next button
Selecting an element in a drop-down that opens automatically when the cursor is hovered over it On hovering over selected element
Select an option after doing a right-click on mouse On Right Click of Mouse
Closing a pop-up using the Esc key On Keyboard - Esc
Saving the form using the Enter key On Keyboard - Enter

The step completion rules that are available are automatically limited by the kind of step completion rule you select. We've done this to limit the scope for errors that result in flow failures.

Combination of Step Completion Rules

Action Suggested Step Completion Rule
Selecting an element in a drop-down On selection change
Selecting an option from a set of radio buttons On selection change
Clicking a button On click of selected element
Clicking an icon, text, or any element On click of selected element
Selecting multiple options using checkbox On click of next button
Entering value in a text or number field On click of next button
Selecting an element in a drop-down that opens automatically when the cursor is hovered over it On hovering over selected element
Select an option after doing a right-click on mouse On Right Click of Mouse
Closing a pop-up using the Esc key On Keyboard - Esc
Saving the form using the Enter key On Keyboard - Enter

The step completion rules that are available are automatically limited by the kind of step completion rule you select. We've done this to limit the scope for errors that result in flow failures.

Combination of Step Completion Rules

On click of "next" button On click of selected element On hovering over selected element On page refresh (in case of change in URL) On typing text On selection change On Right Click of Mouse On Keyboard - Enter On Keyboard - Tab On Keyboard - Esc
On click of "next" button cross tick tick cross tick tick tick tick tick tick
On click of selected element tick cross cross cross cross cross cross tick cross cross
On hovering over selected element tick cross cross cross cross cross cross cross tick cross cross
On page refresh (in case of change in URL) cross cross cross tick cross cross cross cross cross cross
On typing text tick cross cross cross cross cross cross tick tick cross
On selection change tick cross cross cross cross cross cross tick cross cross
On Right Click of Mouse tick cross cross cross cross cross cross cross cross cross
On Keyboard - Enter tick tick cross cross tick tick cross cross cross cross
On Keyboard - Tab tick cross tick cross tick cross cross cross cross cross
On Keyboard - Esc tick cross cross cross cross cross cross cross cross cross

Info

If there is a "default" selection (pre-selected value) while selecting a dropdown element, a change in selection is mandatory for step completion.


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.