- 13 Mar 2023
- 3 Minutes To Read
Define step completion rules
- Updated On 13 Mar 2023
- 3 Minutes To Read
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.
Step completion rules are defined while creating a flow.
Use the following steps to define step completion rules:
Log in to the application where you want to create content, and then launch the Whatfix Studio.
Enter the name of the Flow as you want it displayed to the users.
Click + Add Step.
Click the desired element on the page that the user needs to select.
After element selection, under the CONFIGURATIONS tab, scroll down to the Step Completion Rules section and select Manual option.
Select the desired rule from the dropdown menu.
To add additional rules, click the Add Rule button and select the desired rule.
|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 radio buttons. This can be when users are expected to click an element in a drop-down (in the collapsed state) or radio-buttons.|
|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.|
- Click Save Step to finish creating the step, and then continue creating the flow.
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 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.
|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|
|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|
If there is a "default" selection (pre-selected value) while selecting a dropdown element, a change in selection is mandatory for step completion.