Quickstart#

Introduction#

Thousands of businesses trust Melissa’s address verification especially where accuracy, reliability, speed and dependability are concerned. And now Dynamics 365/CE and Power Apps users can enjoy the same awesome solution with Melissa Address Validation.

  • Fix invalid addresses with an USPS CASS and Canada Post SERP-Certified address matching engine for the most accurate results in the industry.

  • Convert addresses into the standardized, consistent format for the local postal authority. Handles addresses for 240+ countries and territories.

  • Speed up data entry with address autocompletion that suggest the proper address as you type.

  • Enrich address data by filling in missing data, convert addresses into precise latitude and longitude coordinates, and other georeferenced data about any validated street address.

Minimum Sytem Requirements#

  • Dynamics 365 (v9.1 and higher)

  • Power Platform (v9.1 and higher)

Activate a 30-day Trial#

This section describes the steps to activate a 30-day trial of Address Validation for Power Apps.

  1. Navigate to the Address Validation for Power Apps application and select the Product License menu.

    ../../_images/sxrm-mavd-trial-application.png
  2. Create a new License.

  3. Select Trial in the License Type field.

  4. Fill out the record with the Company and Contact information.

  5. Once you have filled out the required information, click on Save and then Validate License. This will validate the license information with our license servers (requires access to internet, please be patient as it can take up to a minute to complete).

  6. The read-only fields will populate with data and your product key will be displayed in the Product Key field (please take note of your License Expiration Date).

../../_images/sxrm-mavd-trial-new-license.gif

Setup your Melissa API Key#

This section details the steps to obtain and setup your Melissa API key.

Obtain your Melissa API Key#

  1. To use Melissa’s API with Sharp XRM, you need to get in touch Melissa’s sales team.

  2. Once you have obtained the key from Melissa, move on to the next step.

    • Keep in mind, only the following Melissa APIs integrated with Dataverse:
      • Express Entry

      • Global Address

      • Personator

Setup your Melissa API Key Application Parameter#

  1. In the navigation bar, go to Address ValidationSettingsAPI Configuration.

  2. Create a new record and enter the information as per your configuration.

  3. Provide the information as follows:

    1. API Configuration Name: A unique name for the configuration. This will be used as an input parameter for the Melissa Express Entry autocomplete control (to tell the control which API key to use).

    2. Validation Service Type: Select the address verification API you want to use: Select the Melissa Express Entry.

    3. Service License Key: Enter your corresponding API key.

    4. Is Valid: after the API configuration is created, click the Validate API Key button in the command bar. This action will validate the API key in the background to confirm the key is functional. If the API Key is invalid, you will get an error message on the screen and the value will remain No. If it worked, the value will be set to Yes.

      Warning

      Known Issue: In some cases, you might get an error message at this step.

      Please visit this article regarding the issue, including a workaround to continue.

      ../../_images/sxrm-mavd-key-parameters.png

Configure Express Entry Autocomplete on Model Driven Forms#

  1. In the Power Apps Maker Portal, find the solution containing the entities and forms for which you want to configure Express Entry Autocomplete control.

  2. Open the Account table, and find the form you want to use Address Autocomplete on.

  3. Open the form you want to edit and click on Switch to classic in the command bar.

  4. 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.

  5. In the Display area, uncheck the Display label on form checkbox.

  6. Next go the Controls Tab and add the control named Melissa Data Express Entry Autocomplete and select the devices where you want the control to be displayed.

    ../../_images/sxrm-mavd-configure-field-properties.png
  7. Once you have selected the control, you need to 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.

    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.

    Note: Melissa Express Entry returns the extended zip codes in the USA by default (commonly referred to as zip+4). See the Advanced Control Settings section if you need to disable this features.

    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 or ISO3 format, see the Advanced Control Settings section.

    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

    Column where you want to store the latitude.

    Floating Point Number

    Longitude

    Column where you want to store the longitude.

    Floating Point Number

    Default Country

    When the form is loaded, this country will be selected by default. Enter one country’s ISO 3166-1 alpha-2 code (i.e. US, CA, MX, etc.)

    Static Text Value

    Display Countries

    List of countries that will be available in the user interface for selection.

    Type the countries using their ISO 3166-1 alpha-2 code (i.e. US, CA, MX, etc.). To display more than one country, type them by separating them with a comma , without blank spaces (i.e. US,CA,MX).

    Static Text Value

    Top Countries

    These countries will be pinned to the top of the list (most frequently used countries).

    Type the countries using their ISO 3166-1 alpha-2 code (i.e. US, CA, MX, etc.). To display more than one country, type them by separating them with a comma “,” without blank spaces (i.e. US,CA,MX).

    ../../_images/sxrm-mavd-configure-field-top-countries.png
    • To set a Default Country or Top Country, it must first be added in the Display Countries property as well.

    • If a country is saved on the address column (by a background process) and it is not configured in the Display Countries property, the data will be saved, but it will no appear in the address control.

    Static Text Value

  8. Click OK, save the form and publish it.

  9. 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.

  1. 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.

    ../../_images/sxrm-mavd-configure-new-record.png
  2. 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 Melissa

  3. List of parameters available for Melissa:

    Parameter

    Possible Values

    Description

    Return PO Boxes

    Yes / No

    US Only. Enables autocomplete control to return PO Boxes along with addresses. By default, it is set to Yes (i.e. if no setting is present, PO Boxes are returned by Express Entry).

    Include Extended Postal Code

    Yes / No

    Allows to add the +4 section of the zip code when available. By default, it is set to Yes (i.e. if no setting is present, extended postal codes are returned by Express Entry).

    Country Display

    Use ISO2 Country Code

    Ex: CA

    Use ISO3 Country Code

    Ex: CAN

    Use Long Country Name

    Ex: Canada

  4. Advanced Setting Screenshot:

    ../../_images/sxrm-mavd-configure-advanced-settings.png

Visual Example in a Model Driven Form#

../../_images/sxrm-mavd-configure-form-example.gif

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.

Configure Field Mapping for Background Address Validation#

Reserved, pending update.