User Tools

Site Tools


dq_address_search

DQ Address Search

DQ Address Search works across all entities and allows users to search for addresses within their CRM and automatically populate specified address fields across a form.

Installation Guide

This is a step-by-step user guide to help you download, install, and configure the latest DQ Address Search solution for Microsoft Dynamics CRM.

Solution Download

1. Firstly, if you haven't already downloaded the solution(s) from our website, download the following:

DQ Address Search

DQ Additional Info*

*The DQ Additional Info solution is used to store additional information retrieved from the DQ Capture Solutions. If you have previously installed this solution you can ignore this step.


Form Setup

2. Head to Advanced Settings.

Go to Dynamics 365 Settings > Solutions.

From here, select Import.

Select Choose file, select the DQ_Address_Search.zip file, then select Next.

Select Import.

After the import has finished, select Close within the dialog box.

3. If you have already installed the DQ Additional Info solution, then you can ignore step 4 and continue with step 5.

4. Download the DQ Additional Info solution if not done already, then select Import and select the DQ_Additional_Info.zip file. After the import has been successful, close the dialog box.

5. After both solutions have been successfully imported, select Publish All Customizations.

Once published, you need to include the DQ Address Search control in the relevant entity. In this example we will apply the DQ Address Search Control to the Contact Entity. To configure the solution:

Within the Advanced Settings, Go to Settings > Customization > Customize the System.

Expand the Entities section.

Find the Entity you wish to add the DQ Address Search functionality to and then select ‘Forms’ on the appropriate entity

Select the appropriate form layout that wish to add the control. In this example, we have selected Entities > Contact > Forms > Contact.

6. Select the text field which you would like to add the DQ Address Search functionality. In our example, we have created a custom field entitled DQ Address Search.


Add Control

7. Double-click your selected field to open the control properties.

8. Head to the Controls tab and select Add Control

9. Select DQ Address Search and select Add.

10. Select the platforms in which you would like to utilise the control. (If unsure, select all 3).


Configure Control

11. Select the third party provider you would like to use from the list provided.

12. Enter the API Key and Password provided to you by DQ Global.

Enter API Key.

Enter Password.

13. Update Endpoint URL if it’s different than the default one provided.

14. Set Additional Info to True if you would like to return additional information from your selected Third-Party provider.

15. If you want to enable the functionality to allow DQ Address Search to search for international addresses (Non-UK), then set International to Yes.

16. If setting International to Yes, you should provide a field in which to select the country you wish to search for an address in.

This can be done within the Country Field for International field.

Note: This field currently supports Single Line of Text, Option Set and Lookup Data types. If wishing to use an Option Set or Lookup field, manually enter the schema name into the Bind to a static value field.

17. Set the attribute in which the control should derive country from. Leave as default 'name' unless using custom fields, where it should be changed appropriately.

18. Provide the default ISO2 country code for the control. This will define what country the control searches in by default. E.g. for United Kingdom, enter 'GB'. For United States, enter 'US'.

19. Set the minimum number of characters that must be input before a search is performed.

20. Set the maximum number of results that should be displayed by the control within your CRM.

21. Address Block Selection should be set to Address 1 if only using DQ Address Search on one field. If utilising the control on multiple fields on the same form, Address 2 or Address Additional should be set accordingly.

22. Map Authentication Date to an existing field if desired. If unmapped, Authentication Date can be found within Additional Info (if set to True).

23. Map Authentication Result to an existing field if desired. If unmapped, Authentication Result can be found within Additional Info (if set to True).

24. Now, bind and configure the fields that you wish to return values to in your address search.

25. Similar to previous configuration, on click of the “Pencil” icon, a pop up will be displayed, where you can select the properties that you wish to map to your CRM fields. e.g. We are binding Line1 to address1_line1.

Note: To bind custom address fields that are not included in the Composite address, you will need to enter the Schema Names of the fields you would like to map within the Bind to a static value field (See step 16 Note).

26. After binding your desired address values, select OK.


DQ Additional Info Setup

If you have previously installed and configured the DQ Additional Info Solution, you can ignore this section.

We will now setup the DQ Additional Info grid.

27. Select One Column (1 Tab) from the Insert section.

Update the Tab label to ‘DQ Additional Info’.

28. To add the Sub Grid for Additional Info, select the newly created ‘DQ Additional Info’ tab and click on the Sub-Grid Menu Item from the top menu.

The Set Properties dialog box will appear as shown below, we will need to update the Data Source Section.

29. Using the Data Source section, we can bind the DQ Additional Info entities.

Firstly, give any valid Unique Name in Name field.

After, inside Data Source Section, we will select the ‘DQAccountAdditionalInfos’ Entity and 'DQAdditionalInfoView' as Default View.

30. To show more rows of Additional Info data per page, we will update the Number of Rows field to 10 within the Formatting Tab.

After, select OK to close the dialog box.

31. Once you have completed your configurations, Save and Publish the form.


Control Testing

32. Once your customizations have been published, go to the same form you published the control. (In our example we applied it to the Contact entity).

Go to New.

Note: If you have enabled Additional Info then you must save the record before DQ Address Search will function.

33. The DQ Address Search control should look like this:

34. Try searching for any part of an address and the control will return suggestions as seen below:

Note: Certain providers will allow you to expand results as seen below:

35. Select a desired address, and it will populate fields based on your mapping.

36. After searching for an address, the tool will populate the Additional Info table if Additional Info was set to 'True' within configuration.


Optional - Address 3 Configuration

This section covers the configuration necessary if binding the DQ Address Search control to a third field within the same form.

You may have noticed that Address3 fields are not available for binding by default like Address1 and Address2 fields.

To bind address3 fields, you will need to configure the 'Additional Address' properties and map them to your desired fields.

When binding fields, you will need to enter the schema names into the Bind to a static value field as seen below:

Once you have completed your configurations, Save and Publish the form.


dq_address_search.txt · Last modified: 2022/08/31 15:32 by hayden.law