When Do Rules Execute
Business Rules are executed under the following conditions:
- When the form/workflow loads.
- When a control's value that the rule depends on changes.
- When you add a row to a Table control or click on the icon to add a repeating item.
If you want your rule to run Only when the form loads - check the Initialization Only checkbox at the top of the wizard. Typically, you would check this if there is some business logic that you want to execute before the form/workflow displays and users begin interacting with it.
When the rule displays in the Rule Builder tab, it will indicate that the rule has been flagged to run only when the form loads, if this checkbox is checked.
Rule Builder Wizards
Describe the conditions under which a set of actions should be executed. You can specify more than one condition in the same rule but you do not need a condition.
Each condition consists of the following:
|Field or current step (Optional)|
What field or current workflow step do you want to evaluate?
|Operator||What condition do you want to test to see if it is true? Select to from the choices to use an expression or function in your rule|
What value do you want to compare the Field or current step to?
What function/operator do you want to use to build the expression?
The left side Field and right side Value must be of a matching type. For example, you cannot use numeric expressions with text controls. If you've selected an incompatible value type, Help Mode will show an error to help you correct it.
The following functions are available in the Rule Builder for building expressions. Function names may be entered in any case (case insensitive).
Functions are entered into the Enter an Expression field in the wizards.
This field has two modes:
- Lookup Mode
- Help Mode
Lookup mode displays functions and controls from your form/workflow. The functions matching the typed text are displayed first followed by the form/workflow controls.
Lookup Mode is triggered as you enter text in the Value fields of the wizards.
Help mode shows help text for the function in the dropdown area. The help information includes:
- function syntax
- summary info about the function
- an example
- parameter information.
Use these operators to build useful expressions:
In versions prior to v9.1, the '+' operator was used for both addition and concatenation. With the v9.1 upgrade, any '+' operators used for concatenation will be automatically updated to use the concat() function. Designers should use the concat() function for concatenation of text strings, and the '+' operator only for addition of numeric values. Using the '+' operator for concatenation will return an error prompting the designer to use concat() instead.
Declare the actions that should be taken when the condition is true. The Functions/Operators listed above can also be selected as the value in this wizard.
Else Action wizard
Declare the actions that should be taken when the condition is false. The Functions/Operators listed above can also be selected as the value in this wizard. Else Actions are optional as not all rules require them. You cannot add FALSE actions if you do not have a condition specified in the rule.
Add A Rule
- Click the Run Builder button.
- Click the Add Condition button to create a new condition (optional).
- Select your Field or select current step to describe an action that will execute based on the workflow step currently executing.
- Select the Action from the dropdown.
Select the Value, expression or function(optional). To enter a text value, slide thetoggle switch icon to the right and a field displays to the right.
If current step is selected as the condition for a workflow designed using Linked Steps, the value dropdown displays the names of the linked steps as choices. Workflows designed with individual forms as steps (not linked) will only show that step in the current step value dropdown.
- If you have one form (named form A) in a workflow, you will only see form A listed in the current step value dropdown,
- If you add 2 linked steps (named form B and form C), the current step value dropdown lists all 3 steps: form A, form B and form C.
- If you add form D (not linked) to the workflow, form D will not be listed in the current step value dropdown for form A
- Click Next to advance to the Action wizard.
- Specify the actions to be taken if the condition is true.
- Click Next to advance to the Else Action wizard
- Specify the actions to be taken if the condition is false.
- Click Finish.
- Save your form/workflow.
- Click the Save and Test icon to verify that your rule is working as expected.
Modify a Rule
Once completed, the entire rule can be viewed in the Rule Builder tab.
- Click the pencil icon on whatever part of the rule you want to modify.
- Click the up and down arrows on the right side to change the order of conditions and actions.
Delete a Rule
Click theicon in the Rules Validator next to the rule you want to delete. You will be asked to confirm.
Multiple Conditions in a Rule
- The (AND operation) means that All of the specified conditions must be true before the actions set up in the Action Wizard are executed.
- Change the (AND operation(s)) to (OR operation(s)) if only one of the conditions needs to be true before the actions are executed.
- Group parts of the logic expression using parentheses if necessary.
A Travel Request workflow contains a field where the user selects a destination country from a dropdown. Countries that call their subdivisions "states" are: United States, Mexico, Australia, Brazil, India, Germany and Myanmar.
The business requirement for this rule is: If any of these countries are selected, a Destination State field is enabled so the user can enter the Destination state. Otherwise, the Destination State field is disabled.
The Condition wizard for the business rule is shown in the image. Note that each condition is assigned a color coded number that is reflected in the logic expression. The logic expression is built with the and operator by default. Since we want the rule to execute when any of the conditions are true, we must change all the and operations in the logic expression to the or operation.
Switching to the Rule Code Tab
Clicking the Edit Code button permanently disables the Rule Builder for this rule.
Future Releases of the Visual Rule Builder
This version of the Visual Rule Builder does not currently support screenflows that use the Navigation toolbar to move back and forth between screenflow steps.