This article explains how to add the Sharp XRM Azure Maps Autocomplete control to a Microsoft Dataverse model-driven form. These steps must be done by an administrator or a user with system customization privileges.
Configure Azure Maps Autocomplete on a model-driven form
To keep the example simple, we use the Account table and its Address 1 columns. The configuration is the same for other tables and columns, standard or custom.
Before you start, create an API Configuration record for Azure Maps (see Set up your Azure Maps API credentials).
- In the Power Apps Maker Portal, select the environment where Address Validation for Dataverse is installed. Go to Tables > Account > Forms (or open the table from your solution) and open the main form you want to use.
- In the form designer, select the Address 1: Street 1 column. You can also find it with Tree view. In the properties pane, select Hide label.
- In the properties pane, expand Components and select + Component.
- In Add component, select Sharp XRM - Azure Maps Autocomplete. If it isn't listed, select Get more components, add the control, and then select it.
- Configure the control properties described in the table below. For API Configuration Name and Advanced Settings ID, enter a static value. For each address property, select the table column where the value should be stored.
- Under Show component on, select where the control should be used (Web, Mobile, Tablet) and select Done.
- Select Save and publish, then open an account record to test the control.
Control properties
| Property | Description | Value type |
|---|---|---|
| API Configuration Name * | The unique name of your Azure Maps API Configuration record. | Static value |
| Advanced Settings ID | If you use Address Control Settings, the Identifier of your setting record. | Static value |
| Street * | Column to store the street address (number and street name). This is the column the control is placed on. | Single line of text |
| Unit number | Column to store the unit, suite or apartment number, when available. | Single line of text |
| City * | Column to store the city. | Single line of text |
| Municipality | Column to store the municipality, when returned. | Single line of text |
| State * | Column to store the state or province. | Single line of text |
| Zip / Postal code | Column to store the postal code. Azure Maps can return extended US ZIP codes (ZIP+4); see Advanced Settings below. | Single line of text |
| Country * | Column to store the country. The long country name is used by default; for ISO2 or ISO3 codes, see Advanced Settings below. | Single line of text |
| County | Column to store the county, when returned. | Single line of text |
| Full address | Optional column to store the complete formatted address on one line. | Single line of text |
| Latitude | Column to store the latitude. | Floating point number |
| Longitude | Column to store the longitude. | Floating point number |
| Default Country | Country selected when the form opens, as an ISO 3166-1 alpha-2 code (for example US). | Static value |
| Display Countries | Countries users can select, as comma-separated ISO alpha-2 codes without spaces (for example US,CA,MX). Leave empty to show all countries. | Static value |
| Top Countries | Countries pinned to the top of the list, as comma-separated ISO alpha-2 codes (for example CA,US). | Static value |
| Display Address Fields (deprecated) | No longer used. Leave it set to No and add the individual address columns to the form. | Yes / No |
* Required. A Default Country or Top Country must also be listed in Display Countries (when Display Countries is used). If a record's country is not in Display Countries, the value is saved but is not shown in the control.
Working with Advanced Settings
Address Control Settings let administrators control the format of returned values, for example ISO2 country codes or short state names.
- In the Address Validation for Power Apps app, go to Settings > Address Control Settings and select + New.
- Enter a unique Identifier. This is the value you enter in the control's Advanced Settings ID property.
- Set API Type to Azure Maps and choose the parameters below.
| Parameter | Possible values | Description |
|---|---|---|
| Include Extended Postal Code | Yes / No | US only. Adds the +4 extension to ZIP codes when available. If no setting is used, extended postal codes are returned. |
| State Name | Use Long State Name / Use Short State Name | For example, Nevada or NV. |
| Country Display | Use ISO2 Country Code / Use ISO3 Country Code / Use Long Country Name | For example, CA, CAN or Canada. |
Note: Address Control Settings are cached in each user's browser and refresh automatically when the cached copy expires. To apply a change immediately, users can clear their browser cache.
Assign the required security privileges to users
After configuration, assign the required security roles to users so they can use the autocomplete controls. See Assign privileges for users.