- 19 Jun 2024
- 3 Minutes To Read
-
Print
-
DarkLight
-
PDF
Define step completion rules
- Updated On 19 Jun 2024
- 3 Minutes To Read
-
Print
-
DarkLight
-
PDF
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:
-
Open the desktop application where you would like to create the Flow and then launch the Whatfix Desktop Studio.
-
Click Flow.
-
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, scroll down to the Step Completion Rules section.
- 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.
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 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. |
8. Finish 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 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 the checkbox | On click of next button |
Entering a value in a text or number field | On click of next button |
Select an option after a right-click on the 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. This is done to limit the scope for errors that could result in Flow failures.
On click of "next" button | On click of selected element | On hovering over selected element | On typing text | 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 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.