Loqate Harmony Documentation
  • GBG Loqate AU & NZ
  • Loqate Harmony API
    • Sign up for free trial
    • Login
    • API Specification
      • Authentication
      • Address
        • Address Validation & Lookup
        • Address by Geocode
        • Address Cleanse
        • Address Parse
        • Geocode Intl
      • Address Insights
        • Australian Insights
          • SEIFA Australia
          • ASGS Australia Statistical Geography Standard
          • Residential / Commercial
          • Deliverable address
      • Suburb Lookup
      • Business Validation and Lookup
      • Email Validation
      • Phone Validation
      • Matching
      • Moved Suppression
      • Deceased Suppression
      • Objects
        • Address Objects
        • Address Type Objects
        • Suburb Objects
        • Parse Objects
        • Email Objects
        • Phone Objects
        • Property Title Objects
        • Match Objects
        • Business Objects
      • Deprecated API services
        • Email Validation v1.1
        • Address v1
        • Address Cleanse v1
        • Address International
        • Address Combined
        • Address Types
    • Guides
      • Best Practices
        • Address Field Mappings
        • Finding an Address
      • User Derived Address
      • Expanded sub-premise reach
      • Parcel Locker Plus
      • Migrating to Address V2
      • Sign up/ Login
      • Support
      • Console
        • Getting your API keys
        • Getting Started
        • Add a Service
        • Dashboard
        • Subscriptions
          • Features
          • Users
          • Subscribed Plans
          • Allowlisting domains
          • Blocklist - Email Validation
        • Reports
        • Invoices
          • Paying Invoices
      • API Latency
    • Demos
      • How to use our demos
      • Address Validation Demo
      • Address by Geocode (Reverse Geocode) Demo
      • Address Cleanse Demo
      • Address Parse Demo
      • Business Validation Demo
      • Email Validation Demo
      • Phone Validation demo
    • Integrations
      • Client Libraries
        • Javascript Library v2.1.0
      • Adobe Commerce (Magento 2) Plugin
        • Magento2 User Guide
      • Woocommerce Plugin
        • Woocommerce Install Guide v2.0.0
        • Woocommerce Settings guide v2.0.0
      • Shopify Plus App
      • Gravity Forms
      • Voxco Survey Software
      • Salesforce CRM
      • Dynamics 365 CRM
      • Batch App - Lightweight
      • Deprecated Integrations
        • Harmony RightAddress c# example
        • Harmony RightAddress cURL example
        • Deprecated JS Library v2.0.1
        • Deprecated JQuery Library v1.8.1
    • Coverage
    • Address Exchange (Beta)
      • ADX Console
        • Searching Addresses in console
        • Create Address in console
        • Create Actions in console
      • ADX API Specification
        • Create Address
        • Get Address
        • Create Address Event
        • Edit Address Event
        • Create/Edit Address Attributes
        • Create/Edit Address Geopoint
        • Get Source Events
      • Reserved Attributes
    • GBG Status
  • Batch / Bulk Data Services
    • Serviced Batch
      • Bulk Address Cleanse
      • Email Serviced Batch
      • Phone Serviced Batch
      • Business Serviced Batch
  • Harmony Suite
    • Harmony Suite Overview
    • Release Notes
      • Version 3.0.0
        • New Features
        • Enhancements
        • Bug Fixes
        • Supported Platforms
    • User Guides
      • Version 3.0.0
        • Welcome to Harmony Suite
        • Glossary of terms
        • Upgrades
          • HSQL Upgrade
        • Email and Phone Validation
          • Prerequisites
          • Phone and Email PDP Configuration Setup
          • Phone Validation using Harmony Batch System
          • Phone Validation using Harmony WS
          • Email Validation using Harmony Batch
          • Email Validation using Harmony WS
          • Guides
            • Understanding Phone Data
            • Understanding Email Data
        • Business Lookup and Validation
          • Prerequisites
          • Business Lookup
          • Business Validation
            • Business Validation using Commercial Name Parser
            • Business Validation Configurations
            • Business Validation using Harmony Batch System
            • Business Validation using Harmony WS
          • Business data update guide
          • Guides
            • Understanding Business Data
            • Understanding Business Verification Code
            • Name Parse Ambiguity
        • Australia Post Parcel Locker Plus Lookup and Validation
          • Prerequisites
          • Australia Post Parcel Locker Plus Lookup
          • Australia Post Parcel Locker Plus Validation
            • PDP Configuration Setup
            • AupostValidation using Harmony Batch System
            • AupostValidation using Harmony WS
          • Guides
            • Knowledgebase Lexical Update
            • Understanding Australia Post Parcel Locker Plus Data
            • Interchangeable terms for Australia Post Parcel Lockers
        • Installation and Upgrade Reference Guide
        • Locate Reference Guide
        • Extensions Reference Guide
        • RealTime Reference Guide
        • Postmaster Reference Guide
        • Rapid Address ANZ Reference Guide
        • Post ANZ Reference Guide
        • Source of Truth Installation Reference Guide
        • Knowledgebase Configuration Reference Guide
        • Web Services Reference Guide
        • Management Console Reference Guide
        • Batch System Match Reference Guide
        • Batch System Cleanse Reference Guide
  • More from GBG
    • GBG GreenID
    • GBG Identity
    • GBG Fraud & Compliance
Powered by GitBook
On this page
  • Pre Reading
  • Steps to run Batch Job
  • 1. Job Config
  • 2. Input
  • 3. Preprocessor
  • 4. Output
  • 5. Exceptions
  • 6. Report
  • 7. History
  1. Harmony Suite
  2. User Guides
  3. Version 3.0.0
  4. Business Lookup and Validation
  5. Business Validation

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.

PreviousBusiness Validation ConfigurationsNextBusiness Validation using Harmony WS

Last updated 1 year ago

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.

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 .

Steps to run Batch Job

1. Job Config

It is expected that the customer has configured the 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.

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.

Detail Record panel

Ensure you correctly check the details versus your input file.

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.

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.

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

6. Report

7. History

Refer Page No 14 of the to get an idea on how to configure the Input file for batch processing.

Full description of the panel is within .

Full description of the panel is within .

Full description of the panel is within .

Full description of the panel is within .

click on to open the Logical field creation window and then select the input baseline fields the user wish to see in the output file, click Done. The selected field will then be added to the Name column.

To add the Output fields from NzBusinessValidation PDP to be shown in the output file, click on to add party.CustomAttributes.fieldname

Please refer to the .

Please refer to the .

Please refer to the .

Harmony Batch System Cleanse Reference Guide
Harmony Batch System Cleanse Reference Guide
Harmony Batch System Cleanse Reference Guide
Harmony Batch System Cleanse Reference Guide
Harmony Batch System Cleanse Reference Guide
Harmony Batch System Cleanse System Reference Guide
Harmony Batch System Cleanse Reference Guide
Harmony Batch System Cleanse Reference Guide
Business Validation
Harmony Batch System Cleanse Reference Guide
Setup NzBusinessValidation PDP