This page outlines the details on configuring the Business Validation PDP setup using Harmony Management Console and details on customizing the business configuration file to obtain an optimal match.
Last updated
Note: Refer to the Harmony Reference Guide – Management Console for instructions on using the Console, and understanding its components
This sections Setup AuBusinessValidation PDP and Setup NzBusinessValidation PDP details about PDP setup.
Once logged into the Harmony Management Console, there are two steps:
Select the locale as Australia.
Add the AuBusinessValidation PDP.
From the Configure drop-down menu, select Cleanse Engine.
The Cleanse Engine core configurations panel displays. From the field Default Locale, select AUSTRALIA and hit save configuration button.
From the Configure drop-down menu, select Components.
The Components Configuration panel displays the default component groups. Either select the existing DEMO AU Company Name Group for adding the AuBusinessValidation PDP or create a new component group.
Select the existing DEMO AU Company Name Group and add the PDP as shown below and hit save group button.
Alternatively, the user can create a new component group with a new Client Role for the COMPANY_DATA model and add the PDP to the newly created component group. A comprehensive guide to add a new client role and component group has been provided in Harmony Management Console Reference Guide, refer page no 82 to 84.
Select the locale as NEW_ZEALAND.
Add the NzBusinessValidation PDP.
From the Configure drop-down menu, select Cleanse Engine.
The Cleanse Engine core configurations panel displays. From the field Default Locale, select NEW_ZEALAND and hit save configuration button.
From the Configure drop-down menu, select Components.
The Components Configuration panel displays the default component groups. Either select the existing DEMO NZ Company Name Group for adding the NzBusinessValidation PDP or create a new component group.
Alternatively, if the user wants to add the PDP to a newly created component group with a new Client Role that can be done as follows.
A configuration file has been implemented for Business Validation, allowing customers to customize or adjust the business validation according to their specific needs.
The available parameters for configuration can be set through a YAML file named business_validation_config.yml available in $HARMONY_HOME/config/scrubbing folder.
The parameters are specific to each country. By default, the validation PDPS will utilize the parameters defined for a specific country.
AuBusinessValidation PDP will utilize the default YAML configuration listed under name:au.
NzBusinessValidation PDP will utilize the default YAML configuration listed under name:nz.
scoreThreshold
Default 0.0
Customize to 0.2
scoreThreshold 0.0 means no score filter is set.It is adjustable to fine tune the systems sensitivity to match based on specific requirement.
Score ranges between 0 and 1.
0->represents lowest confidence match
1->represents highest confidence match
For e.g. if scoreThreshold value of 0.2 is set, any business validation match score below this threshold will be considered as an unlikely match, not reliable enough leading to a no match.
taxStatus
Default empty
Customize to ACT
If taxStatus is empty means the input company name is allowed to match against business with different tax status.
Options for taxStatus:
ACT = Active
CAN = Cancelled
NON = None
empty means all
For e.g. taxStatus:ACT means input company name is allowed to match against active business only.
bnStatus
Default ACT
Customize to empty.
If bnStatus is ACT, means the input company name is allowed to match against active business only.
Options for bnStatus:
ACT = Active
CAN = Cancelled
empty means all
For e.g. bnStatus: means input company name is allowed to match against both active and cancelled business names.
nameTypes
Default list for au.
nameTypes:
- "MN"
- "LGL"
- "TRD"
- "BN"
Customized List for au
nameTypes:
- "MN"
- "LGL"
- "TRD"
- "BN"
- "OTN"
nameTypes is a list that allows input company name to match against a list of company names.
nameTypes:
- "MN"
- "LGL"
- "TRD"
- "BN"
list of name types applicable for Australia
MN-->Main Entity name
LGL-->Legal Entity Name (individuals/sole traders)
TRD-->Trading name
BN-->Business name
list of name types applicable for New Zealand
MN-->Main Entity name
TRD-->Trading name
Users have the flexibility to modify the 'nameTypes' list, adding or removing nameTypes as needed, enabling the input company name to be matched against a specific set of names. Refer Example column.
For e.g. Adding an additional nameTypes allows the input to find a match against the other entity names.
rules
Default List
rules:
- "Id"
- "OriginalInput"
- "BeneficiaryName"
- "MainName"
- "TradingName"
Customized List:
- "Id"
-BeneficiaryName"
-"MainName"
-"TradingName"
-"OriginalInput"
Users have the flexibility to modify the order of the rules or remove the rules as per their choice.
A business ID can comprise of Business Number or Company Number.
Company Name can comprise of company or business name.
Example combinations of a Business Inputs are:
Business/Company number and Company Name
Company number only
Company Name only
Company number and Business Trading Name
Trust name including trustee and beneficiaries.
See matching rule list: the priority order for processing the rules would be as follows considering both ID and Company Name as inputs:
rules are a list that defines the sequence in which input businesses are assessed for validation. It follows the order below.
Rule order can be rearranged, some rules can be removed based on user preference.
Default matching rules:
ID
OriginalInput
BeneficiaryName
MainName
TradingName
Please note that the validation stops once a successful match or ambiguous matches are found with any of the rules in the order without proceeding to subsequent rules. If no match with the current rule, then the validation proceeds further with the next subsequent rule.
ID Rule:
ID takes precedence for validation.
ID must exactly match for successful validation.
If an exact match is found on ID, the validation process terminates without going through subsequent rules.
If no match on ID, the validation proceeds with Company Name,following the priority of company names with multiple entities as outlined from Rule 2.
OriginalInput Rule:
Occasionally, parsing failures may occur, resulting in splitting of a single company name input into two entities.
If such splits create valid business entities independently, the "OriginalInput" rule is employed to mitigate ambiguity.
BeneficiaryName Rule:
Beneficiary name is taken precedence over main name and trading name.
MainName Rule:
If no successful match is found with the beneficiary's name, the validation process continues with the main name.
TradingName Rule:
If neither the beneficiary's name nor the main name results in a successful match, the validation process proceeds to the trading name.
Refer Example 1 and 2 for better understanding the structure of a complex company with multiple entities, this example will follow rule 3,4 and 5 for validation.
Example 1
Input Business ID: 43 154 618 498
Input Company Name: Xyz pty ltd as trustee for James Jones trading as Eternal Graphix
ID: 43 154 618 498
Main name: Xyz pty ltd
Trading name: Eternal Graphix
Beneficiary name: James jones
Example 2
Input Company Name: Eternal Graphix trading as Xyz pty ltd as trustee for James Jones
Main name: Eternal Graphix
Trading name: Xyz pty ltd
Beneficiary name: James jones
Once the Business Validation PDP Setup and Business Validation Configuration File Setup is done, the user can then invoke the Business Validation using Harmony Batch System or Business Validation using Harmony WS with the respective Client Role to validate Business names.
rules are a list that defines the sequence in which input businesses are assessed for validation. It follows the order listed in
