Configure Google Autocomplete on Dataverse Forms

Modified on Mon, 22 Jan 2024 at 04:11 PM

This article covers how to setup the Address Validation Google Maps Autocomplete Control on Microsoft Dataverse Model Driven forms. These steps must be done by an administrator or a user with system configuration privileges.


TABLE OF CONTENTS


Configure Google Autocomplete 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 Google 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 - Google Maps 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 :

  • PropertyDescriptionField Type
    API Configuration Name *This refers to your API Configuration unique record name, as indicated here.Static Text Value
    Advanced Setting IDIf you are using Advanced Control Settings, you need to put the Identifier of your Advance Setting record here.Static Text Value
    Display Address FieldsThe 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.

    Note : Google Maps return the street long names by default (e.g. "144 East Broadway Street"). If you want the short street name (e.g. "144 E Broadway St"), see the Advanced Control Settings section.
    Single Line of Text
    Unit NumberColumn where you want to store the Unit or Suite number. 

    Note : Google Maps Autocomplete does not return unit numbers. You can leave this field empty.
    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.

    Note : in North America, the provinces and states are defaulted to their long name. If you want the short 2 letter abbreviation, see the Advanced Control Settings section.
    Single Line of Text
    Zip / Postal CodeColumn where you want to store the postal code.

    Note : Google Maps Autocomplete can return extended zip codes in the USA (commonly referred to as zip+4). See the Advanced Control Settings section for more information.
    Single Line of Text
    Country * Column where you want to store the country. 

    Note : the country is defaulted to its long name. If you want an ISO2 version, see the Advanced Control Settings section. 
    Single Line of Text
    County
    Column where you want to store the county.

    Note :  the Google Maps APIs do not always return the county.
    Single Line of Text
    Full addressColumn 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
    LatitudeColumn where you want to store the latitude.Floating Point Number
    LongitudeColumn where you want to store the longitude.
    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 Google Maps
  • List of parameters available for Google Maps :
ParameterPossible ValuesDescription
Include Extended Postal CodeYes / NoUS Only. Allows to add the +4 section of the zip code when available. 
Street NameUse Short Street Name
Use Long Street Name
--> 4878 E. 18th St.
--> 4878 East 18th Street
State NameUse Short State Name
Use Long State Name
--> NV
--> Nevada
Country DisplayUse ISO2 Country Code
Use ISO3 Country Code ***
Use Long Country Name
--> CA
--> CAN (not available with Google)
--> Canada
*** Country ISO3 is not available with Google Autocomplete. Selecting this value will return the ISO2 Code.  



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 Google autocomplete in Dataverse.


Visual Example in a Model Driven Form



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.




Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article