Category: AddressTools

Geocoding in AddressTools Premium is the process of returning longitude and latitude values alongside a verified postal address. Geocoding enables you to place records on maps, calculate distances, support territory management, and automate location-based tasks within Salesforce.

Access to geocoding functionality requires Address and Geocoding lookups alongside your AddressTools Premium licenses. If your organisation does not currently have access to geolocations, or you would like more information about enabling this feature, contact sales@provenworks.com.

AddressTools geocoding vs Salesforce Data.com geocoding

While Salesforce offers native geocoding for standard address fields (Account Billing & Shipping, Contact Mailing, and Lead Address), the Salesforce Data Integration Rules run asynchronously and restrict geocoding to these specific objects. The platform provides limited control over when it generates coordinates or how you customise the integration.

In contrast, AddressTools Premium returns latitude and longitude instantly as part of the address verification process, works consistently across any object you enable it for, and gives you immediate geolocation data tailored to your workflows. For best results on standard objects where Data.com geocoding is available, we recommend disabling the native Salesforce Data Integration Rules geocoding, via Data Integration Rules in setup, to avoid conflicts or delays and rely solely on AddressTools’ geocoding.

How to configure geocoding

Geocoding will be enabled in your environment if: 

• Your org has Address and Geocode lookups.
• You have configured your address blocks to include Longitude, Latitude, and Geocode Accuracy fields.

Assuming that your purchase is active or you’re utilising a geocode trial, the following steps will describe how to edit an existing address block to include the geocoding fields.

This example uses the Account Billing Address fields, the fields used are provided as standard out of the box with Salesforce, however the same steps can be used on custom fields. 

1. Navigate to AddressTools Administration | Address Blocks.
2. Locate the specific address block you wish to configure from the table.
3. Select the dropdown menu on the right of the row and click Edit.
4. Find the Location Fields section to map the fields:
   • Latitude Field: Select the Latitude field from the dropdown menu (BillingLatitude).
   • Longitude Field: Select the Longitude field from the dropdown menu (BillingLongitude).
   • Geocode Accuracy Field: Select the Geocode Accuracy field from the dropdown menu (BillingGeocodeAccuracy).
5. Save the changes to apply the geolocation settings.

Testing AddressTools geocoding

When setup of verification has been complete, you’re able to test geocoding by following the steps below:

1. Verify an Address:
   Perform address verification via PowerSearch or your configured automated process.
2. Check the Geocode Fields:
   After the verification completes, inspect the Latitude, Longitude, and Geocode Accuracy fields that you configured in the address block to confirm they contain valid values. You can do this by retrieving the values via an SOQL query. Be aware that verification through PowerSearch will return ‘Unknown’ in the Geocode Accuracy field. Other values will be populated when using automated address verification.
3. Verify Field Reset Behavior:
   AddressTools will reset geolocation fields when any address field changes. This ensures geolocations values always aligns with the verified address. To test this:
   • Make a modification to an address field (for example, remove or alter the street line), and save the record.
   • The Latitude, Longitude, and Geocode Accuracy fields should now be NULL (empty).

Back to the AddressTools Premium installation walkthrough

This article will cover how to configure Sharing Settings to allow external Guest users access to the Country object’s records installed with AddressTools. This configuration is essential to ensure your external users can utilise the full functionality of the product.

Note: In Salesforce, external users such as Guest users do not have “View All” permissions by default. Because of this restriction, the standard AddressTools Permission Sets cannot be assigned to these users. You must instead complete the sharing configuration outlined below to provide the required access to the functionality.

Configure the Sharing Rule Criteria

From Setup enter and select Sharing Settings.

Locate the section Country Sharing Rules and click New.

Follow these steps to define the rule:

• Step 1: Enter a Label and Rule Name that is descriptive (e.g. Share Countries with Guests).
• Step 2: For the Select your rule type section, select Guest user access, based on criteria.
• Step 3: In the Select which records to be shared section, set the following:
  • Field: Country Name
  • Operator: not equal to
  • Value: (Leave this box blank)
• Step 4: In the Select the users to share with section, select the specific user license you need to provide access to (e.g. Partner Community User).
• Select Save.

Assigning Permissions to Guest Users

If you are still experiencing issues with the Guest user when using AddressTools, you may need to assign additional permissions. The Guest user requires specific permissions to use the tool. A full list of required permissions can be found in: How to: deploy AddressTools Premium to users in your organization – ProvenWorks.

This article will cover how to create and configure your custom address block with AddressTools allowing for all trigger based and interactive functionality. 

Note: Custom address block functionality requires AddressTools Premium. If you use AddressTools Free, start a Premium trial.  

In the following example, we will be covering how to configure a custom address block that we have created on a custom object that uses individual custom fields for each address field. The same steps can be used with a custom address field type; however we recommend using individual field elements due to the limitations that Salesforce State & Country/Territory picklists enforce.  

Task overview: 

1. Create the address block fields on the object.
2. Create the address verification fields (Premise-Level only).
3. Configure the address block and verification in AddressTools.
4. Create the custom trigger.
5. Optional: Add the override component.
6. Optional: Add the on page component.

Create an address block in the custom object

The following steps assume you are taking the approach of using individual fields for each address element. It is recommended to review this step even if you have already created your address fields. This is the ensure each field is of the right type before moving forward with the rest of the configuration.  

• Go to Setup | Object Manager | [Your Object] | Fields & Relationships.
• Select New to create each of the following address block fields: 
  • Street – Text Area (255).
  • City – Text (255).
  • State – Text (255).
  • Country – Text (255).
  • Postal Code – Text (255).

Create address verification fields (needed for Premise-Level)

If you want to utilize address verification functionality with the new address block, you will be required to create an Address Status field at a minimum. For optional fields such as County or Address Label that are also populated when using Address Verification, see the article: Creating additional fields for address verification.

• Go to Setup | Object Manager | [Your Object] | Fields & Relationships. 
• Select New.
• Choose the data type: Picklist.
• Select Next.
• Add a Field Label (we suggest the address type plus address status, i.e. Billing Address Status) 
• Select Enter values, with each value separated by a new line.
• Add the following values to the text area: 
  • Not checked *mark as the default value 
  • Not matched 
  • Parsed but not found 
  • Ambiguous
  • Verified 
• Uncheck Restrict picklist to the values defined in the value set. 

• Select Next.
• Provide visibility to all the users who will be verifying addresses, this can also be handled in a permission set afterward if preferred. 
• Select Next and Save.

Configure address block and verification.

With the objects and fields created, it is now essential to map them with AddressTools via the Administration page. 

• Go to App Launcher | AddressTools Administration | Address Blocks.
• Select Add, choose [Your Object] from the dropdown.
• If you desire functionality on a specific record type, choose the record type from the options. Leaving this blank will apply the functionality to all. 
• Select Next.
• In Postal Address Fields, complete each dropdown with the corresponding API name from your object.
• In Additional Address Fields, complete the Status Field (and any additional fields) by choosing the corresponding object API name from the dropdown. 
• If necessary, in Address Verification Options, select Enable Premise-Level Address Verification.
• Enable settings as required for the address block and Save. 

Create custom trigger

A trigger is required on the objects that contain address fields that are configured with AddressTools. Without the trigger, most functionality will not fire and other functionality may appear to not behave as intended. 

• Go to Setup | Object Manager | [Your Object] | Triggers. 
• Click New to create a trigger. 
• Replace the default code in the text field with the following code snippet: 

trigger ValidateOBJECTLABELCountryFields on OBJECTAPI (before insert,
before update) { 
   pw_ccpro.CountryValidator2.Validate (Trigger.new, Trigger.oldMap);
}

• In this code snippet, replace OBJECTLABEL with the object name and OBJECTAPI with the correct API name. 
• Save your new trigger. 

How to add the override component 

The AddressTools Override component is an advanced lightning component built to replace the standard “New Record” popup that your users experience when creating a new record in Salesforce. 

To override the New Record model in Salesforce Lightning: 

• Navigate to Setup | Object Manager | [Object to override] | Buttons, Links and Actions. 
• For the New button, select the arrow to reveal options and choose Edit. 
• Set Lightning Experience Override to Lightning Component. 
• Choose pw_ccpro__AddressToolsOverride from the picklist. 
• Select Save.

Repeat the above steps for all of the objects you want to override the new record model with. 

How to add the on page component 

The AddressTools Record Page Component is your one-stop widget for handling anything address related on a record. The component is designed to sit on a lightning record page where an address block exists giving your users quick access to everything they need without distraction. 

To add the AddressTools Record Page Component to a lightning record page: 

• Navigate to Setup | Object Manager | [Object] | Lightning Record Pages. 
• Select New or if a Lightning Record Page already exists, select Edit. 
• Drag the AddressTools Component from the components list onto the layout. 
• Choose the Address block. 
• Optionally, type into the Component header title to add a custom title. 
• Select Save.

If the page has not yet been activated, a prompt will appear asking you to activate it. Follow the steps below to assign the page in the organization. 

• Select Activate.
• The page can be assigned based on different levels, for example set the Org Default by pressing Assign as Org Default. 
• Review the page assignment changes. 
• Select Save. 

If there is a warning symbol when an address is “Verified”, it is usually because the AddressTools trigger isn’t enabled for the object. Standard objects can use the built-in triggers, while custom objects will require a custom trigger. 

How to fix it? 

1. Enable the provided trigger for standard objects: Account, Contact, Contract, Lead, or;
2. Create a trigger for custom objects. 

Step-by-step resolution guide: 

1. Turn on triggers for supported standard objects.

• Go to AddressTools Administration | Settings. 
• In Trigger Settings, select Enable {Object} Trigger and save.  

Note: supported objects are Account, Contact, Contract, Lead.

2. Create a trigger for a custom object. 

• Go to Setup | Object Manager | [Your Object] | Triggers. 
• Click New to create a trigger. 
• Replace the default code in the text field with the following code snippet: 

trigger ValidateOBJECTLABELCountryFields on OBJECTAPI (before insert,
before update) { 
   pw_ccpro.CountryValidator2.Validate (Trigger.new, Trigger.oldMap);
}

• In this code snippet, replace OBJECTLABEL with your object name and OBJECTAPI with the API name. 
• Save your new trigger. 

If you are still experiencing issues and need assistance, contact support@provenworks.com. 

If a report isn’t visible within the Batch Address Verification app, this is usually due to the report being saved in the wrong folder or the report is missing the Record ID field.

How to fix it?

1. Save the report in the AddressTools folder. 
2. Add the Record ID field to the report. 

Step-by-step resolution guide:

1. Make sure the report is saved in the AddressTools folder.

• Go to Reports | [Your Report] | Edit. 
• In the dropdown next to Save, select Properties. 
• Under Folder, choose Select Folder. 
• Go to All Folders | AddressTools. 
• Click Select Folder at the bottom of the page, then save. 

2. Include the Record ID field in the report.

• Go to Reports | [Your Report] | Edit. 
• In the left sidebar, select Outline. 
• In Columns, add the relevant {Record} ID (e.g. for Accounts add Account ID). 
• Save the changes making sure it is in the correct folder from Step 1. 

If you are still experiencing issues and need assistance, contact support@provenworks.com . 

This typically occurs when the United States country setting is configured to use state names instead of codes, or when state standardization isn’t enabled for the address block.

How to fix it?

1. Set the United States to use ISO state codes at the country level. 
2. Turn on Standardize State for the specific address block. 

Step-by-step resolution guide:

1. Configure the country to use ISO codes for states. 

• Go to AddressTools | Countries.  
• Select All and find the relevant country from the list (United States). 
• In Preferences, select Use Subcountry Code in State field and save.

2. Enable standardization on the address block.

• Go to AddressTools Administration | Address Blocks.
• Click  Edit next to the relevant object’s address block. 
• In Global Settings, check Standardize State and save. 

If you are still experiencing issues and need assistance, contact  support@provenworks.com. 

If the country value doesn’t standardize, it’s usually because the AddressTools trigger isn’t running on that object or standardization isn’t enabled for the package or address block.

How to fix it?

1. Enable the trigger for your object.
2. Turn on standardization and choose your country format.
3. Turn on Standardize Country for the specific address block.

Step-by-step resolution guide:

1. Make sure the AddressTools trigger is on for your object. 

• Go to AddressTools Administration | Settings | Trigger Settings.
• Ensure the trigger is enabled for your object. 
• For custom objects see: Trigger creation and enablement guide.

2. Turn on standardization and choose the country format. 

• Go to AddressTools Administration | Settings.
• In Feature Enablement, select Standardization Enabled. 
• Set Country Standardization Format to Name (or other choice) and save.

3. Enable standardization on the address block. 

• Go to AddressTools Administration | Address Blocks. 
• Click Edit next to the relevant object’s address block.
• In Global Settings, check Standardize Country and save.

If you are still experiencing issues and need assistance, contact support@provenworks.com.

When editing an address marked as Verified, it’s important to understand how the system handles verification status. By default, any modification to a Verified address will cause its status to revert to Not Checked. This behavior is intentional and helps maintain data integrity during address verification. 

The address verification tool sets an address status to: 

Verified + a Zero-Width Space (ZWSP) character (U+200B) 

This invisible character allows the system to distinguish between: 

• An address that was already verified before the current transaction. 
• An address that was verified as part of the current transaction. 

Trigger Behavior 

When the trigger runs: 

• It checks for the ZWSP character. 
• If present, it knows the address has already been verified in the current context. 
• It removes the ZWSP and does not revert the status to Not Checked. 

How to Preserve ‘Verified’ Status After Editing 

To retain the Verified status after editing an address: 

1. Check if the status is Verified. 
2. Append a Zero-Width Space (U+200B) character to the end of the status. 
3. Save the updated record. 

This ensures the verification system recognizes the address as already verified and prevents the status from resetting. 

Example 

Before saving an updated verified address: 

Status: “Verified​” ← Includes ZWSP (U+200B) at the end
 

Without the ZWSP, the trigger assumes it’s an outdated verification and will reset the status.