Loqate, a GBG solution
Loqate

Help Centre   |   Guides   |   Integrations by platform   |   Loqate for Microsoft Dynamics 365

Loqate for Microsoft Dynamics 365

This guide is to help you install the Microsoft Dynamics 365 Plugin. This solution is compatible with the UUI. It enables you to add address lookup across multiple countries, email validation and/or phone validation. 

This document describes the steps required to install the Microsoft Dynamics 365 Plugin for Loqate Capture or Loqate Harmony RightAddress. The Microsoft Dynamics 365 Loqate Plugin is a Power Apps Component Framework (PCF), developed by Mastersoft Group. Mastersoft Group and Loqate are GBG Companies. The plugin utilises either the Loqate Capture product or the Loqate Harmony RightAddress product.

Quick Links:

 

Functionality

The PCF plugin connects the Microsoft Dynamics 365 environment to Loqate Capture and Loqate Harmony RightAddress.

For Loqate Capture it enables a D365 application administrator to configure forms to access:

  • Address Search across multiple countries (including an optional geocode for the address selected based on the Loqate license)
  • Email Validation
  • Phone Validation

For Loqate Harmony RightAddress it enables a D365 application administrator to configure forms to access:

  • Address Search across Multiple countries and AU/NZ chosen Source of Truth (SoT)
  • Email Validation
  • Phone Validation
  • Company name lookup (ASIC Business Register)
  • ABN lookup (ASIC Business Register)


Pre-Requisites

Before installation and configuration, the following pre-requisites are required:


Support

Loqate Capture

  • For support with Loqate Capture configuration contact https://www.loqate.com/resources/support/ or use the chat in the online portal

Loqate Harmony RightAddress


Installing the Microsoft Dynamics 365 Loqate Plugin Package in your D365 environment


A power user with enough privileges must complete the following tasks:

1. Place the downloaded Microsoft Dynamics 365 Loqate Plugin package (.zip) into a folder on your machine

2. Log onto your D365 environment

3. Click on Sales Hub App and open Power Apps


Power Apps


4. Ensure that you have selected the correct environment


Environments


5. Select Solutions from the menu


Solutions


6. Select the Import button, and browse to the downloaded package


Import

 

7. Click Next, then click Import

8. Upon successfully importing the Microsoft Dynamics 365 Loqate Plugin package, you will receive the following dialogue. Press Close.


Successful import


9. The package will now appear in the list of available solutions


Available solutions



Configuring the components


Address lookup

Note: Use 'classic' view for all configuration of the PCF components.

1. Open the form you wish to add the address lookup to and select the field that will be the address input field. You may decide to use an existing field or add a new field. 

Address field


2. Once the field is selected, click "change properties"

3. Click "Controls", and then "Add Control".


Field properties


4. Select Address Lookup Control, and then click "Add"


Add Control

 

Address Lookup Loqate Capture+

Please complete the following fields:

  • Select the Service Name: Loqate
  • API Key – This is your Loqate API Key. Bind it to a static value
  • Country codes: A comma-separated list of ISO2 country codes, e.g. AU, NZ, US. The first one will be the default country for the address lookup.
  • Source of Truth for AU – N/A
  • Source of Truth for NZ – N/A
  • Name - will automatically bind to the address name field. It is the input and cannot be changed.
  • Country – this is the country output mapping field. Map it to the country field address1_country (SingleLine.Text)
  • Line 1 – Map this to address1_line1 (SingleLine.Text)
  • City – Map this to address1_city (SingleLine.Text)
  • State/Territory Map this to address1_stateorprovince (SingleLine.Text)
  • Postcode - Map this to address1_postalcode (SingleLine.Text)
  • Latitude – address1_Latitude
  • Longitude – address1_Longitude
  • Validation Flag – To map this, you must first create a custom field.
  • Validation time stamp - To map this, you must first create a custom field.
  • Endpoint – N/A
  • Select which devices the change will apply
  • Click OK, Save and then publish the changes.

Address Lookup Harmony RightAddress

Please complete the following fields:

  • Select the Service Name: Harmony RightAddress
  • API Key – This has been provided to you by Mastersoft Support. Bind it to a static value
  • Country codes: A comma-separated list of ISO2 country codes, e.g. AU, NZ, US. The first one will be the default country for the address lookup.
  • Source of Truth for AU – Choose either GNAF, AUPAF or AUSOTS. Default is GNAF
  • Source of Truth for NZ – Choose either NZPAF, NZAD or CNAR. Default is NZAD
  • Name - will automatically be bound to the address name field. It is the input and cannot be changed.
  • Country – this is the country output mapping field. Map it to the country field address1_country (SingleLine.Text)
  • Line 1 – Map this to address1_line1 (SingleLine.Text)
  • Line 2 – Map this to address1_line2 (SingleLine.Text). Line 2 will only be populated if an International address.
  • City – Map this to address1_city (SingleLine.Text)
  • State/Territory Map this to address1_stateorprovince (SingleLine.Text)
  • Postcode - Map this to address1_postalcode (SingleLine.Text)
  • Latitude - Map this to address1_Latitude
  • Longitude -Map this to address1_Longitude
  • Validation Flag – To map this, you must first create a custom field.
  • Validation time stamp – To map this, you must first create a custom field.
  • Endpoint – The default for this is Mastersoft’s Production endpoint. Only needs to be configured if wanting to use another environment.
  • Select which devices the change will apply to (Web/Phone/Tablet)
  • Click on OK
  • Click on SAVE
  • Click on Publish

The changes are now live


Email Validation

Note: Use 'classic' view for all configuration of the PCF components.

1. Open the form you wish to add the email validation to and select the field that will be the email input field. You may decide to use an existing field or add a new field.
2. Once the field is selected, click "change properties"
3. Click "Controls", and then "Add Control"
4. Select "Email Validation Control", and then click "Add"

Email Validation Loqate Capture+

  • Select the Service Name: Loqate
  •  API Key – Your API Key
  • Email * - will be automatically defaulted to emailaddress1
  • Loqate Level – sets the minimum level for the email to be determined as Valid, or Green traffic light.
  • Validation Flag, Validation timestamp – A new field must be created for these to be mapped. Select which devices the change will apply to, by modifying the field properties.
  • Click on OK
  • Click on SAVE
  • Click on Publish

The changes are now live.


Email Validation Harmony RightAddress

Enter the following details:

  • Select the Service Name: Harmony RightAddress
  • API Key – Your API Key
  • Email * - will be automatically defaulted to emailaddress1
  • Source of Truth - Choose VE_ALL
  • Loqate Harmony RightAddress Level – This sets the minimum level for the email to be determined as Valid, or Green traffic light.
  • Validation Flag, Validation timestamp – A new field must be created for these to be mapped.
  • Select which devices the change will apply to, by modifying the field properties.
  • Click on OK
  • Click on SAVE
  • Click on Publish

The changes are now live.

When the user tabs out of the field (the field loses focus), the check will occur. The user can see the result by clicking on the traffic light.

 

Phone Validation

Note: All configuration for PCF components must be done using 'classic' view.

1. Open the form you wish the add the phone validation to and select the field that will be the phone input field. You may decide to use an existing field or add a new field. 
2. Once the field is selected, click "change properties"
3. Click "Controls", and then "Add Control"
4. Select "Phone Validation Control", and then click "Add"

Phone Validation Loqate Capture+

Enter the following details:

  • Select the service name: Loqate
  • API Key – Your API Key
  • Phone - will be automatically defaulted to telephone1
  • Country Codes - A comma separated list of preferred ISO2 country codes for phone validation.
  • Validation Flag, Validation timestamp – A new field must be created for these to be mapped.
  • Select which devices the change will apply to, by modifying the field properties.
  • Click on OK
  • Click on SAVE
  • Click on Publish


Phone Validation Harmony RightAddress


Enter the following details:

  • Select the Service Name: Harmony Right Address
  • API Key – Your API Key
  • Phone - will be automatically defaulted to telephone1
  • Country Codes - A comma separated list of preferred ISO2 country codes for phone validation. The default value is AU, NZ
  • Validation Flag, Validation timestamp – A new field must be created for these to be mapped.
  • Endpoint - Default is Production
  • Select which devices the change will apply to, by modifying the field properties.
  • Click on OK
  • Click on SAVE
  • Click on Publish

The changes are now live.

When the user tabs out of the field (the field loses focus), the check will occur.


Company Name Lookup Harmony RightAddress

  1. Open the form you wish to add the Company Name lookup to and select the field that will be the Company Name input field. You may decide to use an existing field or add
    a new field.
  2. Once the field is selected, then click “change properties”
  3. Click Controls, and then Add Control.
  4. Select Company Name Lookup Control, and then click “Add”
  5. Please complete the following fields:
  • API Key – This is your Harmony API Key.
  • Company Name – This is the input field name and will be automatically populated.
  • ABN Number - bind this to new_abn
  • ACN Number – bind this to new_acn
  • Validation flag, and timestamp - A new field must be created for these to be mapped.


ABN Company Lookup Harmony Right Address

  1. Open the form you wish to add the ABN lookup to and select the field that will be the ABN input field. You may decide to use an existing field or add a new field.
  2. Once the field is selected, then click “change properties”
  3. Click Controls, and then Add Control.
  4. Select ABN Lookup Control, and then click “Add”
  5. Please complete the following fields:
  • API Key – This is your Harmony API Key.
  • ABN Number – This is the input field name and will be automatically populated.
  • Company Name - bind this to new_companyname
  • ACN Number – bind this to new_acn
  • Validation flag, and timestamp - A new field must be created for these to be mapped.

Take a trial - no obligation, full support Get started