Business Rules have several quirky behaviors that will be addressed in a future release. Please read and understand these points before writing your first business rule.
...
- An initialization rule (form.load) that does not specify a step.
- A condition that changes from one step to the next.
- A query that returns results incompatible with the form's fields.
This question is best answered with a few examples.
Example 1
Let's say you have a two step workflow that contains the following rules:
Rule 1: When step 1 of the workflow is execute, the form loads and the Sales Planner Status control displays "Not Ready for Review".
| Code Block |
|---|
Sales Planner Status:
if (form.load) {
SalesPlannerStatus.value = "Not Ready for Review";
} |
Rule 2: When CP Value is Yes, set Sales Planner Status to "Ready for Review." When CP Value is No, set Sales Planner Status to "Not Ready for Review".
...
On Step 1, if the user clicks Yes in the CP field, the Sales Planner Status control correctly displays "Ready for Review".
When you click Continue to advance to the next step of the workflow, the value of the Sales Planner Status is re-set to "Not Ready for Review" even though value of CP is still Yes.
This is as designed. The logic purposely ignores setting value properties that happen in a workflow during form state initialization. This is what happens in the second step of this workflow using linked activities. Note that changes to attributes other than value are not ignored during initialization. The designer will see a message in the log and debug console output that says the set of the property value is ignored.
...
Adding if (_data.getParameter('flow.activity.name') == "Step 1") to the Sales Planner Status rule, gives the expected results:
Example 2
...
You have form that may be preloaded with data, for example the Invoice Number is loaded from the URL, and another rule that makes a control dependent on the controls that are preloaded having a value. Such as:
| Code Block |
|---|
var x;
if (InvoiceNumber.value.length> 0) {
eval ('x=' + http.get('<query url>' + InvoiceNumber.value));
if (x.resultSet[0]) {
if(x.resultSet[0].invoice_description) {
InvoiceDescription.value = x.resultSet[0].invoice_description;
} else {
InvoiceDescription.value = '';
}
} |
The workflow may load with the value of Invoice Number visible, but the dependent controls do not pick up a correct value unless you click and re-select the Invoice Number. Here also, the logic purposely ignores setting value properties that happen in a workflow during form state initialization. Simply adding
| Code Block |
|---|
var event = form.load; |
to your rule will correct the issue.
What causes an "Invalid signature detected. Data may have been tampered with" error?
This error message usually displays in multi-step workflows when there is a rule on a subsequent step that executes at form load and updates values inside a signed section in a previous step. Here are some examples and solutions:
Checkbox with Custom Options in a locked Signed Section
Imagine a two step workflow designed with Linked Steps where step 1 contains a Checkbox control inside a section that the user is required to sign, The checkbox has only one option defined in the Workflow Designer. A Business rule is executed when step 1 loads to dynamically populate the checkbox with additional options.
The image shows this scenario in use mode after the rule has executed. Notice there are three options for the checkbox now. The user selects all three options, signs then clicks continue.
The workflow is routed to Tasks Lists of users who fulfill the requirements for the next step. When Step 2 loads, the rule is executed again. This combination results in data tampered error.
Solution:
This situation can be avoided by always setting more than one option in the Workflow Designer for any checkbox that will be dynamically populated with a rule.
...
Business rules that change the values of controls inside a signed section may result in the "Invalid signature detected. Data may have been tampered with." error. Rules that "tamper with the data" and invalidate a signature once a section has been signed are no longer allowed. Refer to this topic for the details.
Why does the information for the logged in user change when I navigate forward/backwards in my workflow?
Designers can use a Business Rule to initialize fields in the first step of a workflow with information about the logged in user. If your workflow navigates to a different user/role for subsequent steps, and the user navigates back to step 1, the rule executes again when Step 1 loads, overwriting the information in step 1 with the information of the user performing the subsequent step. This is an important consideration whether your workflow is designed using individual or Linked Steps.
You can improve your rule to account for this. For example, let's say you have a two step workflow. Step 1 executes this rule to fill in the First Name, Last Name, Email and the user id into fields named First Name, Last Name, Email and UserID respectively. Note this rule executes when Step 1 loads.
| Code Block |
|---|
if (form.load) {
FirstName.value = _data.getParameter('subject.first.name');
LastName.value = _data.getParameter('subject.last.name');
Email.value = _data.getParameter('subject.email');
UserId.value = _data.getParameter('subject.id');
} |
When user Michael Stewart executes the first step of the workflow, here is what you see:
Michael clicks continue and the workflow progresses to Step 2 which is designed to be performed by a user with the Manager role, Jerry.
Jerry logs in, and access the task from his Task List. Jerry sees Michael Stewarts information from Step 1:
However, if Jerry navigates back to Step 1, the rule executes again when Step 1 loads and overwrites Michael's information with Jerry's:
To prevent initialized fields from being overwritten if users navigate to a previous step in a workflow, you must add a condition to your rule to only initialize the fields if they have not already been initialized when the step loads. Adding the second line to the rule used in this example ensures that initialized fields will not be overwritten.
...
The image shows what Jerry sees when he navigates back to Step 1 with the modified rule in place:
You can adapt the conditional statement in this example to fit your rule.
Why can't I set a T/F Control to "Required" or "Optional"?
T/F (True/False) controls are automatically required by nature, because they must be either checked (true) or blank (false.) When setting conditions for a T/F Control, you will not see "as Required" or "as Optional." If you need this function, consider using a checkbox control with a single option instead.