Skip to content

Install Country Data

Overview

AddressTools stores its reference data (countries, states, ZIP codes and so on) in custom objects in your org. The data installation populates those objects, and it is this data that the validation and standardisation rules work from.

The installation runs from the AddressTools Administration tab and takes around ten minutes. You need an authentication token first: see Create an Authentication Token.

What Gets Installed

Data is installed into the following objects:

Object Required Notes
Country Yes Selected by default
State Yes Selected by default
Alternative Country Name No Alternative spellings and names
Alternative State Name No Alternative spellings and names
US ZIP Codes No United States only
US ZIP Code Counties No United States only
Time Zone No

The data acts as the backbone for the AddressTools standardisation and validation rules, and can be customised afterwards to suit your business.

On the first run, AddressTools also configures a set of address blocks to give you a working starting point. In most orgs there are seven:

  • Account - Billing Address
  • Account - Shipping Address
  • Contact - Mailing Address
  • Contact - Other Address
  • Contract - Billing Address
  • Contract - Shipping Address
  • Lead - Address

Note: The number of supplied blocks depends on your org. Contract - Shipping Address is only created where the Contract shipping address is available, and orgs with person accounts get two further Account blocks, for the person mailing and person other addresses.

Before You Start

There is a lot of data to install, so check that your org has the storage to hold it. The installation modal shows an Estimated Installation Size figure that turns red if it exceeds the data storage you have available, so you can adjust your selection before starting.

Note: In a sandbox or Developer org, storage is limited and the full data set may not fit. Select Only install sample data to install a reduced set instead.

Step 1: Open the AddressTools Administration Tab

  1. Click the App Launcher to search for and select AddressTools Administration.
  2. Stay on the Installation tab, which opens by default.

Step 2: Start the Data Installation

  1. Find the Data Installation step.
  2. Click Get Started.

Note: If data has already been installed in this org, the button reads Update Data instead. Use it to refresh existing records or to add objects you skipped the first time.

Note: Updating overwrites the country settings the installation manages. Visible, Allow only listed States, State is Mandatory, Use Subcountry Code in State field and ZIP Code Regular Expression are reset to the installed values on every Country record, discarding any change you have made to them. The mandatory street, city and ZIP code settings, Validate ZIP Code and ZIP Code pattern fail message are left alone. Record your changes to the first group before updating so you can reapply them. See Enable Validation Rules.

Step 3: Choose Your Data

The AddressTools Data Installation modal opens.

  1. Under Select primary language for country values:, choose the language your country names should be installed in.
  2. To install a reduced data set, check Only install sample data. This installs all Country, State, Time Zone, Alternative Country Name and Alternative State Name records, but only a subset of the US ZIP Codes and US ZIP Code Counties records.
  3. Under Data Objects to Populate, use the checkboxes to select the objects you want to populate. Country and State are selected for you.
  4. Check the Estimated Installation Size against your available storage.

Step 4: Run the Installation

  1. Click Install.
  2. A Confirmation dialog explains which data set is about to be installed and warns that the operation may fail in Developer and sandbox orgs with limited storage.
  3. Click Yes to continue, or No to go back and change your selection.

A progress dialog headed Installing Data... tracks each object as it completes. When it finishes, the heading changes to Installation Complete, or to Installation Completed with Errors if any records could not be installed, in which case the errors are listed for you to review. Each failed stage shows its message with a trace ID beneath it; quote that ID when contacting support about the failure. See Trace IDs.

Note: The full installation can take around 10 minutes.

What This Does

With the reference data in place, AddressTools can validate and standardise addresses against real country and state records, and the seven address blocks give you a starting point for configuring that behaviour.