Documentation AEM as a Cloud Service User Guide

Add rules to an Adaptive Form

Last update: January 29, 2025

Applies to:
Experience Manager as a Cloud Service

CREATED FOR:

Beginner
Intermediate
User
Developer

NOTE

Adobe recommends using the modern and extensible data capture Core Components for creating new Adaptive Forms or adding Adaptive Forms to AEM Sites pages. These components represent a significant advancement in Adaptive Forms creation, ensuring impressive user experiences. This article describes older approach to author Adaptive Forms using foundation components.

Version	Article link
AEM as a Cloud Service (Foundation Components)	This article
AEM as a Cloud Service (Core Components)	Click here
AEM 6.5	Click here

Overview

The rule editor feature empowers forms business users and developers to write rules on Adaptive Form objects. These rules define actions to trigger on form objects based on preset conditions, user inputs, and user actions on the form. It helps further streamline the form filling experience ensuring accuracy and speed.

The rule editor provides an intuitive and simplified user interface to write rules. Rule editor offers a visual editor for all the users. Some of the key actions that you can perform on Adaptive Form objects using rules are:

Show or hide an object
Enable or disable an object
Set a value for an object
Validate the value of an object
Execute functions to compute the value of an object
Invoke a Form Data Model service and perform an operation
Set property of an object

Users added to the forms-power-users group can create scripts and edit existing ones. Users in the forms-users group can use the scripts but not create or edit scripts.

Difference between Rule editor in Core Components and Rule Editor in Foundation Components

The following table demonstrates the difference between the features available in the Rule Editor’s Core Components and the Rule Editor’s Foundation Components:

Features	Adaptive Form Foundation Components	Adaptive Form Core Components
Set the drop-down list of options	The drop-down list of options is set using the Rule Editor's Set Options of property.	The dropdown options are set using the custom functions.
Perform mathematical operations on the repeatable panel field	OOTB Math functions can be applied on repeatable panel fields to perform functions like sum, average using the Rule Editor. Two arguments need to be provided: the first specifies the repeatable panel containing the field, while the second specifies the field within the corresponding repeatable panel.	Mathematical operations on the repeatable panel field can be performed using the custom functions. You can also apply the mathematical functions directly to the fields of the repeatable panel in Rule Editor.
Validate/Reset field/panel/form rule in 'Then'	Validate and Reset functions only support form object in Rule Editor.	Validate and Reset functions support form / panel / field object in Rule Editor.
ES10 Support	ES10 is not supported yet. It only supports ES5 JavaScript features.	Support for modern JavaScript features such as let and arrow functions (ES10 support) within custom functions.
Service output property	The Service output property is supported in the Set Value of option of the Rule Editor.	The Set Value of option does not support the Service output property for invoking APIs in the Rule Editor.
Navigate between the panels	The Next button and Previous button components are provided to navigate between the panels. A navigation button placed within the container works on its child elements	The Navigation in Panel rule is available in the rule editor, allowing users to create rules for navigating between the children of panels.

Understanding a rule

A rule is a combination of actions and conditions. In rule editor, actions include activities such as hide, show, enable, disable, or compute the value of an object in a form. Conditions are Boolean expressions that are evaluated by performing checks and operations on the state, value, or property of a form object. Actions are performed based on the value ( True or False) returned by evaluating a condition.

The rule editor provides a set of predefined rule types, such as When, Show, Hide, Enable, Disable, Set Value Of, and Validate to help you write rules. Each rule type lets you define conditions and actions in a rule. The document further explains each rule type in detail.

A rule typically follows one of the following constructs:

Condition-Action In this construct, a rule first defines a condition followed by an action to trigger. The construct is comparable to if-then statement in programming languages.

In rule editor, the When rule type enforces the condition-action construct.

Action-Condition In this construct, a rule first defines an action to trigger followed by conditions for evaluation. Another variation of this construct is action-condition-alternate action, which also defines an alternate action to trigger if the condition returns False.

The Show, Hide, Enable, Disable, Set Value Of, and Validate rule types in rule editor enforce the action-condition rule construct. By default, the alternate action for Show is Hide and for Enable is Disable, and the opposite way. You cannot change the default alternate action.

NOTE

The available rule types, including conditions and actions that you define in rule editor, also depend on the type of form object on which you are creating a rule. The rule editor displays only valid rule types and options for writing condition and action statements for a particular form object type. For example, you do not see Validate, Set Value Of, Enable, and Disable rule types for a panel object.

For more information about rule types available in the rule editor, see Available rule types in rule editor.

Guidelines for choosing a rule construct

While you can achieve most of the use cases by using any rule construct, here are some guidelines to choose one construct over another. For more information about the available rules in rule editor, see Available rule types in rule editor.

A typical rule of the thumb when creating a rule is to think about it in the context of the object on which you are writing a rule. Consider that you want to hide or show the field B based on the value a user specifies in the field A. In this case, you are evaluating a condition on field A, and based on the value it returns, you are triggering an action on field B.

Therefore, if you are writing a rule on field B (the object on which you are evaluating a condition), use the condition-action construct or the When rule type. Similarly, use the action-condition construct or Show or Hide rule type on field A.
At times, you must perform multiple actions based on one condition. In such cases, it is recommended to use the condition-action construct. In this construct, you can evaluate a condition once and specify multiple action statements.

For example, to hide fields B, C, and D based on the condition that checks for the value a user specifies in field A, write one rule with condition-action construct or When rule type on field A and specify actions to control the visibility of fields B, C, and D. Otherwise, you need three separate rules on fields B, C, and D, where each rule checks the condition and shows or hides the respective field. In this example, it is more efficient to write the When rule type on one object rather than Show or Hide rule type on three objects.
To trigger an action based on multiple conditions, it is recommended to use action-condition construct. For example, to show and hide field A by evaluating conditions on fields B, C, and D, use Show or Hide rule type on field A.
Use condition-action or action condition construct if the rule contains one action for one condition.
If a rule checks for a condition and performs an action immediately on providing a value in a field or exiting a field, it is recommended to write a rule with condition-action construct or the When rule type on the field on which the condition is evaluated.
The condition in the When rule is evaluated when a user changes the value of the object on which the When rule is applied. However, if you want the action to trigger when the value changes on the server side, like for prepopulating the value, it is recommended to write a When rule that triggers the action when the field is initialized.
When writing rules for drop-downs, radio buttons, or check boxes objects, the options or values of these form objects in the form are pre-populated in the 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.

Is Equal To
Is Not Equal To
Starts With
Ends With
Contains
Is Empty
Is Not Empty
Has Selected: Returns true when the user selects a particular option for a checkbox, drop-down, radio button.
Is Initialized (event): Returns true when a form object renders in the browser.
Is Changed (event): Returns true when the user changes the entered value or selected option for a form object.
Navigation(event): Returns true when the user clicks a navigation object. Navigation objects are used to move between panels.
Step Completion(event): Returns true when a step of a rule completes.
Successful Submission(event): Returns true on successful submission of data to a form data model.
Error in Submission(event): Returns true on unsuccessful submission of data to a form data model.

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 rule editor, see Write rules.

When

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;

_

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 following:

Multi value displays options

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.

Clear value of

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 (FDM) service, more fields appear where you can map form objects with input and output parameters for the specified service. See example rule for invoking Form Data Model services.

In addition to 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 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 property to one of the following:

visible (Boolean)
dorExclusion (Boolean)
chartType (String)
title (String)
enabled (Boolean)
mandatory (Boolean)
validationsDisabled (Boolean)
validateExpMessage (String)
value (Number, String, Date)
items (List)
valid (Boolean)
errorMessage (String)

For example, it enables you to define rules to add check boxes dynamically to the Adaptive Form. You can use custom function, a form object, or an object property to define a rule.

Set Property

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 number of checkboxes defined in the custom function are added to the Adaptive Form.

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 number of checkboxes defined in the form object are added to the Adaptive Form.

A Set Property rule based on an object property lets you add the number of checkboxes in an Adaptive Form based on another object property that is included in the Adaptive Form.

The following figure depicts an example of dynamically adding checkboxes based on the number of drop-down lists in the Adaptive Form:

Object Property

Clear Value Of Clears the value of the specified object.

Set Focus Sets focus on the specified object.

Save Form Saves the form.

Submit Forms Submits the form.

Reset Form Resets the form.

Validate Form Validates the form.

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.

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

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 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 or web service);

When (optional):

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

The following example takes the value in dependentid field as input and sets the value of the Relation field to the output of the Relation argument of the getDependent Form Data Model service.

Set-value-web-service

Example of Set Value rule using Form Data Model service

NOTE

In addition, you can use Set Value of rule to populate all values in a drop-down list component from the output of a Form Data Model service or a web service. However, ensure that the output argument you choose is of an array type. All values returned in an array become available in the specified drop-down list.

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

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

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

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

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 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;

NOTE

If the specified value does not comply with the Validate rule, you can display a validation message to the user. You can specify the message in the Script validation message field in the component properties in the sidebar.

Script-validation

Set Options Of

The Set Options Of rule type enables you to define rules to add check boxes dynamically to the Adaptive Form. You can use a Form Data Model (FDM) or a custom function to define the 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. The number of checkboxes defined in the custom function are added to the Adaptive Form.

Custom Functions

To create a custom function, see custom functions in rule editor.

To define a rule based on a form data model (FDM):

Select Service Output from the drop-down list.
Select the data model object.
Select a data model object property from the Display Value drop-down list. The number of checkboxes in the Adaptive Form is derived from the number of instances defined for that property in the database.
Select a data model object property from the Save Value drop-down list.

FDM set options

Understanding the rule editor user interface

Rule editor provides a comprehensive yet simple user interface to write and manage rules. You can launch the rule editor user interface from within an Adaptive Form in authoring mode.

To launch the rule editor user interface:

Open an Adaptive Form in authoring mode.
Select the form object for which you want to write a rule, and in Component Toolbar select . The rule editor user interface appears.

Any existing rules on the selected form objects are listed in this view. For information about managing existing rules, see Manage rules.
Select Create to write a new rule. The visual editor of the rule editor user interface opens by default when you launch the rule editor the first time.

Let’s look at each component of the rule editor UI in detail.

A. Component-rule display

Displays the title of the Adaptive Form object through which you launched the rule editor and the rule type currently selected. In the above example, the rule editor is launched from an Adaptive Form object titled Salary and the rule type selected is When.

B. Form objects and functions

The pane on the left in the rule editor user interface includes two tabs — Forms Objects and Functions.

The Form Objects tab shows a hierarchical view of all objects contained in the Adaptive Form. It displays the title and type of the objects. When writing a rule, you can drag-drop form objects onto the rule editor. While creating or editing a rule when you drag-and-drop an object or function into a placeholder, the placeholder automatically takes the appropriate value type.

The form objects that have one or more valid rules applied are marked with a Green dot. If any of the rules applied to a form object are invalid, the form object is marked with a Yellow dot.

The Functions tab includes a set of built-in functions, such as Sum Of, Min Of, Max Of, Average Of, Number Of, and Validate Form. You can use these functions to compute values in repeatable panels and table rows and use them in action and condition statements when writing rules. You can, however, create custom functions too.

The Functions tab

NOTE

You can perform text search on objects and functions names and titles in Forms Objects and Functions tabs.

In the left tree of the form objects, you can select the form objects to display the rules applied to each of the objects. Not only you can navigate through the rules of the various form objects, you can also copy-paste rules between the form objects. For more information, see Copy-paste rules.

C. Form objects and functions toggle

The toggle button, when tapped, toggles the form objects and functions pane.

D. Visual rule editor

Visual rule editor is the area in the visual editor mode of the rule editor user interface where you write rules. It lets you select a rule type and accordingly define conditions and actions. When defining conditions and actions in a rule, you can drag-drop form objects and functions from the Form Objects and Functions pane.

For more information about using visual rule editor, see Write rules.

E. Done and cancel buttons

The Done button is used to save a rule. You can save an incomplete rule. However, incomplete are invalid and do not run. Saved rules on a form object are listed when you launch the rule editor next time from the same form object. You can manage existing rules in that view. For more information, see Manage rules.

The Cancel button discards any changes you made to a rule and closes the rule editor.

Write rules

Custom functions in rule editor

Apart from the out-of-the-box functions like Sum of that are listed under Functions Output, you can write custom functions that you frequently need. Ensure that the function you write is accompanied by the jsdoc above it.

Accompanying jsdoc is required:

If you want custom configuration and description
Because there are multiple ways to declare a function in JavaScript, and comments let you keep a track of the functions.

Rule editor supports JavaScript ES5 syntax for scripts and custom functions.
For more information, see jsdoc.app.

Supported jsdoc tags:

Private
Syntax: @private
A private function is not included as a custom function.
Name
Syntax: @name funcName <Function Name>
Alternatively , you can use: @function funcName <Function Name> or @func funcName <Function Name>.
funcName is the name of the function (no spaces allowed).
<Function Name> is the display name of the function.
Member
Syntax: @memberof namespace
Attaches a namespace to the function.
Parameter
Syntax: @param {type} name <Parameter Description>
Alternatively, you can use: @argument {type} name <Parameter Description> or @arg {type} name <Parameter Description>.
Shows parameters used by the function. A function can have multiple parameter tags, one tag for each parameter in the order of occurrence.
{type} represents parameter type. Allowed parameter types are:
1. string
2. number
3. boolean
4. scope
Scope refers fields of an Adaptive Form. When a form uses lazy loading, you can use scope to access its fields. You can access fields either when the fields are loaded or if the fields are marked global.

All parameter types are categorized under one of the above. None is not supported. Ensure that you select one of the types above. Types are not case-sensitive. Spaces are not allowed in the parameter name. <Parameter Descrption> <parameter> can have multiple words. </parameter>
Return Type
Syntax: @return {type}
Alternatively, you can use @returns {type}.
Adds information about the function, such as its objective.
{type} represents the return type of the function. Allowed return types are:
1. string
2. number
3. boolean
All other return types are categorized under one of the above. None is not supported. Ensure that you select one of the types above. Return types are not case-sensitive.
- This
  Syntax: @this currentComponent
Use @this to refer to the Adaptive Form component on which the rule is written.

The following example is based on the field value. In the following example, the rule hides a field in the form. The this portion of this.value refers to underlying Adaptive Form component, on which the rule is written.
/** * @function myTestFunction * @this currentComponent * @param {scope} scope in which code inside function is run. */ myTestFunction = function (scope) { if(this.value == "O"){ scope.age.visible = true; } else { scope.age.visible = false; } }
NOTE
Comments before custom function are used for summary. Summary can extend to multiple lines until a tag is encountered. Limit the size to a single for a concise description in the rule builder.

Adding a custom function

For example, you want to add a custom function which calculates area of a square. Side length is the user input to the custom function, which is accepted using a numeric box in your form. The calculated output is displayed in another numeric box in your form. To add a custom function, you have to first create a client library, and then add it to the CRX repository.

To create a client library and add it in the CRX repository, perform the following steps:

Create a client library. For more information, see Using Client-Side Libraries.
In CRXDE, add a property categorieswith string type value as customfunction to the clientlib folder.

NOTE
customfunctionis an example category. You can choose any name for the category you create in the clientlibfolder.

After you have added your client library in the CRX repository, use it in your Adaptive Form. It lets you use your custom function as a rule in your form. To add the client library in your Adaptive Form, perform the following steps:

Open your form in edit mode.
To open a form in edit mode, select a form and select Open.
In the edit mode, select a component, then select > Adaptive Form Container, and then select .
In the sidebar, under Name of Client Library, add your client library. ( customfunction in the example.)
Select the input numeric box, and select to open the rule editor.
Select Create Rule. Using options shown below, create a rule to save the squared value of the input in the Output field of your form.
Select Done. Your custom function is added.

NOTE
To invoke a form data model (FDM) from rule editor using custom functions, see here.

Function declaration supported types

Function Statement

function area(len) {
    return len*len;
}

This function is included without jsdoc comments.

Function Expression

var area;
//Some codes later
/** */
area = function(len) {
    return len*len;
};

Function Expression and Statement

var b={};
/** */
b.area = function(len) {
    return len*len;
}

Function Declaration as Variable

/** */
var x1,
    area = function(len) {
        return len*len;
    },
    x2 =5, x3 =true;

Limitation: custom function picks only the first function declaration from the variable list, if together. You can use function expression for every function declared.

Function Declaration as Object

var c = {
    b : {
        /** */
        area : function(len) {
            return len*len;
        }
    }
};

NOTE

Ensure that you use jsdoc for every custom function. Although jsdoccomments are encouraged, include an empty jsdoccomment to mark your function as custom function. It enables default handling of your custom function.

Manage rules

Any existing rules on a form object are listed when you select the object and select . You can view the title and a preview the rule summary. Furthermore, the UI lets you expand and view the complete rule summary, change the order of rules, edit rules, and delete rules.

List-rules

You can perform the following actions on rules:

Expand/Collapse: The Content column in the rule list displays the rule content. If the entire rule content is not visible in the default view, select to expand it.
Reorder: Any new rule you create is stacked at the bottom of the rule list. The rules are executed from top to bottom. The rule at the top executes first followed by other rules of the same type. For example, if you have When, Show, Enable, and When rules at first, second, third, and fourth positions from top, respectively, the When rule at the top gets executed first followed by the When rule at the fourth position. Then, the Show and Enable rules are executed.
You can change the order of a rule by tapping against it or drag-drop it to the desired order in the list.
Edit: To edit a rule, select the check box next to the rule title. Options to edit and delete the rule appear. Select Edit to open the selected rule in the rule editor .
Delete: To delete a rule, select the rule and select Delete.
Enable/Disable: When you must suspend usage of a rule temporarily, you can select one or more rules and select Disable in the Actions toolbar to disable them. If a rule is disabled, it does not execute at the runtime. To enable a rule that is disabled, you can select it and select Enable in the actions toolbar. The status column of the rule displays whether the rule is enabled or disabled.

Disable rule

Copy-paste rules

You can copy-paste a rule from one field to other similar fields to save time.

To copy-paste rules, do the following:

Select the form object from which you want to copy a rule, and in the component toolbar select . The rule editor user interface appears with the form object selected and the existing rules appear.

For information about managing existing rules, see Manage rules.
Select the check box next to the rule title, options to manage the rule appear. Select Copy.
Select another form object to which you want to paste the rule and select Paste. Further, you can edit the rule to make changes in it.

NOTE
You can paste a rule to another form object only if that form object supports the copied rule’s event. For example, a button supports the click event. You can paste a rule with a click event to a button but not to a check box.
Select Done to save the rule.

Nested expressions

Rule editor lets you use multiple AND and OR operators to create nested rules. You can mix multiple AND and OR operators in rules.

Following is an example of a nested rule that displays a message to the user about eligibility for a child’s custody when the required conditions are met.

Complex expression

You can also drag-and-drop conditions within a rule to edit it. Select and hover over the handle ( ) before a condition. Once the pointer turns into the hand symbol as shown below, drag and drop the condition anywhere within the rule. The rule structure changes.

Drag-and-drop

Date expression conditions

Rule editor lets you use date comparisons to create conditions.

Following is an example condition that displays a static text object if the mortgage on the house is already taken, which the user signifies by filling up the date field.

When the date of mortgage of the property as filled in by the user is in the past, the Adaptive Form displays a note about the income calculation. The following rule compares the date filled in by the user with the current date and if the date filled in by the user is earlier than the current date, the form displays the text message (named Income).

Date expression condition

When filled date is earlier than the current date, the form displays the text message (Income) as following:

Date expression condition met

Number comparison conditions

Rule editor lets you create conditions that compare two numbers.

Following is an example condition that displays a static text object if the number of months an applicant is staying at current address is less than 36.

Number comparison condition

When the user signifies living at the present residential address for less than 36 months, the form displays a notification that more proof of residence can be requested.

More proof requested

Example rules

Invoke Form Data Model service

Consider a web service GetInterestRates that takes loan amount, tenure, and applicant’s credit score as input and returns a loan plan including EMI amount and rate of interest. You create a Form Data Model (FDM) using the web service as a data source. You add data model objects and a get service to the form model. The service appears in the Services tab of the form data model (FDM). Then, create an Adaptive Form that includes fields from data model objects to capture user inputs for loan amount, tenure, and credit score. Add a button that triggers the web service to fetch plan details. The output is populated in appropriate fields.

The following rule shows how you configure the Invoke service action to accomplish the example scenario.

Example-invoke-services

NOTE

If the input is of array type, the fields that support arrays are visible under the Output drop-down section.

Triggering multiple actions using the When rule

In a loan application form, you want to capture whether the loan applicant is an existing customer or not. Based on the information user provides, the customer ID field should show or hide. Also, you want to set focus on the customer ID field if the user is an existing customer. The loan application form has the following components:

A radio button, Are you an existing Geometrixx customer?, which provides Yes and No options. The value for Yes is 0 and No is 1.
A text field, Geometrixx customer ID, to specify the customer ID.

When you write a When rule on the radio button to implement this behavior, the rule appears as follows in the visual rule editor.

When-rule-example

Rule in the visual editor

In the example rule, the statement in the When section is the condition, which when returns True, executes the actions specified in the Then section.

Using a function output in a rule

In a purchase order form, you have the following table, in which users fill in their orders. In this table:

The first row is repeatable, so users can order multiple products and specify different quantities. Its element name is Row1.
The title of the cell in Product Quantity column of the repeatable row is Quantity. The element name for this cell is productquantity.
The second row in the table is non-repeatable and the title of the cell in Product Quantity column in this row is Total Quantity.

Example-function-table

A. Row1 B. Quantity C. Total Quantity

Now, you want to add specified quantities in the Product Quantity column for all products and display the sum in the Total Quantity cell. You can achieve this sum by writing a Set Value Of rule on the Total Quantity cell as shown below.

Example-function-output

Rule in the visual editor

Validating a field value using expression

In the purchase order form explained in the previous example, you want to restrict user from ordering more than one quantity of any product that is priced more that 10000. To do this validation, you can write a Validate rule as shown below.

Example-validate

Rule in the visual editor

recommendation-more-help