Overriding the standard New Record model with AddressTools
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.
Note: If you make this change but the functionality still appears to be the standard Salesforce new record model, clear your browser’s cache, log out and back in, then try loading the new record page again.
Enabling address verification for the organization
Once all verification settings have been configured for each address block, verification needs to be enabled for the organization. In the event that you want to disable address verification for everyone, the following setting can be disabled.
Go to App Launcher | AddressTools Administration.
Select Settings from the sidebar.
Click the pencil next to Premise-Level Address Verification.
Tick the Premise-Level Address Verification checkbox.
Click Save.
Using address verification
Once address verification is enabled, it gives you access to multiple ways to verify an address.
For interactive type-ahead PowerSearch verification, you will now need to enhance your organization with at least one of the AddressTools Lightning Components, relevant articles can be found below:
One of the first steps during the installation walkthrough is ‘Installing a Default Country’. QuickComplete is the specific functionality in the solution that leverages this value to life. If you need to install a default country to all your users, follow the installing a default country article, then come back here when you’re done.
Installing a separate default country for different users
The user records in Salesforce are provided with a new field “QuickCompleteCountry(pw_ccpro__QuickCompleteCountry__c)” when AddressTools is installed. This field is what stores a text value of the default country for the user for use with QuickComplete Country. Before you can update the field in the user interface, add this field to the User page layout.
Navigate to the User record that you want to add a default country to.
Select Edit.
In the QuickComplete Country field, type the name of the country you want to add.
When complete, Save the record.
Repeat for any additional users you want to update.
Note: The QuickComplete Country field is a text field that can accept any value, however, you should only write in country names that you have installed in your organization. Failure to match these values may result in validation rules failing.
Enabling QuickComplete Country
Go to App Launcher | AddressTools Administration.
Select Settings from the sidebar.
Click the pencil next to QuickComplete Country Enabled and tick the checkbox.
Default country installation will become available once enabled. Use the Default Country Installation picklist to choose the default country for the organization.
Enabling lookup field population for the organization
Once lookup fields have been created and bound to address blocks, the functionality needs to be enabled for the organization.
Enabling this setting will populate the lookup fields on insert and update transactions when the trigger for the object is enabled. In the event that you want to disable lookup field population for your environment, the following setting can be disabled.
Go to App Launcher | AddressTools Administration.
Select Settings from the sidebar.
Click the pencil next to Enable Field Lookup Population.
Use Create Lookup Fields for a configured address block
When an address block is configured in AddressTools, an option to create lookup fields becomes available. Using this action will create three lookup fields on the object with each of them creating a lookup relationship to the relevant data object installed with AddressTools:
Country Lookup
State Lookup
ZIP Code Lookup
Before going forward, this action cannot be used for address blocks that contain fields from another managed package. If your address block contains fields from a managed package, follow the instructions set out in the next section.
To automatically create the lookup fields for the address block:
Go to App Launcher | AddressTools Administration.
Select Address Blocks from the sidebar.
Click the dropdown arrow on the address block you want to create lookup fields for and then select Create Lookup Fields.
Review the confirmation text and select Yes to proceed.
You will now be required to configure the Field-Level Security for the newly created fields. There are a number of ways to configure field-level security, the following steps will show one of these.
Go to Setup | Object Manager | [Object] | Fields & Relationships.
Select newly generated [Address Block Name] Country Lookup.
Select Set Field-Level Security.
Check Visible for each profile that will be using the tool.
Select Save.
Repeat the above steps for each of the generated lookup fields, [Address Block Name] State Lookup and [Address Block Name] ZipCode Lookup.
Manually create lookups for a configured address block
If you are unable to use the Create Lookup Fields button to automatically create lookup fields for your address block, or if you do not require all of the lookups for the address block, you can create them manually through Salesforce setup.
Navigate to Setup | Object Manager.
Choose the object that your address block exists on.
Select Fields & Relationships and New.
Select Lookup Relationship as the Data Type, then click Next.
Select either [Country], [State] or [ZIP Code] from the Related To picklist, then click Next.
You can provide a field label that works for you, we recommend the format Address Block (Billing) + Lookup Object (Country) + "Lookup". For example Billing Country Lookup.
Provide a Field API name of your choice and press Next.
Check Visible for each profile that will be using the tool.
Select Next, there is no need to add the field to the page layout nor a requirement to have it display in a related list
Press Save to confirm the new field.
Repeat the above steps to create all the lookup fields that you require for the address block.
Binding the lookup fields to the address block
With fields now created, they need to be added to the address block. This allows them to work with the associated postal address fields that are entered.
Go to App Launcher | AddressTools Administration.
Select Address Blocks.
Select the Edit action against the address block in question.
Scroll to Lookup Fields.
Map the lookup fields using the appropriate field picklist.
When all your lookup fields have been bound, press Save.
Now the fields are bound to the address block, you’re ready to enable the functionality for the organization!
Address verification is the process of ensuring address data is accurate, misspellings are corrected, and that missing data is provided (such as US ZIP+4®). AddressTools can also provide an additional county data point returned during the process. The term “address validation” can sometimes be used to describe this process, but when in the context of AddressTools, address validation refers to validation rules.
Is there an additional cost to address verification?
Address verification is a chargeable service as a royalty fee needs to be paid each time an external database is accessed to verify an address. This requires credits to be purchased prior to use, one address submitted for verification consumes one credit.
AddressTools Premium trials are provided with 25 free address verification credits but you will be required to reach out to sales@provenworks.com to gain access to any automated/batch service prior to testing.
What methods of address verification are available in AddressTools?
Address verification in AddressTools has two primary types of address verification available, real-time and batch/automated. Specific to AddressTools, the functionality available is:
Standardization is the process of converting multiple known values to a single predetermined format. For example, “United States”, “USA”, “US”, and “United States of America” can each be standardized to “US”.
The same behaviour can also be applied to states. For example, “TX” can be standardized to “Texas”. Standardization is a crucial piece of functionality for organizations running reports on country and state data, or relying on duplicate rules where these field values are compared.
What address fields can be standardized in AddressTools?
Standardization is available for the following fields:
Country
State
What formats are acceptable for country standardization?
There are five formats available for country standardization, an example for Egypt is provided below:
Full name – Egypt
ISO-2 – EG
ISO-3– EGY
Local name (Latin characters) – Miṣr
Local name (Native characters) – مِصر
This data is stored on the Countries object installed with the package.
An additional object “Alternative Country Names” is also installed with AddressTools. This allows you to store additional common names and/or misspellings of countries that will then be standardized to the parent country record during upsert. Some are installed by default such as “England”, “Scotland”, “Wales”, and “Northern Ireland” which belong to “United Kingdom”.
What formats are acceptable for state standardization?
There are two formats available for state standardization, an example for Texas is provided below
Full name – Texas
Sub-code value – TX
An additional object “Alternative State Names” is also installed with AddressTools. This allows you to store additional common names and/or misspellings for states that will then be standardized to the parent state record during upsert. Some are installed by default.
Creating an Address Status picklist field (mandatory for verification functionality)
When verifying an address, a verification status field is required to determine the result of the verification process. This status is also used to identify whether an address has been processed or not. An address status picklist needs to be created for each address block where verification will be enabled.
Note: an address status picklist is already provided for the address blocks that come pre-configured with AddressTools.
When you know which object and address block you need to create a new picklist for:
Go to Object Manager, locate the Object, and go to 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
Not matched
Parsed but not found
Ambiguous
Corrected
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.
Creating a County text field (not mandatory for verification functionality)
When verifying an address, AddressTools has the ability to return a county value. This is primarily designed to benefit use cases based within the United States (i.e. for tax purposes) but relevant data is provided in other countries. If you do not require a county value, this field can be skipped.
Note: a county text field is already provided for the address blocks that come pre-configured with AddressTools.
When you know which object and address block you need to create a new field for:
Go to Object Manager, locate the Object, and go to Fields & Relationships.
Select New.
Choose the data type: Text.
Select Next.
Add a Field Label (we suggest the address type plus county, i.e. Billing County)
Set the length: 255.
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.
Creating an Address Label text area (long) field (not mandatory for verification functionality)
AddressTools’ verification service will return as much useful information as possible into the five standard address fields provided by Salesforce. With the verification service being global, the data being returned may not necessarily be required for postal purposes. For example, “State” isn’t a field used when sending mail in the UK, however AddressTools will populate this field with geographical points that can assist with segmenting your data.
To assist in formatting your mail correctly for each country, AddressTools provides an Address Label feature. You can create a long text field and then bind it to the Address Block. Let’s continue through the steps to create a long text field that can be added to our Address Block configuration later in the walkthrough.
When you know which object and address block you need to create a new field for:
Go to Object Manager, locate the Object, and go to Fields & Relationships.
Select New.
Choose the data type: Text Area (Long).
Select Next.
Add a Field Label (we suggest the address type plus Address Label, i.e. Mailing Address Label)
Leave the length at its default value.
Visible lines: 5.
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.
Bind additional address fields to an address block for use with verification
With the required fields created for address verification, they now need to be added to the address block followed by enabling address verification.
Go to App Launcher | AddressTools Administration.
From the sidebar, navigate to Address Blocks.
Select Edit next to the address block you want to modify.
Locate the Additional Address Fields section.
Bind the Address Status picklist to Status Field.
If applicable, bind the County field in the County Field option.
If applicable, bind the Address Label field in the Address Label option.
Enabling address verification for an address block
Once the field(s) are bound:
Scroll down to Address Verification Options.
Check Enable Premise-Level Address Verification.
Select Save.
Additional address verification options for an address block
Return Company in Street – To return a company/organization value when verifying an address, enable the checkbox for the address block. This will return the registered company/organization value to the first line in the configured street field.
City & Postal Code Are Always in Correct Fields – If your address data in Salesforce is always in the correct fields, it is recommended to check this option. It can reduce the number of ambiguous responses by providing a more defined query. If your address blocks have the potential to contain data in the incorrect address fields, this can result in Not Matched responses.
Force Street Address to Multi-Line – For specific use-cases where a sub-building value must solely appear on a separate line to the rest of the street address, you can use Force Street Address to Multi-Line and choose Sub-Building Always to Line 1 or Sub-Building Always to Line 2. This setting is only recommended for organizations with such specific requirement.
