Rules

To manage rules on the platform, go to the Configuration menu and click on Rules. This section of the platform configuration allows you to create and manage your own rules.

Rule management is restricted to specific roles. If you do not have access to this part of the platform and need to manage rules, please contact your administrator.

Rules list

Rules list

In the rule list screen, you can:

  • Filter the list to view a more restricted list of rules or perform a search.

  • The actions dropdown allows: Select all, Unselect all, Approve, Reject and Delete.

  • Create a new rule with the rule generator. For more details on how to create a new rule, please refer to the section: Rule Creation.

  • Reload the table content by clicking on the Refresh button.

By selecting a specific rule from the list, you can:

  • Display the entire history of the selected rule. All changes made to the rule since its creation are listed with the corresponding dates and the identity of the modifier.

  • View the rule in terms of code.

  • Edit the information of the selected rule.

  • Duplicate the selected rule. All the information of the selected rule is pre-filled in the new rule creation screen except the name which is a unique field.

  • Delete the selected rule. A confirmation dialog will be displayed. This action is final, please perform it with caution.

For each rule to which the user has access, the following is the information available:

  • Id: Internal identifier

To access or copy this identifier, click on the number located in the first column to copy it to the clipboard. You can use it to document issues for example.

  • Rule name: name used to identify the rule.

  • The Type of rule can be:

    • Pre correction - All transaction/file enrichment we can make before payment type, channel, and date default assignment.

    • Payment type - Specific rules to determine transaction payment type.

    • Channel type - Specific rules to determine transaction channel.

    • Post correction - All final transaction/file enrichment.

    • Validation - Validation rules to apply on transactions. If transactions are not valid, there are rejected.

    • Fraud detection - Fraud rules to intercept transactions.

  • Description: short text allowing to summarize the extent of the rule.

  • Organization: organization to which the rule will apply. If the organization column displays SYSTEM, these are system created (and owned) product rules and cannot be edited.

  • Status: status of the rule.

    • Active - the rule is ready to be used.

    • To Review - the rule needs to be approved by another user.

Rule creation

Select the Organization to which the rule will apply and click on Rule Generator.

When creating a new rule, you need to specify all of the following general fields, in each of the three sections:

General information step

Create new rule screen - General information step

  • Give a meaningful Name for your rule.

  • Description: short text to summarize the rule.

  • Specify the Type of the rule.

  • Click the Next button to proceed to the next step.

Rule trigger step

Create new rule screen - Rule trigger step

This step allows you to add conditions to trigger the rule.

  • Trigger Generator:

    • AND or OR toggle: choose which operator you want for an additional condition to your rule.

    • Add condition allows you to go further in the specifics of your rule by adding more parameters. Keep it simple, you can create other rules if you want. The number of trigger conditions is limited to 30.

    • You can click on the trash can next to any rule trigger to remove the condition. You can have 0 trigger conditions.

  • Choose the Parameter type on which you want to apply the rule. The parameter type can be Transaction, Creditor, Debtor, Creditor Agent, Debtor Agent, Forwarding Agent, Initiating Party, Ultimate Creditor, Ultimate Debtor, Ultimate Creditor Agent, Ultimate Debtor Agent, Instructed Agent, Instructing Agent, Instructed Reimbursement Agent, Instructing Reimbursement Agent, Third Reimbursement Agent, Nostro, Vostro, Intermediary Agent 1, File, Organization, Country of Residence and Flow.

  • Choose the Parameter on which you want to apply the rule. The choice of parameter type influences the choices available for the parameter. In addition, if you choose References as the parameter, a new reference drop-down will appear. You can select the reference name in the drop-down or fill in the reference name manually.

  • The Comparator lets you choose the method used to compare the parameter and the value.

  • Enter the Value you want to compare for the selected parameter. The value can be case-sensitive by selecting yes for the Case Sensitive option.

  • Click the Next button to proceed to the next step.

For example, your rule could be: Parameter type: Creditor, Parameter: Name, Comparator: contains (CSV Strings), Value: Demo

This triggers the rule if it encounters a payment where the creditor’s name contains the word Demo such as “Demonstration” or “The Demolition Co.”

Rule consequence step

Create new rule screen - Rule consequence step

This step allows you to add consequences to the rule.

  • Consequence: What the rule will do. Depending on the Field to update type of the rule, it could be something to select, enter, or correct in the selected Field to update.

    • Add field allows you to add multiple fields to update. The number of consequences is limited to 10.

    • You can click on the trash can next to any consequence to remove it. There must be at least 1 consequence for the rule.

  • Choose the Field to update type on which you want the consequence of the rule to apply. Field to update type can be Transaction, Creditor, Debtor, Creditor Agent, Debtor Agent, Forwarding Agent, Initiating Party, Ultimate Creditor, Ultimate Debtor, Ultimate Creditor Agent, Ultimate Debtor Agent, Instructed Agent, Instructing Agent, Instructed Reimbursement Agent, Instructing Reimbursement Agent, Third Reimbursement Agent, Nostro, Vostro, Intermediary Agent 1, File, Organization, and Flow.

  • Choose the Field to update to specify the field that will be updated as a consequence of the rule. The choice of field to update type influences the choices available for the field to update.

  • Select the Type for the field’s value. Type can be String, Number, Copy value from, Current date, and None. If you select Copy value from, you will see a dropdown for Field to set where you can select the field to copy into the Field to update.

  • Enter the Value to set for the field.

You can now press the Create button to create the new rule. It will appear in the list screen, and it will be available when creating your rule set.