Configure Rules for an eForm

To configure rules for an eForm, do the procedure in this topic.

Figure: eForm Rule Builder screen

eForm Rule Builder screen

Video: Form Designer Overview

Video: eForm Builder Interface

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

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

Procedure

  1. On the Rule Builder screen, in the Form Event field, select when the rules run.
  2. Do one of these:
    • If the rules run when the form loads or before the form data is submitted, do this procedure:
      1. Select when the rule applies in the form.
        Field NameDefinition

        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:
      2. Drag a form control from the Fields field to the rule screen.
      3. In the Comparer field, select the operator to compare the values in your rule.
        Field NameDefinition

        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:
      4. In the Rule Value field, enter the value to compare, or drag a process data variable from the Process Data screen.
      5. (Optional) Click Add Condition Add Condition icon to add more than one condition.
      6. Drag an action from the Actions list to the Then field.
      7. Select a form control where you want to apply the specified action, or run a JavaScript method.
      8. Complete these fields as necessary.
        Field NameDefinition

        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]
    • If the rules run when the form user submits the form, do this procedure:
      1. Select when the rule applies in the form.
        Field NameDefinition

        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:
      2. Drag a form control from the Fields field to the rule screen.
      3. In the Comparer field, select the operator to compare the values in your rule.
        Field NameDefinition

        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:
      4. In the Rule Value field, enter the value to compare, or drag a process data variable from the Process Data screen.
      5. (Optional) Click Add Condition Add Condition icon to add more than one condition.
      6. Complete this field as necessary.
        Field NameDefinition

        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:
    • If the rules run after the user submits the form, do this procedure:
      1. Select when the rule applies in the form.
        Field NameDefinition

        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:
      2. Drag a form control from the Fields field to the rule screen.
      3. In the Comparer field, select the operator to compare the values in your rule.
        Field NameDefinition

        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:
      4. In the Rule Value field, enter the value to compare, or drag a process data variable from the Process Data screen.
      5. (Optional) Click Add Condition Add Condition icon to add more than one condition.
      6. Complete this field as necessary.
        Field NameDefinition

        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: