Address enrichment

If you're using the EDQ Record Detail component to validate addresses, it's possible to enrich the address with additional data from our Enrichment API. For example, you can find out a household's estimated income level or an address's geographical coordinates. Assuming you are already licensed to access this data, this is achieved by enabling the feature in EDQ Profile Settings and through configuration of Touchpoints.

Enable address enrichment for your profiles

1. Go to App Launcher and in the search box type EDQ Profile Settings, and select it.

2. Edit the profile for which you want to enable enrichment.

3. Select Address Enrichment under Other features.

4. Click Save.

5. Repeat this process for any other profiles that require access to the feature.

Setting up Touchpoints to return enrichment data

1. Click on App Launcher. Type EDQ Global Settings in the Quick Find box, and select it.

2. Select Touchpoints from the left-hand menu.

3. Click the New button found in the top right to create a new Touchpoint configuration for your Salesforce object.

4. Choose whether you want to create a Touchpoint for a Standard address field (including the new Custom Address Field) or a set of Custom fields used to represent an address:

   • For standard address fields you just need to choose the object and then select from the list of dynamically generated target address fields found within that object.
   • For custom fields you can refer to the additional instructions on configuring address Touchpoints with custom fields to understand how these are configured.

5. Set the optional destination field for the validation status. By default the validation status is stored in a separate EDQ Log object, which happens in a trigger after the object is saved. If action needs to be taken based on the validation status before saving, then we offer the option of storing the status in a destination field on the record itself. Refer to the EDQ Log custom object guide for details on the possible status values.

6. Activate the optional Passive validation feature should you wish to use it.

   

With your address configured you can now decide which additional data you want to retrieve and which fields on your object you want this to be mapped to. This data is unique to each country, so a set of mappings must be created for each country you require.

7. Under the Country-level mapping heading click the New mapping set button.

8. On the Country level mappings page select your country and the Enrichment mappings section will appear below, allowing you to then click the New enrichment mapping button.

   

   You can now create as many mappings as you require. For each mapping you first select from the list of possible attributes from our Enrichment API and then select a field from the Salesforce object chosen for your Touchpoint. The API attributes shown are automatically restricted to just those that work for the country selected. For a full list of attributes and their descriptions refer to our Enrichment API documentation.

   Unwanted mappings can be removed using the cross icon to the right of the mapping and further new ones added using the New enrichment mapping button.

   Unmapping fields which have already been populated

   If a field mapped in a Touchpoint has been populated and is subsequently unmapped, the field values for the records that have already been populated will need to be cleared manually. Otherwise, there is the possibility that the value in the field is associated with an address returned from a subsequent address validation.

9. Once all the mappings have been configured, click the Add country mappings button to add the set of mappings for that country.

10. Repeat this process for other countries as required and then click Save to save your Touchpoint configuration.

    Remember to save the Touchpoint

    Once you've made any changes to the country mappings and returned to the Touchpoint configuration page, you must remember to save the overall Touchpoint to commit the mapping changes.

Testing your Touchpoint mappings

1. Make sure all the fields that were mapped in your Touchpoint have been added to the Page Layout for the relevant Salesforce object.
2. Edit a record for the Salesforce object you want to test and try to validate an address using an EDQ component.
3. If the validation is successful, check that the mapped fields are populated with the additional data you were expecting.

Handling of unlicensed or missing attributes

If you mapped an attribute which you are not licensed for or which doesn't exist for the validated address, the mapped object field won't be populated when an address is returned following validation.

To make this visible to administrators for debugging purposes we utilize our package's frontend logging which appears in your browser's Developer Console. Errors will be logged at the following levels.

• INFO level when an attribute is missing for the validated address (E404)
• WARN level when an attribute is unauthenticated or unauthorized (E401/E403)
• WARN level for any other non-success error messages, such as server errors (E500)

Visual indication of enriched addresses

When an address is validated in our EDQ Record Detail component and Enrichment mappings have been configured for the selected country, the response from our API will be stored in the mapped fields.

If a successful API response is received, the address label will be show one of three possible icons:

• Map marker - appears in the case that only geocode attributes have been mapped, i.e. only attributes containing the words latitude, longitude or match_level
• Blocks with arrow - appears in the case that only non-geocode attributes have been mapped
• Blocks with map marker - appears in the case that a mix of geocode and non-geocode attributes have been mapped

Support for custom fields of type Geolocation

If you wish to map one of our latitude or longitude enrichment attributes to a custom field of type Geolocation, it must be configured with Latitude and Longitude Display Notation set to Decimal.

Additional functionality for geocode accuracy

Within Salesforce, geocode fields are available for standard addresses on accounts, contacts and leads. In these cases, the Accuracy field only allows certain values, as detailed on this Salesforce Help page: Geocode Fields and Accuracy.

Many of our Enrichment datasets offer a geocode attribute called match_level, which specifies the accuracy of the coordinates for the specified address. The values of this attribute don't match the values Salesforce uses for its Accuracy field, so we offer two variants of the match_level attribute:

• match_level (native API value) - this will return the native value direct from our API
• match_level (Salesforce compatible) - this will return a Salesforce compatible value based on the mapping table below and should be used if you're mapping to the Accuracy field in one of the standard addresses on accounts, contacts or leads

* Null values will be returned where there is no Salesforce equivalent, such as country.