Harmony Release Notes

Here you will find information on the major features for each new product release. For a more detailed schedule of features and functions contact us.


  • Exposing of position field in both address lookup and cleanse address functionalities.
    • Additional fields added to determine address match level (i.e. point, street or locality level).
  • Introduction of unknown field in Cleanse API.
    • Additional field added for unknown characters.
      In example; “XYZ 220 George Street, Sydney, 2000”
      The additional fields would allow the “XYZ” to be saved for potential further use.
  • Allow date range filtering in Self-Service portal dashboard.
    • Allowing customer for a better search functionality within the Self-Service portal by filtering using date range.
  • Introduction of Angular JS sample client to return individual address elements.
    • New sample client for customers who are using Angular JS when integrating Harmony Hosted
  • Improvement of order of results for ‘PO BOX 1111’ when using combined PAF and GNAF lookup.
    • When providing the results of a combined PAF and GNAF lookup (eg. PO BOX 1111 is now shown higher in the results than PO BOX 1112)

Issue resolution

  • NZ Floor Level Type and NZ Floor Level Number values are introduced in the response.
    • For address “Level 2, 194 Auckland Avenue”  there is only one line for “Level 2”. Now the response splits “Level 2” into “Level” and number “2”.
  • Case conversion is now applied to attribute fields.
    • Attribute fields are additional information related to the address. These fields can now also be case converted if needed.
  • Prevention of timeouts when generating Usage Summary Report from self-service portal.
    • Updated search of historic data that allows no time-outs.

Documentation Updates

  • Inclusion of strictFieldValidation in online Harmony Hosted documentation.
  • Documentation for the feature option standardiseSource is added. This standardises the result based on the chosen address reference dataset.
  • Documentation for company lookup method is updated based on recent changes with the API call.

27 July 2017

New Features

  • Introduction of a reverse lookup feature that enables you to look up an address using persistent identifier such as DPID, GNAF PID and CNAR ID. 
  • Introduction of a configurable option to standardise address components as part of the address output.


  • Postal type, postal number and rural number are now tokenised into separate Postal Number from the Postal Type components, in addition to the current merged value.


PO Box 1213 is tokenised as:
Postal Number:  1213
Postal Type:        PO Box

CMB C1 RD 1 is tokenised as:
Postal Number: C1
Postal Type:        CMB
RD Number:       1


  • GPO Box is now prioritised when entered using the combined PAF and GNAF (i.e. AUSOTS) reference dataset.
  • More relevant matches are now returned when building name and partial address is entered.

Issue Resolution

  • Minor improvements on some self-service console texts and console exception messages.

20 March 2017

New Features

  • Introduction of the new CLEANSE function that accepts full Addresses for parsing, standardisation and validation.
    Enabled for AUPAF, G-NAF and NZPAF validation datasets.
  • A new API for combined Suburb and Postcode lookups.
    This API can also be used to look up either Suburb or Postcode.
  • Introduction of Suburb lookup using the AUSOTS validation data set (the combined AUPAF and G-NAF dataset).
  • Street- and Suburb-level Geocodes are now exposed when a point-level Address match occurs in G-NAF and the Point Geocode is not available.


  • Enhancement of lookup performance for some input combinations.
    “Unit 2 27 Woodville roa ?”
    “Unit 2 27 Woodville road Chester ?”

Issue Resolution

  • Resolution of the issue of singleLineHitNumber parameter not working with AUSOTS.
  • Duplicate Suburb candidate entries during G-NAF Suburb lookup is resolved.
  • Resolution of AUPAF Suburb lookup not working when positionFilter uses ROOFTOP, DOORSTOP, SINGLE as the filter.
  • Resolution of issue related to Sub-Dwelling type presentation being different to the reference dataset in the NZ Locale (NZPAF).
    Search for “Flat 1 99 ABC Street” now returns “Unit 1 99 ABC Street” in the candidate list as expected.

1 December 2015

We are pleased to announce the latest release for Harmony Hosted, 1.7.
Here is a summary of the main features of the 1.7 release.


Rapid Address Filter by Suburb, State or Postcode

For customers who currently use the Australian reference file and use the single line rapid address have now the option to filter by suburb, state or postcode. This feature comes at no extra cost for customers who decide to use this functionality.

Company / ABN Lookup (Australia)

This is a new feature for Harmony Hosted and will be available for all new and current customers. Harmony 1.7 will allow customers to search for the following lookups:

– ABN Lookup (Australia Business Number)
– ACN Lookup (Australian Company Number)
– Company Name Lookup

Various Functional and Non-Functional Improvement

Some performance improvements are introduced in this Harmony Hosted 1.7 release.

To request a detailed copy of the Harmony Hosted 1.7 release notes or to send your valuable feedback, please contact us here.

27 March 2015

Version 1.5.1 of Harmony Hosted contains many new features, improvements and bug fixes. The most important are listed below.

  • All Source of Truth results for the “attributes” field are now available through a single server call
    The Identify server calls have been combined into the single-line address lookup server calls. Only one server call is now required to retrieve all the Attributes from the Source of Truth
  • All PSMA GNAF variables are now visible in the “attributes” field
    All available GNAF Attributes are now included in the single-line address lookup search results.
  • Introduction of ‘Trial’ and ‘Live’ Status values
    Two new values have been introduced to clearly differentiate the status of each customer account.
  • The documentation for the new features is available here.

To request a detailed copy of the Harmony Hosted 1.5.1 release notes or to send your valuable feedback, please contact us here.

29 January 2015

Various Software Enhancements and Fixes      

  • Handled the exception thrown when user stops inputting after the postal type
  • Handled exception when full street type is inputted particularly in NZ component search lookup
  • Resolved duplicated display of street names in NZ component search lookup
  • Handled empty address request for a lookup service
  • Position filter is implemented in Java Script client
  • Implemented limitations such as number of requests and time limits for trial users

Harmony Hosted Administrative Console Enhancements

  • Improved usage summary reporting
  • Provided additional login protection for some critical pages
  • Added paging for usage search to avoid contention
  • Source of Truth values are persisted as part of Identify usages
  • Allowed feature option to handle of multiple features
  • Provided the ability to clone a subscription for easier definition
  • Provided a fixed link to the admin page
  • Handled display of cache statistics

Documentation Changes

  • Fixed some hyperlinks in online documentation

15 August 2014

We are pleased to announce the release of Harmony Hosted 1.4, our Cloud based address data entry facility. It includes the following features and improvements:

  • Separate Street Name and Street Type Fields
    We have added the option to componentise returned addresses for applications that require address components in separate fields. This allows for greater flexibility in the formatting of how an address is presented. For example, street name and street type can now be returned in individual components.This change does not affect customers using the pre-existing summary output fields.
  • Case Conversion
    Customers can now select addresses to be returned in upper, lower or mixed case for both single line and component address lookup. These options can be set globally or in-line per request depending on your needs.
  • Enhanced Search
    The Harmony Hosted algorithm has been enhanced to ensure that address return weightings now favour customer input from left (Street Name) over right (Locality).For example, if a customer searches for:17 Milton Street, Berampore, WellingtonThe term Milton as a Street Name is now given preference over Milton as a Locality during the search session.
  • Auto Scale Balancing
    We have added auto scaling balancing capability to transparently meet peak demands and improve the overall service for our customers.

To request a detailed copy of the Harmony Hosted 1.2 release notes or to send your valuable feedback, please contact us here.

5 May 2014

We have pleasure in announcing Harmony Hosted 1.3, the latest enhancements and improvements to our cloud platform. New features include:

  • Improved backwards-compatibility of the Harmony Hosted JavaScript client, adding support for Internet Explorer 7, 8 and 9.
  • Support for HTTP GET methods for simpler integration and improved performance.
  • Exposure of Barcode number and Barcode Sort Plan (BSP) output. Whereby you can detect the Barcode number and BSP from the DPIDs to assist with bulk mail discounts.
  • Removal of NZ Post “deleted” marked addresses in the NZ PAF data.
  • Extension of filtering by address type (postal or residential) for AU PAF component address lookup (previously restricted to single line addresses).
  • Inline filtering for single line and AU PAF component look up so you can decide what address type you would like returned for each search.
  • Inclusion of building names as part of single-line look up.
  • Support of multiple inputs for verification in one call. For example, you can enter as many emails as you want for verification and they will all be processed in one call.
  • Bug fixes and enhancements.

To request a detailed copy of the Harmony Hosted 1.2 release notes or to send your valuable feedback, please contact us here.

23 January 2014

Last year we released Harmony Hosted, our cloud-based address entry platform. Since then we have been working hard to improve the overall experience for our customers. This week we are releasing Harmony Hosted 1.2.

New features include:

The ability to filter addresses by type when searching in Australia; this allows you to determine what form of address you want returned, whether it be post office boxes or delivery addresses.

A consolidated single-line address lookup for AUPAF and GNAF addresses; enables searches across both Sources of Truth in a single transaction.

The optional removal of LOT information when searching in the GNAF Source of Truth.

Mobile phone and email verification with Sensis TotalCheck (TC); through our partnership with Sensis, you can now validate mobile phone numbers and email addresses using Harmony Hosted. This will improve your front office applications, ID checks, registrations and on-boarding processes. You can read more about this on our Verification product page.
To request a detailed copy of the Harmony Hosted 1.2 release notes or to send your valuable feedback, please contact us here.

9 August 2018

We are pleased to announce Harmony Suite version 2.10, which comprises many new features including the introduction of GNAF Plus and a standalone Harmony Suite Rapid Address demo.

We have made other enhancements and resolved several issues in this release.

1. Introduction of GNAF Plus in Harmony Suite

GNAF Plus is an enriched version of PSMA’s GNAF dataset. In addition to the existing GNAF attributes appended to an address GNAF Plus provides attributes associated with the address based on the 2016 Census Data SEIFA (Socio-Economic indexes for the Areas) from the Australian Bureau of Statistics (ABS). For further information regarding the ABS data please go to http://abs.gov.au/websitebs/censushome.nsf/home/seifa.

2. Country name allocation during parsing

A new PDP (Pluggable Data Processing) module incorporating country name allocation is introduced into this version. This is specifically relevant when processing both Australia and New Zealand addresses in a single instance. The PDP will automatically allocate country name if it is not provided as part of the input.

3. Multiple address lines now available within the cleanse API

In this latest version, users now have the option to expose multiple address lines within the cleanse API response (e.g. address line 1 contains street information, address line 2 contains locality information and so on). This automatically assembles multiple address lines in the response.

4. Harmony Suite licensing update via Console

The Harmony Suite Administration Console has been updated to support software license updates. This provides Harmony admin users with the ability to update the license by just clicking a button.

5. Improved handling of terms in brackets in the input

A new pre-processor has been added to handle terms in brackets and to segregate the terms in another field. Pre-processors are modules built to support the parsing capability.

6. Introduction of local Harmony Suite Rapid Address demo

A stand-alone Harmony Suite Rapid Address demonstration is available within this release. The Rapid Address service is available for organisations that want a ready-made browser-based Rapid Address look-up using their existing Harmony Suite installations.

15 February 2016

We are pleased to announce Harmony Suite version 2.7, which features many new features for address parsing in general and the geocoding of Australian addresses in particular.

We have also resolved several issues and made other improvements to the software.

Geocoding of Australian Addresses 

This release introduces many new features to improve the geocoding of Australian Addresses by adding and enhancing the services below. 

Introduction of a Pre-Processor
Pre-processors are introduced to better prepare input data for the Harmony Parsing service. These Pre-processors, when used in conjunction with semi-structured address mapping and Left to Right KB, will significantly increase parsing rates.

Introduction of Custom Knowledgebase
To achieve higher parse rates and mitigate risks when fine-tuning the Core Knowledge Base (KB), a separate custom KB can now be configured by the user. Any bespoke address lexical / patterns can now be created without impacting the Core KB.

Handling of Semi-component Input
Harmony will now accept semi-component input address structures. This means separated semi-structured input (e.g. Address Line 1, Address Line 2, Suburb, State and Postcode) are now accepted by Harmony for processing in both Harmony Batch and Harmony web services.

Introduction of Address Reformatter
A new tool is introduced in Harmony Web services Style 2 to allow users to reformat the Harmony address output components to a preferred presentation format.

Introduction of PDP Change Policy
PDP results can now be configured to control the persistence of field values pre-or post-PDP processing. This allows users to persist the value from the input or from PDP processing results through all Harmony processing.

Harmony Rapid Address RESTful APIs
Harmony Rapid Address (HRA) for Harmony Suite 2.7 implements RESTful APIs for address search and other related rapid address web service calls.

New Module – Enhanced G-NAF Validation Engine
Users often have the need to modify validation rules or create their own to manage data conditions not handled by standard Harmony HAVE engines. Introducing bespoke rules into standard Harmony validation engines would compromise their integrity and is not permitted for accredited applications such as Australia Post AMAS processing.

New Module – ARCGIS Geocode PDP
A new PDP is introduced to resolve residual below-point matches (including Group, Locality and No matches) from the GNAFValidation PDP.

New Module – GNAF Lookup PDP
The GNAFLookup PDP facilitates the manual review of non-validated records (i.e. GNAF address message attribute is empty) from upstream processing.


  • Increased AU parsing rate with the standard Harmony Locate product
  • Order of HRA SOAP address results enhanced
  • Merged NZHRAWeb with HRA Web
  • HRA Restful API getSimilarAddresses can be filtered by State, Postcode and Suburb
  • The HRA Restful API getSimilarAddresses allows to set State preference
  • Postal type without postal number is now recognized as Postal Type
  • Postal Type and Postal Number without space are now parsed correctly
  • Enhanced rules for Supplementary Locality Table processing
  • Improvements to Ambiguous Locality Match:

a. If there is more than one occurrence of a Locality/State/Postcode combination in the reference data, GNAFHAVE treats it as an ambiguous match and allocates no match, while GNAFValidation provides a Locality match based on the priority rules below:

1. Has Geocode and a gazetted Locality locality_class=’G’ (best case)
2. Only one Locality/State/Postcode combination has geocode
3. Has Geocode and a District Locality locality_class=’D’
4. Has Geocode and a Topographic Locality locality_class=’T’

b. If there is more than one Gazetted Locality with the same Locality/State/Postcode combination, the first Gazetted Locality in the candidate list is returned.

Bug fixes

  • Over-matching of Postcode and State to the G-NAF Locality table is rectified in the new PDP GNAFValidation
  • Supplementary Locality Table PDP is rectified to populate MeshblockID2011 field value in addition to the Mesh block ID field in cases where geocode is obtained from Supplementary PDP
  • Harmony will match the locality name with an entry in the Supplementary Locality Table and return the geocode coordinates for that entry, irrespective of what is entered in other fields (e.g. Place name)
  • Onlooker-like Key generation compress function was added to existing key generation functions
  • Reverse lookup by DPID/G-NAF PID is rectified to obtain the related address
  • Handling of Phantom Address exposure in Rapid Address
  • Rural delivery number exposure in NZHRA Restful response
  • HRA logging configuration is now enabled from Harmony console
  • GNAF Lot number overmatch for ambiguous address rectified
  • KB modification using Tomcat 7 is now working
  • Parsing of NZ Phone number which starts with 022
  • Bells Line of Road and Headlam Road Area are now allocated DPIDs
  • Various AU parsing issues were resolved


14 February 2014

Within just four months of our previous release, we bring you Harmony Suite 2.5. We have worked hard to deliver these updates early this year and to build momentum for our 2014 product roadmap. As with any release, we have corrected some minor bugs for smooth operation. In addition, we have also prioritised requests from clients for new functionality. New features include:

  1. For our New Zealand Postal Address File users, we have implemented a single-line address lookup using the NZPAF source of truth so customers can enter a free-form address search that will return a list of candidates into separated fields
  2. Address filter capabilities by type; this allows our customers to determine what form of address they want returned, whether it be one form or multiple. This includes:
  • Postal – if a postal type exists
  • Doorstop – apartment detail, where secondary information exists
  • Rooftop – with only reference to the building, no sub dwelling detail
  • Single – for houses with no sub dwellings, where no secondary information is available

To request a detailed copy of the Harmony Suite 2.5 release notes or to send your valuable feedback, please contact us here.