Hints & Tips
Simplify the requirements and aim for fewer business rules steps.
The business rule name can have up to 50 characters. If the name is too long, the first few characters will be omitted. This similarly applies to the naming of functions within business rules. Note: when copying elements or entire business rules, the word '(Copy)' will be added to the end of the existing name.
It is recommended that the column name that will be used in the data table matches the naming of the fields in the system to aid the creation of the business rules.
Example:
Equus Platform Field Name
|
|
|
Host Family Size
|
Family Size
|
Host Family Size
|
Data Table Value/Column Name
|
|
|
Host Family Size
|
HFS
|
Host Family Size
|
Documenting what you are trying to achieve with the business rule before building the rule is advised. Having a clear understanding of what you are trying to achieve will enable you to build a more efficient rule.
In Configuring Business Rules, we recommend:
Utilize the BR Additional Info section, you may add the link to the requirements and the step-by-step business rule logic for easy reference.
When a function/table lookup is required for a Business Rule, first check to see if the function/table lookup already exists. Whenever you need to make changes, make sure to copy the function and not edit the original.
In creating new functions/table lookups, have a naming convention that is easy to understand, i.e. what the function/table lookup is all about (example for CDR lookup: "CDR - XXXX")
Be consistent
No duplication
Design
Business rules use If-Then-Else statements. If-Then-Else statements are used to define the actions that should be taken if a certain condition is met or not.
Example 1: If the assignment policy is long-term, the bonus is 10,000 USD, but if it is not, the bonus is 2,000 USD.
If-Then-Else statement:
Step
|
Step Name
|
If
|
Then
|
Else
|
1
|
Policy Check
|
Policy = Long-Term Assignment
|
Relocation Bonus: 10,000 USD
|
Relocation Bonus: 2,000 USD
|
Example 2: If the assignment policy is long-term, the bonus is 10,000 USD, however if the policy is a short-term assignment, the bonus is 5,000 USD. If the assignment policy does not fall within the first two categories, the bonus is 2,000 USD.
If-Then-Else statement:
Step
|
Step Name
|
If
|
Then
|
Else
|
1
|
Policy Check
|
Policy = Long-Term Assignment
|
Relocation Bonus: 10,000 USD
|
Proceed to next step
|
2
|
Policy Check
|
Policy = Short-Term Assignment
|
Relocation Bonus: 5,000 USD
|
Relocation Bonus: 2,000 USD
|
Structure your data table according to how you want your business rule to be built. For instance, developing a business rule for housing allowance based on either of the following:
Data Table 1 (Checking policy, accommodation type, the civil/marital status plus the family data)
Policy
|
Accommodation Type
|
Single
(in USD)
|
Married
(in USD)
|
Married +1
(in USD)
|
Long-Term Assignment
|
Furnished
|
1000
|
2000
|
2500
|
Long-Term Assignment
|
Unfurnished
|
1000
|
2000
|
3000
|
Data Table 2 (Checking policy, accommodation type and the host family size)
Policy
|
Accommodation Type
|
Host Family Size
|
Amount
(in USD)
|
Long-Term Assignment
|
Furnished
|
1
|
1000
|
Long-Term Assignment
|
Furnished
|
2
|
2000
|
Long-Term Assignment
|
Furnished
|
3
|
2500
|
Long-Term Assignment
|
Unfurnished
|
1
|
1000
|
Long-Term Assignment
|
Unfurnished
|
2
|
2000
|
Long-Term Assignment
|
Unfurnished
|
3
|
3000
|
Documentation
1. Create a confluence or documentation page to have a centralized location of relevant information for the process, which should include the following:
Policy
Module
Gross vs Net
Frequency
Proration
Data Tables
a. Properties Table - contains all the important data for the business rule calculation
Example:
Example of a Housing Allowance Calculation:
Host Country Code
(using 3 digit codes)
|
Policy
|
Accommodation Type
|
Family Size
|
Amount
|
Effective Date
|
Inactive
|
USA
|
Long Term Assignment
|
Furnished
|
3
|
35000 USD
|
01-01-2023
|
No
|
CAN
|
Long Term Assignment
|
Furnished
|
2
|
25000 USD
|
01-01-2023
|
No
|
b. Calculation
Summary - overview and purpose of the calculation
Detailed Requirements
Condition - set of rules to met to perform the calculation
Data Table - contains the data points and expected outcome
Variables - what is the input needed for the calculation and where it will come from
Example:
Input
|
Origin
|
Assumptions
(Cost Estimate/Cost Calculation/Authorization/What-If Cost Estimate)
|
Policy
|
Assignment Relocation Policy
|
For Cost Estimate: get the value from the Authorization if Assignment level policy is ‘Candidate’
|
Host Country Code
|
Assignment: To Country
|
Mandatory field
|
Accommodation Type
|
Assignment (Custom Field): Accommodation Type
|
|
c. Business Rule Logic - outline of the step-by-step logic
d. Acceptance Criteria - scenario of what is needed to be tested