Business Validation using Harmony Batch System

This document provides instructions on utilizing the Harmony batch system for the validation of bulk files using Business Validation PDPs.

The designation of Client Role and Locale within the batch setup indicates the PDP utilized for business validation processes across various geographical contexts.

Pre Reading

Please ensure you have read and understanding the previous configuration steps for Australia and New Zealand.

pageBusiness Validation

Below is the simple illustration of our business validation processing using a small file in New Zealand with Harmony Batch System. A more comprehensive guide detailing the instructions on how to set up a batch job can be checked here Harmony Batch System Cleanse Reference Guide.

Steps to run Batch Job

1. Job Config

It is expected that the customer has configured the Setup NzBusinessValidation PDP prior to executing a batch process.

Log in to HBS UI and select New Cleanse

Select the required Client Role that is attached to the component group that has NzBusinessValidation PDP added.

Select the Locale as New Zealand

Example 1: NZ Cleanse job profile

2. Input

Click Input on the left panel to display the Input Reader panel. There are seven tabs in this panel, each with its own set of fields.

Refer Page No 14 of the Harmony Batch System Cleanse Reference Guide to get an idea on how to configure the Input file for batch processing.

Quick configuration on how to configure an input file that consists of the fields below is provided here.

Input File: File comprises of Id, Input business number or company number, Input Company Name.

Example 2: NZ Mock Input with intentional errors

General panel

Choose your input file and correct configuration for your business file.

Full description of the panel is within Harmony Batch System Cleanse Reference Guide.

Detail Record panel

Ensure you correctly check the details versus your input file.

Full description of the panel is within Harmony Batch System Cleanse Reference Guide.

Baseline Fields panel

Very important step as this information forms part of the Logical Record mapping between your input file and what the HBS system requires to process.

Auto populate fields: If you have ticked 'first detail record represents baseline fields' then right click on white panel and retrieve the field names. This will auto populate the fields.

Manually enter fields: Type your input column names into the table within the panel.

Full description of the panel is within Harmony Batch System Cleanse Reference Guide.

Logical Record

HBS Logical Record represents the input baseline fields that are mapped to Harmony data models for batch processing.

The left column "Name" is Harmony name representation for a field.

The right column "Generated By" is the Input File name for the field with the same meaning.

For example:

Input business number or company number( Inputbnorcnnumber) from the baseline fields has been mapped to HARMONY_INDIVIDUAL_IDENTIFIER

Input company name (InputCompanyName) from the baseline fields has been mapped to HARMONY_COMPANY_NAME

Input Id is the sequential id from baseline fields, it can be mapped to HARMONY_ID.

Full description of the panel is within Harmony Batch System Cleanse Reference Guide.

Example 3: Mock Logical Record mapping

3. Preprocessor

Not Applicable

4. Output

Harmony Output on the left panel represents the configuration of the output file and the fields to be returned in the output file.

General tab: To configure the file layout specifications.

Field Definition: Defines the fields to be output to the output file.

To add parsed Company name as an output field in the output file, define party.name.companyName

party.CustomAttributes.business_name -->represents validated business name.

party.CustomAttributes.business_bn--> represents validated business number.

Sample text output:

The HBS Output text file may contain multiple denormalized occurrences of the same Input ID, especially when the input includes company names with party relationships. Basically, the number of record occurrences are proportional to the number of identified parties.

In the output, only one occurrence displays the enriched CustomAttributes of the validated entity. However, we can associate the output records with the parsed company name output to track which parsed entity was used for validation and enrichment. Please refer records 3 to 5 in the output for examples.

Example : Complex Output within multiple entity types

5. Exceptions

Please refer to the Harmony Batch System Cleanse System Reference Guide.

6. Report

Please refer to the Harmony Batch System Cleanse Reference Guide.

7. History

Please refer to the Harmony Batch System Cleanse Reference Guide.

Last updated