Rule Builder screen (eForm Configuration)

Lets you configure rules that specify the behavior of your eForm and it's form controls. You can put one statement inside another statement to create complex logical expressions.

Figure: Rule Builder eForm Configuration screen

Rule Builder eForm Configuration screen

Video: Form Designer Overview

Video: eForm Builder Interface

Video: eForms with SharePoint - Part 3

Examples

  • (Example) Use Rules in a Form Control
  • Advanced Examples

    For more advanced or complex examples or specific information about how to solve a specific business problem or use case, AgilePoint recommends the following resources:

    • AgilePoint Community Forums - A free, AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
    • Video Portal - Video walkthroughs for a range of simple and advanced tasks in AgilePoint NX.
    • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
    • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.

Good to Know

  • Rules have 2 main parts:
    • Condition - The circumstances that trigger the rule. The When section of a rule specifies the conditions. Conditions have 3 parts:
      • Fields - One or more form controls that trigger or give the context for the condition.
      • Comparer - The operator to used to compare the two input values.
      • Rule Value - The value or variable that specifies the context for the rules.
    • Action - The results that occur if the conditions for the rule are true. The Then section of a rule specifies the actions.

How to Start

  1. Open eForm Builder.

    For information about how to open this screen, refer to eForm Builder screen.


    Eform Builder screen
  2. On the eForm Builder screen, click Rules > Rule Builder.

    Click Rule Builder

Fields

Field NameDefinition

Form Event
Description:
Specifies when the rules run in the eForm.
Allowed Values:
  • Load - The rules run when the eForm is loaded.
  • Before Submit - The rules run before the eForm is submitted.
  • Validation On Submit - The rules run when the eForm is submitted.
  • After Submit - The rules run after the eForm is submitted.
Default Value:
Load
Example:
Refer to:

Add Rule

Function:
Lets you to add more than one rule.
Example:
Refer to:

Fields
Description:
Specifies a list of form controls used in your eForm.
Allowed Values:
A list of all the form controls on your eForm.
Default Value:
None
Example:
Refer to:

When
Description:
Specifies when to apply the rule in your eForm.
Allowed Values:
  • All - The rule is applied when all the conditions are met.
  • Any - The rule is applied when any one of the conditions are met.
  • None - The rule is applied when all of the conditions are not met.
Default Value:
All
Example:
Refer to:

Comparer
Description:
Specifies the operator to used to compare the two input values.
Allowed Values:
  • is present
  • is blank
  • is equal to
  • is equal to (Ignore Case)
  • is not equal to
  • is not equal to (Ignore Case)
  • is greater than
  • is greater than or equal to
  • is less than
  • is lesser than or equal to
  • contains
  • contains (Ignore Case)
  • not contains
  • not contains (Ignore Case)
  • matches regex
  • files exist
  • files does not exist
  • does not contain data
  • contains data
  • starts with
  • ends with

The operators available are different for different form controls.

Default Value:
is present
Example:
Refer to:
Limitations:

Rule Value
Description:
The value for the data variable.
To Open this Field:
In Comparer field, select one of these:
  • contains
  • not contains
  • is equal to
  • is not equal to
  • is greater than
  • is greater than or equal to
  • is less than
  • is less than or equal to
Allowed Values:
Default Value:
None
Accepts Variables:
Yes

Add Condition Add Condition icon

Function:
Lets you to add more than one condition.
Example:
Refer to:

Delete Delete icon

Function:
Deletes the condition.
Example:
Refer to:

Then
Description:
Specifies action to take when the rule conditionis met.
To Open this Field:
In Form Event field, do one of these .
  • Select Load.
  • Select Before Submit.
Allowed Values:
  • Hide Control
  • Show Control
  • Execute Script
  • Execute Method
  • Set Minimum Date
  • Set Maximum Date
  • Show Message
  • Set Field Value
  • Enable Control
  • Disable Control
  • Set as Mandatory
  • Set as Not Mandatory
  • Trigger Auto Lookup
Default Value:
None
Example:
Refer to:

Actions
Description:
Specifies the action when the rule condition is met.
To Open this Field:
In Form Event field, do one of these .
  • Select Load.
  • Select Before Submit.
Allowed Values:
  • Hide Control
  • Show Control
  • Execute Script
  • Execute Method
  • Set Minimum Date
  • Set Maximum Date
  • Show Message
  • Set Field Value
  • Enable Control
  • Disable Control
  • Set as Mandatory
  • Set as Not Mandatory
  • Trigger Auto Lookup
Default Value:
None
Example:
Refer to:

Javascript Method
Description:
Specifies the JavaScript method to execute if the rule condition is met.
To Open this Field:
Drag and drop the Execute Method action.
Allowed Values:
Default Value:
None
Accepts Variables:
No

Parameter
Description:
Specifies the parameter of the selected JavaScript method.
To Open this Field:
  1. In the Then field, drag the Execute Method action.
  2. In the Fields list, select a JavaScript method.
Allowed Values:
A valid parameter for the JavaScript function.
Default Value:
The parameter of the JavaScript function which is selected.
Example:
destTextbox, triggerControl, trigger

Field Path
Description:
Specifies the path of the form control nested in a repeatable subform in your eForm to do the action when the rule condition is met.
To Open this Field:
  1. In the Then field, drag one of these actions:
    • Hide Control
    • Show Control
    • Set Minimum Date
    • Set Maximum Date
    • Set Field Value
    • Enable Control
    • Disable Control
    • Set as Mandatory
    • Set as Not Mandatory
  2. In the Fields list, select a Subform form control on your eform.
Allowed Values:
A valid path to a form control in a repeatable subform.
A path ends with one of these:
  • :[this] - Does the action on a particular form control.
  • :[*] - Does the action on all form controls in a repeatable subform.
  • :[Number separated by ;] - Does the action on the specified form controls within a repeatable subform.
Default Value:
The field path of the subform selected.
Example:
  • sbfrm_saveComments/cmnt_SaveComments:[this]
  • sbfrm_saveComments/cmnt_SaveComments:[*]
  • sbfrm_saveComments/cmnt_SaveComments:[1;3]

Conditions Failure Message
Description:
Specifies the message to show if the rule condition is not met during validation.
To Open this Field:
In Form Event field, select Validation On Submit.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to:

Redirect URL
Description:
Specifies the URL to send the form user when the eForm is submitted.
To Open this Field:
In Form Event field, select After Submit.
Allowed Values:
Default Value:
None
Accepts Variables:
Yes
Example:
Refer to: