Defining a Rule

Prerequisites

To define a rule, you should have:

  • Rule types defined in the application

  • Pre-processing and post-processing algorithms, dependent rules, and parameters defined in the application in case you want to use any of them

Procedure

To define a rule:

  1. Click the Admin link in the Application toolbar.
    A list appears.
  2. From the Admin menu, select R and then click Rule.
    A sub-menu appears.
  3. Click the Add option from the Rule sub-menu.

    The Rule screen appears. It contains the following fields:

    Field Name Field Description Mandatory (Yes or No)
    Rule Used to specify the rule code. Yes
    Rule Type Used to specify the type of rule. Yes
    Description Used to specify the description for the rule. Yes
    Rule Priority Used to specify the priority of the rule.
    Note: You cannot define two rules with the same rule type and priority in the same duration.
    		 Yes
    Effective Start Date Used to specify the date from when the rule is effective. Yes
    Effective End Date Used to specify the date till when the rule is effective.
    Note: The effective end date cannot be earlier than the effective start date.
    		 No
    Pre-Processing Algorithm Used to specify the algorithm that will be triggered before executing the criteria in the rule. It pre-processes the input parameters and then returns processed values against which the criteria is validated.
    Note:

    The Search (The Search Icon) icon appears corresponding to this field. On clicking the Search icon, the Algorithm Search window appears.

    On specifying the algorithm, the description of the algorithm appears corresponding to the Pre-Processing Algorithm field.

    		 No
    Post-Processing Algorithm Used to specify the algorithm that will be triggered when the rule is true. It post-processes the output parameters and returns the updated values to the calling programs or dependent rules.
    Note:

    The Search (The Search Icon) icon appears corresponding to this field. On clicking the Search icon, the Algorithm Search window appears.

    On specifying the algorithm, the description of the algorithm appears corresponding to the Post-Processing Algorithm field.

    		 No
    Rule True Action Used to indicate what should happen when all conditions in the rule are satisfied and returns Rule is True. The valid values are:

    • Next Dependent Rule - Used to indicate that the dependent rule should be executed when the rule is true.

    • Next Rule by Priority - Used to indicate that the rule of the same rule type having lower priority should be executed when the rule is true.

    • Success - Used to indicate that no more rules should be executed when the rule is true. The output parameters and their values are returned to the calling programs.

    		 Yes
    Dependent Rule Used to specify the next dependent rule that must be executed when Next Dependent Rule is selected from the Rule True Action list. Yes (Conditional)
    Note: This field is required when you select Next Dependent Rule from the Rule True Action list.
    Rule False Action Used to indicate what should happen when any of the criteria in the rule is not satisfied and returns Rule is False. The valid values are:

    • Next Dependent Rule - Used to indicate that the dependent rule should be executed when the rule is false.

    • Next Rule by Priority - Used to indicate that the rule of the same rule type having lower priority should be executed when the rule is false.

    • Success - Used to indicate that no more rules should be executed when the rule is false. The output parameters and their values are returned to the calling programs.

    		 Yes
    Dependent Rule Used to specify the next dependent rule that must be executed when Next Dependent Rule is selected from the Rule False Action list. Yes (Conditional)
    Note: This field is required when you select Next Dependent Rule from the Rule False Action list.

    In addition, it contains the following two sections:

    • Rule Output Parameters - Used to specify the output parameters that must be returned to the calling programs or dependent rules when all conditions in the rule are satisfied. This section contains the following columns:

      Column Name Column Description Mandatory (Yes or No)
      Parameter Name Used to specify the parameter.
      Note: For more information about the output parameters that you can specify while defining a rule, see Transaction Validation and Initial Price Item Determination (Specific to Financial Services Domain).

      The Search (The Search Icon) icon appears corresponding to this field. On clicking the Search icon, the Search Input or Output Parameter window appears.

      On specifying the parameter, the parameter description appears corresponding to the Parameter Name field.

      		 Yes
      Parameter Value Used to specify the value for the parameter.
      Note: You can specify any special characters except ampersand (&), comma (,), underscore (_​), equal to (=), tilde (~), and semi-colon(;) in the parameter value.
      		 Yes

    • Criteria - Used to define criteria for the rule. This section contains the following columns:

      Column Name Column Description Mandatory (Yes or No)
      Sequence Number Used to indicate the order in which the criteria should be executed in the rule. Yes
      Parameter Name Used to indicate whether you want to specify a field or an algorithm as an input parameter. The valid values are:

      • Field

      • Algorithm

      Note:

      By default, the Field option is selected.

      If a business label is defined for a user defined field (that you have selected), the business label appears in the Parameter Name field.

      If the parameter name is selected as ... Then...
      Field

      The Search (The Search Icon) icon appears corresponding to this field. On clicking the Search icon, the Search Input or Output Parameter window appears.

      On specifying the field, the field description appears corresponding to the Parameter Name field.
      Algorithm

      The Search (The Search Icon) icon appears corresponding to this field. On clicking the Search icon, the Algorithm Search window appears.

      On specifying the algorithm, the algorithm description appears corresponding to the Parameter Name field.
      		Yes
      Operator Used to specify the relational operator to define the relation between the parameter name and value. Yes
      Parameter Value Used to specify the parameter value. The valid values are:

      • Field

      • Algorithm

      Note:

      By default, the Field option is selected.

      You can specify any special characters except ampersand (&), comma (,), underscore (_​), equal to (=), tilde (~), and semi-colon(;) in the parameter value.

      If the parameter value is selected as ... Then...
      Field

      The Search (The Search Icon) icon appears corresponding to this field. On clicking the Search icon, the Search Input or Output Parameter window appears.

      On specifying the field, the field description appears corresponding to the Parameter Value field.
      Algorithm

      The Search (The Search Icon) icon appears corresponding to this field. On clicking the Search icon, the Algorithm Search window appears.

      On specifying the algorithm, the algorithm description appears corresponding to the Parameter Value field.
      		Yes
      Is True Used to indicate what should happen when the condition is true (satisfied). The valid values are:

      • Check next condition - Used to indicate that the condition with consecutive sequence number should be executed.

      • Rule is false - Used to indicate that the action specified in the Rule False Action field should be executed.

      • Rule is true - Used to indicate that the action specified in the Rule True Action field should be executed.

      		 Yes
      Is False Used to indicate what should happen when the condition is false (not satisfied). The valid values are:

      • Check next condition - Used to indicate that the condition with consecutive sequence number should be executed.

      • Rule is false - Used to indicate that the action specified in the Rule False Action field should be executed.

      • Rule is true - Used to indicate that the action specified in the Rule True Action field should be executed.

      		 Yes
      Is Insufficient Used to indicate what should happen when the data is insufficient. The valid values are:

      • Check next condition - Used to indicate that the condition with consecutive sequence number should be executed.

      • Rule is false - Used to indicate that the action specified in the Rule False Action field should be executed.

      • Rule is true - Used to indicate that the action specified in the Rule True Action field should be executed.

      		 Yes
    Tip: Alternatively, you can access the Add Rule screen by clicking the Add link in the upper right corner of the Search zone in the Rule screen.
  4. Enter the required details.
    Note:

    You can search for a parameter, dependent rule and an algorithm by clicking the Search (The Search Icon) icon corresponding to the respective field.

    If you want to associate more than one output parameter with the rule or define more than one criteria for the rule, click the Add (The Add Icon) icon and then specify the details. However, if you want to remove an output parameter or a criteria from the rule, click the Delete (The Delete Icon) icon corresponding to it.

  5. Click Save.
    The rule is defined.

Related Topics

For more information on... See...
Rule screen Rule
Search zone Search Rule