Hi Team,

The standard configuration of the Mastersoft Harmony address service does not return all the data we need - we need additional fields to feed to our back end system.

How do I retrieve extra address data using the Mastersoft Harmony package from the Avoka Exchange?

the extra fields we need are:

  • flatUnitType
  • flatUnitNumber
  • floorLevelType
  • floorLevelNumber




    CommentAdd your comment...

    2 answers


      Hey Mark,

      The Mastersoft Harmony package from The Avoka Exchange supports the ability to utilize additional attributes from the raw Mastersoft response in your forms through configuration. The raw Mastersoft response contains a bunch of data elements that we don't use by default:

         "fullAddress":"L 2 Se 202 220 George St, Sydney NSW 2000",
         "street":"George St",
         "subdwelling":"L 2 Se 202",


      To utilise these extra data attributes, locate your Mastersoft Harmony - Address Search service in Transaction Manager and edit the service parameter called extraResultsMap to include the additional fields you want from the Mastersoft response. E.g.


      You can optionally specify a different name to be returned to the form using pipe, for example specifying


      will grab the flatUnitNumber data from the raw Mastersoft response and return it to the form as unitNumber.

      This also allows you to retrieve attributes provided down the hierarchy in the raw Mastersoft response. The following will retrieve the DPID attribute from the attributes sub hierarchy and return it to the form as dpid.



      On the form side you will need to add data fields to your address block to accept these additional attributes and map the new response values into these data fields.

      Add your data fields under the Address block within the Mastersoft Address Lookup component:

      On the Data tab for each of these new data fields, ensure you select Include in Submission Data:


      Then click on the Mastersoft Address Autocomplete field and on the Properties tab under DDS Configuration open the Response Field Mappings and add mappings for your new data elements:


      You should then start to see these new attributes coming through in your submission XML so that you can pass it to down stream systems.


      Of course, you can share these changes by creating your own shared component in Maestro so that you don't have to implement these changes each time you add an address lookup to a form.

      1. Mark Murray

        Hi Ben, thanks for all that detail, plenty to digest. I have created a custom component for our address block, so I'll incorporate some of the above features to get the data aligned with our back end system structure and nomenclature. Thanks Mark

      CommentAdd your comment...

      Hi Ben,

      I have imported the service into TM, now I need to import the component Mastersoft Long Address Lookup in to Maestro as it is not in the current palette.

      I tried importing the widget from the tpac archive, but the format is not correct.

      How do I get the address component in to Maestro?



      1. Ben Warner

        The readme.html file in the TPac should provide installation instructions. Import the entire library zip file to Maestro.

      2. Mark Murray

        Thanks Ben, I misread the instructions; it works now. Thanks

      CommentAdd your comment...