Configure Canada Post Autocomplete on Dataverse Forms

Modified on Mon, 22 Jan at 4:59 PM

TABLE OF CONTENTS

Configure Canada Post on Model Driven Forms
Working with Advanced Settings
Assign the required security privileges to users

Configure Canada Post on Model Driven Forms

Considerations for this article

To make the documentation simple, we have chosen to use the Account table with the "Address 1" columns as an example. The configuration is similar of other tables and columns, out of the box or custom.

In the Power Apps Maker Portal, find the solution containing the entities and forms for which you want to configure Canada Post Autocomplete control.
Open the Account table, and find the form you want to use Address Autocomplete on
Open the form you want to edit and click on “Switch to classic” in the command bar
In the classic configuration screen, add the Address Street Line 1 of the form and click on Change Properties in the ribbon to access the Field Properties screen.
In the “Display” area, uncheck the “Display label on form” checkbox
Next go the Controls Tab and add the control named "Sharp XRM - Canada Post Autocomplete" and select the devices where you want the control to be displayed.

Once you have selected the control of your choice, you provide a value for required properties (identified with a * in the table below); all the other properties are not mandatory :

Property	Description	Field Type
API Configuration Name *	This refers to your API Configuration unique record name, as indicated here.	Static Text Value
Advanced Setting ID	If you are using Advanced Control Settings, you need to put the Identifier of your Advance Setting record here.	Static Text Value
Display Address Fields	The control can display the address fields under the address search control. Set the value to YES to display these fields. This is a legacy feature. *We recommend setting the value to NO and displaying individual address fields yourself.*	Single Line of Text
Street *	Column where you want to store the street address.	Single Line of Text
Unit Number	Column where you want to store the Unit or Suite number.	Single Line of Text
City *	Column where you want to store the city.	Single Line of Text
State *	Column where you want to store the state or province name.	Single Line of Text
Zip / Postal Code	Column where you want to store the postal code.	Single Line of Text
Country *	Column where you want to store the country.	Single Line of Text
County	Column where you want to store the county.	Single Line of Text
Full address	Column where you want to store the fully formatted address as a single line of text. Leave empty is you do not need this.	Single Line of Text
Latitude	Not supported for Canada Post Autocomplete.	Floating Point Number
Longitude	Not supported for Canada Post Autocomplete.	Floating Point Number

Known Issue with Microsoft Dataverse early version 9.1 and earlier.

There is a known issue with the Power Platform and Dynamics 365 on early 9.1 versions as well as 9.0 : some of the address field values may not be available for selection as parameters in the form controls - A workaround is described here. You will need to use the XRM Toolbox to achieve this workaround. Alternatively, configuring the control using the "Maker Portal" should provide you with all the compatible values.

Click OK, save the form and publish it.
Open your account and test your control

Working with Advanced Settings

Advanced Control Settings allow administrators to configure additional parameters for the address autocomplete control. These parameters are useful for organizations that require their state or provinces to be captured in a specific format. For example, if ISO2 country codes are required, it can be specified in the advanced settings.

To get started, find the Advanced Settings by navigating to the Address Validation for Power Apps application and select the “Address Control Settings” menu. Click + New to create a new record.
Set the required values
- Identifier : Unique Identifier of the Setting. This will be used in the control's configuration on the form.
- API Type : Select Canada Post
List of parameters available for Canada Post :

Parameter	Possible Values	Description
State Name	Use Short State Name Use Long State Name	--> QC --> Quebec
Country Display	Use ISO2 Country Code Use ISO3 Country Code *** Use Long Country Name	--> CA --> CAN --> Canada
Enable World	Yes or No	--> When set to yes, the control allow Canada Post Autocomplete to return addresses from other countries

Important Note : these parameters are saved on your end-users' local cache. If you make changes to them, they will need to clear their browser cache for them to be reflected in their usage of Canada Post autocomplete in Dataverse.

Assign the required security privileges to users

Once the configuration is completed, you need to assign the required security roles to your end users to allow them to use the autocomplete controls. Refer to this article for details on how to achieve this.