Creating a Business Rule

Create business rules to filter your incoming data based on your defined rule statements.

To create a business rule, perform the following steps:

1. Navigate to Data Layer > Business Rules from the navigation menu. The Business Rules page displays.
2. Click New Business Rules. The New Business Rules page displays.
3. Provide the following details:
   • Name - Enter a name for the business rule.
   • Description - Enter a description for the business rule
   • ID - Enter a unique ID for the business rule. If you want the system to automatically generate the business rule ID, leave this field blank.
     Note: All fields are optional except for the Name field.
4. In the Helper Schema pane, select an existing data schema from the Select Helper Schema drop-down menu. The selected schema will then be displayed, which will be used as guide on what field names you can use in creating your business rule.
   Note: In case the selected schema has been updated, a warning message will be displayed in the helper schema to notify the user that a new version of the schema is available.
5. In the Business Rule Editor section, create your rule’s statements by providing the following details:
   Note: Click the Expand button by the top-right to expand the Business Rule Editor section.
   • Field Name 1 – Based on your selected data schema, enter the field name to use for comparison with Field Name 2.
   • DataType 1 – This field is automatically provided based on the selected field name.
   • Operator – Select the operator you want to use in comparing the two field names. Note that the list of operators displayed in the drop-down menu is based on the applicable operators for the data type. For more information, refer to the table matrix below:
   • Compare with – Select how you want to compare the data:
     • Value – Input a value for comparison.
     • Field in schema – Select another field defined in the schema to compare with.
   • Field Name 2 – Enter the field name to use for comparison with Field Name 1.
   • DataType 2 – This field is automatically provided based on the Data Type 1 and selected operator. For more information, refer to the table matrix above.
     Note: Click the Reset button beside the Group button to clear all the contents in the statement.
   • Exit Name - Enter the name of the exit port you want the incoming data to be sent after satisfying the statement/s in the rule.
     Note: Exit name must only consist a maximum of 20 alphanumeric characters, underscore, and hyphen.
6. Click the Statement button if you want to add another statement. Note that you can only add a maximum of 10 statements for each rule.
7. Click the Group button if you want to group statements.
8. Click the AND operator if all statements in the rule are needed to evaluate as True for the result to be sent to the Exit Port. Otherwise, click the OR operator if only one statement in the rule must be True.
9. Click the Add Rule button if you want to add another rule, then repeat steps 5-8. Note that you can only have a maximum total of 20 rules for each business rule.
10. Select the Add default exit checkbox if you want to add a default exit, then enter a default exit name for the port where the incoming data will be sent when the rules are not satisfied.
    Note: Results for all rules must be False for the results to be sent to the default exit port.
11. After you have completed adding the rules, click Save Business Rules. A confirmation saying your business rule has been created will be displayed.

Note: When a Business Rule being used by at least one Rules Engine is modified, each Rules Engine needs to be restarted in order for it to use the updated Business Rules. Click here for more details.