Top
Define step completion rules
  • 29 Mar 2024
  • 3 Minutes To Read
  • Dark
    Light
  • PDF

Define step completion rules

  • Dark
    Light
  • PDF

Article summary

Step Completion Rules in a Flow will help you define when Whatfix must stop displaying one step and then show the next step of the Flow. Step completion rules are defined while creating a 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 the dropdown menu. 

Define a Step completion rule

Use the following steps to define step completion rules:

  1. Open the desktop application where you would like to create the Flow and then launch the Whatfix Desktop 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, scroll down to the Step Completion Rules section.
  2. Select the Step Completion Rules from the list. You can select multiple rules given by the desired step completion rule.

Whenever a Flow moves from one window to another, set the step completion rule as On click of selected element to the step that precedes the new window.

RuleDescription
On click of next buttonThe 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 elementThe 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 elementThe next step is displayed when the users hover the cursor over the selected element.
On Right Click of MouseThe 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 EscThe next step is displayed when users click Enter, Tab, or Esc keys on the keyboard.

8. Finish creating the Flow.

Find a Step completion rule using an action

ActionSuggested Step Completion Rule
Selecting an element in a drop-downOn selection change
Selecting an option from a set of optionsOn selection change
Clicking a buttonOn click of selected element
Clicking an icon, text, or any elementOn click of selected element
Selecting multiple options using the checkboxOn click of next button
Entering a value in a text or number fieldOn click of next button
Select an option after a right-click on the mouseOn Right Click of Mouse
Closing a pop-up using the Esc keyOn Keyboard - Esc
Saving the form using the Enter keyOn Keyboard - Enter

The step completion rules that are available are automatically limited by the kind of step completion rule you select. This is done to limit the scope for errors that could result in Flow failures.

Combination of step completion rules are as follows

On click of "next" buttonOn click of selected elementOn hovering over selected elementOn typing textOn Right Click of MouseOn Keyboard - EnterOn Keyboard - TabOn Keyboard - Esc
On click of "next" buttoncrosstickticktickticktickticktick
On click of selected elementtickcrosscrosscrosscrosstickcrosscross
On hovering over selected elementtickcrosscrosscrosscrosscrosstickcross
On page refresh (in case of change in URL)crosscrosscrosscrosscrosscrosscrosscross
On typing texttickcrosscrosscrosscrossticktickcross
On selection changetickcrosscrosscrosscrosstickcrosscross
On Right Click of Mousetickcrosscrosscrosscrosscrosscrosscross
On Keyboard - Enterticktickcrosstickcrosscrosscrosscross
On Keyboard - Tabtickcrossticktickcrosscrosscrosscross
On Keyboard - Esctickcrosscrosscrosscrosscrosscrosscross
Note:

If the application has a default selection (pre-selected value) that's already selected in a dropdown menu, then the step completes only if the user makes a change in the selection. The step is not completed even though the desired value is already selected. Users need to select another value and then switch back to the desired value.


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.