Operator types and events in rule editor of an Adaptive Form based on Core Components

In AEM Forms as a Cloud, the rule editor includes various operator types and events that enable you to define and execute complex conditions and actions with ease.

The operator types available in the rule editor of an Adaptive Form provide a robust framework for constructing precise conditions. They allow you to manipulate data, perform calculations, and combine multiple conditions in a logical and coherent manner. Whether you are comparing values, performing arithmetic operations, or manipulating strings, these operators ensure that your rules are both flexible and powerful.

Events in the rule editor serve as the triggers that activate your rules. They define the specific actions that occur when certain conditions are met. By leveraging different types of events, you can automate responses to a wide range of scenarios, for example, user interactions, scheduled times, changes in data, and system states. With the ability to specify these triggers, you can create dynamic and responsive rules that cater to your specific requirements.

By understanding and using the available operator types and events, you can unlock the full potential of the rule editor, which enables you to create efficient, and effective rules that meet your unique needs and improve overall system functionality.

Available operator types and events in rule editor available-operator-types-and-events-in-rule-editor

The rule editor provides the following logical operators and events using which you can create rules.

Available rule types in rule editor available-rule-types-in-rule-editor

The rule editor provides a set of predefined rule types that you can use to write rules. Let’s look at each rule type in detail. For more information about writing rules in the rule editor, see Write rules.

When whenruletype

The When rule type follows the condition-action-alternate action rule construct, or sometimes, just the condition-action construct. In this rule type, you first specify a condition for evaluation followed by an action to trigger if the condition is satisfied ( True). While using the When rule type, you can use multiple AND and OR operators to create nested expressions.

Using the When rule type, you can evaluate a condition on a form object and perform actions on one or more objects.

In plain words, a typical When rule is structured as follows:

When on Object A:

(Condition 1 AND Condition 2 OR Condition 3) is TRUE;

Then, do the following:

Action 2 on Object B;
AND
`Action 3 on Object C;

Else, do the following:

Action 2 on Object C;
_

When you have a multi-value component, such as radio buttons or list, while creating a rule for that component the options are automatically retrieved and made available to the rule creator. You need not type the option values again.

For example, a list has four options: Red, Blue, Green, and Yellow. While creating the rule, the options (radio buttons) are automatically retrieved and made available to the rule creator as the following:

While writing a When rule, you can trigger the Clear Value Of action. Clear Value Of action clears the value of the specified object. Having Clear Value of as an option in the When statement lets you create complex conditions with multiple fields. You can add the Else statement to add further conditions

Allowed Multiple fields in When allowed-multiple-fields

In the When condition, you have the option to add other fields apart from the field to which the rule is applied.

For example, using the When rule type, you can evaluate a condition on different form objects and perform the action:

When:

(Object A Condition 1)

AND/OR

(Object B Condtion 2)

Then, do the following:

Action 1 on Object A

_

Considerations while using Allowed Multiple fields in When condition feature

If the allowed multiple fields in the When condition feature encounter any issues, follow the troubleshooting steps as:

Hide Hides the specified object.

Show Shows the specified object.

Enable Enables the specified object.

Disable Disables the specified object.

Invoke service Invokes a service configured in a form data model (FDM). When you choose the Invoke Service operation, a field appears. On tapping the field, it displays all services configured in all form data model (FDM) on your Experience Manager instance. On choosing a Form Data Model service, more fields appear where you can map form objects with input parameters for the specified service. You can map the output parameters through the event payload option for the specified service. You can also create rules for handling success and failure responses of the Invoke service operation using the rule editor.

See the example rule for invoking Form Data Model (FDM) services.

In addition to the Form Data Model service, you can specify a direct WSDL URL to invoke a web service. However, a Form Data Model service has many benefits and the recommended approach to invoke a service.

For more information about configuring services in form data model (FDM), see Experience Manager Forms Data Integration.

Set value of Computes and sets the value of the specified object. You can set the object value to a string, the value of another object, the computed value using a mathematical expression or function, the value of a property of an object, or the output value from a configured Form Data Model service. When you choose the web service option, it displays all services configured in all form data model (FDM) on your Experience Manager instance. On choosing a Form Data Model service, more fields appear where you can map form objects with input and output parameters for the specified service.

For more information about configuring services in form data model (FDM), see Experience Manager Forms Data Integration.

The Set Property rule type lets you set the value of a property of the specified object based on a condition action. You can set the property to one of the following:

For example, it enables you to define rules to show the textbox when a button is clicked. You can use a custom function, a form object, object property, or a service output to define a rule.

To define a rule based on a custom function, select Function Output from the drop-down list, and drag-and-drop a custom function from the Functions tab. If the condition action is met, the text input box gets visible.

To define a rule based on a form object, select Form Object from the drop-down list, and drag-and-drop a form object from the Form Objects tab. If the condition action is met, the text input box gets visible in the Adaptive Form.

A Set Property rule based on an object property lets you make the text input box visible in an Adaptive Form based on another object property that is included in the Adaptive Form.

The following figure depicts an example of dynamically enabling the checkbox based on the hiding or showing of a textbox in an Adaptive Form:

Clear Value Of Clears the value of the specified object.

Set Focus Sets focus on the specified object.

Submit Form Submits the form.

Reset Resets the form or specified object.

Validate Validates the form or specified object.

Add Instance Adds an instance of the specified repeatable panel or table row.

Remove Instance Removes an instance of the specified repeatable panel or table row.

Function Output Defines a rule based on predefined functions or custom functions.

Navigate to Navigate to other Adaptive Forms, other assets such as images or document fragments, or an external URL.

Dispatch Event Triggers the specific actions or behaviors based on predefined conditions or events.

Set Value of set-value-of

The Set Value of rule type lets you set the value of a form object depending on whether the specified condition is satisfied or not. The value can be set to a value of another object, a literal string, a value derived from a mathematical expression or a function, a value of a property of another object, or the output of a Form Data Model service. Similarly, you can check for a condition on a component, string, property, or values derived from a function or mathematical expression.

The Set Value Of rule type is not available for all form objects, such as panels and toolbar buttons. A standard Set Value Of rule has the following structure:

Set the value of Object A to:

(String ABC) OR
(object property X of Object C) OR
(value from a function) OR
(value from a mathematical expression) OR
(output value of a data model service);

When (optional):

(Condition 1 AND Condition 2 AND Condition 3) is TRUE;

Following example selects the value of Question2 as True and sets the value of Result as correct.

Example of Set Value rule using the Form Data Model service.

Show show

Using the Show rule type, you can write a rule to show or hide a form object based on whether a condition is satisfied or not. The Show rule type also triggers the Hide action in case the condition is not satisfied or returns False.

A typical Show rule is structured as follows:

Show Object A;

When:

(Condition 1 OR Condition 2 OR Condition 3) is TRUE;

Else:

Hide Object A;

Hide hide

Similar to the Show rule type, you can use the Hide rule type to show or hide a form object based on whether a condition is satisfied or not. The Hide rule type also triggers the Show action in case the condition is not satisfied or returns False.

A typical Hide rule is structured as follows:

Hide Object A;

When:

(Condition 1 AND Condition 2 AND Condition 3) is TRUE;

Else:

Show Object A;

Enable enable

The Enable rule type lets you enable or disable a form object based on whether a condition is satisfied or not. The Enable rule type also triggers the Disable action in case the condition is not satisfied or returns False.

A typical Enable rule is structured as follows:

Enable Object A;

When:

(Condition 1 AND Condition 2 AND Condition 3) is TRUE;

Else:

Disable Object A;

Disable disable

Similar to the Enable rule type, the Disable rule type lets you enable or disable a form object based on whether a condition is satisfied or not. The Disable rule type also triggers the Enable action in case the condition is not satisfied or returns False.

A typical Disable rule is structured as follows:

Disable Object A;

When:

(Condition 1 OR Condition 2 OR Condition 3) is TRUE;

Else:

Enable Object A;

Validate validate

The Validate rule type validates the value in a field using an expression. For example, you can write an expression to check that the text box for specifying a name does not contain special characters or numbers.

A typical Validate rule is structured as follows:

Validate Object A;

Using:

(Expression 1 AND Expression 2 AND Expression 3) is TRUE;

Navigate among the panels

The Navigate among the panels rule type allows you to shift focus among different panels in a form. For example, you can create an expression to move focus to the next panel.

A typical Navigate among the panels rule for shifting focus to the next panel is structured as follows:

Navigate among the panels

Shift focus to the next item Object A;

When:

(Condition 1 OR Condition 2 OR Condition 3) is TRUE;

Similarly you can write Navigate among the panels rule for shifting focus to the previous panel:

Navigate among the panels

Shift focus to the previous item Object A;

When:

(Condition 1 OR Condition 2 OR Condition 3) is TRUE;

For more details on how to create a rule to navigate in a panel, click here.

Async Function call

This is a pre-release feature and accessible through our pre-release channel.

The Async Function call rule type allows you to execute asynchronous functions. It enables you to initiate a function call that operates independently of the main execution thread, allowing other processes to continue running without waiting for the asynchronous function to complete.

A typical Async Function call rule to execute asynchronous function is structured as follows:

When:

(Condition 1 OR Condition 2 OR Condition 3) is TRUE;

Async Function call

[Callback Function];

For more information on how to use the Async Function call in the Visual Rule Editor, refer to the Using asynchronous function calls in the rule editor article.

Next Step

Let us now understand various examples for a Rule Editor for an Adaptive Form based on Core Components.

See Also