Difference between revisions of "Dynamics CRM:Configure Address Validation"

From Melissa Data Wiki
Jump to navigation Jump to search
Line 1: Line 1:
{{DynamicsIntroNav
{{DynamicsIntroNav}}
|QuickStartCollapse=
}}


{{CustomTOC}}
{{CustomTOC}}


==Configure Address Verification API==
==Configure Address Validation for CRM Entities==
<ol>
Address Validation for Dynamics 365 can be configured to validate addresses on any entity in Dynamics
<li>In the navigation bar, go to '''''Address Validation → Verification API Configuration'''''</li>
365/CRM that contains address fields.
<li>Create a new record and enter the information as per your configuration</li>
<li>Select a "'''Validation Service Type'''" (Melissa Data) and enter your corresponding API Key in the "'''Service License Key'''" field</li>


[[File:Dynamics_Config_LicenseKey.png|frame|none|'''Service License Key''']]
To demonstrate how to setup and perform an address validation we'll use a configuration for the Account entity:


<li>Finally, set the value of the "'''Is Valid'''" field to <code>Yes</code> and click "'''Save'''". This will automatically try to validate an address in the background to make sure it works. If the API Key is wrong, you will get an error message and the value will be set back to <code>No</code>.</li>
===Creating Sample Configuration Records for Account Entity===
;Optional Step
:Address Validation for Dynamics 365 can help you create sample configuration records to get you started.
 
#Navigate to a Address Verification API record. (Like the one created [[Dynamics CRM:License#Validate Service|here.]])
#Click on the "'''Create Sample Configuration'''" button.
 
::[[File:Dynamics_Config_CreateSampleRecord.png|frame|none|'''Create Sample Record''']]
 
:This will create two sample address verification records. To review them go to the '''''Address Validation → Address Fields Configuration''''' sitemap area.
 
::[[File:Dynamics_Config_EditSampleRecord.png|frame|none|'''Edit Sample Record''']]
 
 
===Define Address Fields on Target Entities===
#In the navigation, go to '''''Address Validation → Address Fields Configuration'''''.
#Create a new record.
#Enter the following information:
::*;Entity Name: Schema name of the source Entity (e.g. account).
 
::*;Configuration Name: Unique name of the configuration record (e.g. account1-sample).
 
::*;API Configuration Record: This is a lookup to select the API configuration record created in the previous section.
 
:::[[File:Dynamics_Config_APIRecord.png|frame|none|'''API Configuration Record''']]
 
::*;Address Verification Button: This is an ''optional step'' that allows you to customize the label of the verification button. To do so, enter the language code (Microsoft Locale ID Value) followed by a colon and then the label of the button, e.g. <code>[Language Code]:[Button label]</code>. For a list of supported languages and their codes, visit https://msdn.microsoft.com/en-us/library/ms912047(v=winembedded.10).aspx.
 
:::*This option also allows you to have multiple languages configured for the label of the button by adding a semi-colon followed by another code <code>[Language Code]:[Button Label];[Other Code]:[Other Language Label]</code>. For example: <code>1033:Verify Address;1036: Vérificationd'Adresse</code>.
:::*The button will display the language based on the system language you set.
 
::*;Default Country: If you are using the Melissa Data Express Entry Autocomplete, you can select the default country that will appear on the forms (e.g.: United States, Canada, etc.)
 
::*;Output Language: By default, verification APIs will return the verified address in English US. This option allows you to specify the language to use with the selected configured web service.
 
::*;Use Same Fields for Input and Output: Select whether you want the validated address to overwrite the original address or not. When a different destination is selected, you will be given the option to identify the different source fields.
 
::::Address Validation for Dynamics 365 allows you to input the country of the address to be validated as a lookup or text field.
 
::::*The Source (Input) fields are the fields where the original address (to be validated) are located.
::::*The Destination (Output) fields are the fields where the verified address will be written to.
 
::::[[File:Dynamics_Config_SameFields.png|frame|none|'''Use Same Fields for Output''']]
 
<ol style="list-style-type:upper-alpha">
:::<li>Address Field - Full Address: Indicate a text field schema name (custom created or out of the box field) where the application can save the full formatted address after it is verified. A value is not required for this field, and it cannot be one of the Out of the Box address composite fields.</li>
:::<li>Address Validation Details Field: Indicate a text field schema name (custom created or out of the box field) where the application can save the details of the address correction returned by the verification API. A value is not required for this field.</li>
</ol>
</ol>
::::<span style="color:red;">'''IMPORTANT – When a different destination is enabled for the validated address:'''
::::*If the country source is a lookup field, then the destination can be either a lookup or a text field.
::::*If the country source is a text field, then the destination must be a text field.</span>




[[Category:Clean Suite for CRM:Dynamics]]
[[Category:Clean Suite for CRM:Dynamics]]

Revision as of 23:33, 12 August 2019

← Clean Suite for CRM:Dynamics

Dynamics Navigation
Introduction
License
System Requirements
Quick Start
Configure Address Validation
Workflow Tutorial



Configure Address Validation for CRM Entities

Address Validation for Dynamics 365 can be configured to validate addresses on any entity in Dynamics 365/CRM that contains address fields.

To demonstrate how to setup and perform an address validation we'll use a configuration for the Account entity:

Creating Sample Configuration Records for Account Entity

Optional Step
Address Validation for Dynamics 365 can help you create sample configuration records to get you started.
  1. Navigate to a Address Verification API record. (Like the one created here.)
  2. Click on the "Create Sample Configuration" button.
This will create two sample address verification records. To review them go to the Address Validation → Address Fields Configuration sitemap area.


Define Address Fields on Target Entities

  1. In the navigation, go to Address Validation → Address Fields Configuration.
  2. Create a new record.
  3. Enter the following information:
  • Entity Name
    Schema name of the source Entity (e.g. account).
  • Configuration Name
    Unique name of the configuration record (e.g. account1-sample).
  • API Configuration Record
    This is a lookup to select the API configuration record created in the previous section.
File:Dynamics Config APIRecord.png
API Configuration Record
  • Address Verification Button
    This is an optional step that allows you to customize the label of the verification button. To do so, enter the language code (Microsoft Locale ID Value) followed by a colon and then the label of the button, e.g. [Language Code]:[Button label]. For a list of supported languages and their codes, visit https://msdn.microsoft.com/en-us/library/ms912047(v=winembedded.10).aspx.
  • This option also allows you to have multiple languages configured for the label of the button by adding a semi-colon followed by another code [Language Code]:[Button Label];[Other Code]:[Other Language Label]. For example: 1033:Verify Address;1036: Vérificationd'Adresse.
  • The button will display the language based on the system language you set.
  • Default Country
    If you are using the Melissa Data Express Entry Autocomplete, you can select the default country that will appear on the forms (e.g.: United States, Canada, etc.)
  • Output Language
    By default, verification APIs will return the verified address in English US. This option allows you to specify the language to use with the selected configured web service.
  • Use Same Fields for Input and Output
    Select whether you want the validated address to overwrite the original address or not. When a different destination is selected, you will be given the option to identify the different source fields.
Address Validation for Dynamics 365 allows you to input the country of the address to be validated as a lookup or text field.
  • The Source (Input) fields are the fields where the original address (to be validated) are located.
  • The Destination (Output) fields are the fields where the verified address will be written to.
File:Dynamics Config SameFields.png
Use Same Fields for Output
  1. Address Field - Full Address: Indicate a text field schema name (custom created or out of the box field) where the application can save the full formatted address after it is verified. A value is not required for this field, and it cannot be one of the Out of the Box address composite fields.
  2. Address Validation Details Field: Indicate a text field schema name (custom created or out of the box field) where the application can save the details of the address correction returned by the verification API. A value is not required for this field.
IMPORTANT – When a different destination is enabled for the validated address:
  • If the country source is a lookup field, then the destination can be either a lookup or a text field.
  • If the country source is a text field, then the destination must be a text field.