Documentation

 

Configuring the plugin

Address Validation by SmartyStreets (Salesforce App/plugin) was designed to be as easy to configure as possible. It's mostly automatic! At the end of the managed package installation process, you will be shown a configuration page with the Configure SmartyStreets tab open. (If you need to find it again, you can always launch the SmartyStreets app that came in the package.)

To avoid compatibility problems, please make sure that:

  • Your Salesforce organization does not have Accessibility Mode enabled
  • You have included all standard addresses as part of your page layouts. For example, your page layout for Contacts has both the Mailing address and the Other address
  • You have enabled inline edit

Step 1: Configure organization settings

This step will tune a few of your organization's settings so the plugin will work properly. The first one should be done already. If not, don't worry! We give you a button that can create the settings for you automatically.

All you have to do in this step is look for warning icons and turn them into checkmarks. If a button has a warning icon next to it, click it. The setting will be adjusted automatically, and the warning icon should change to a green checkmark.

Step 1

Here's what the buttons do:

  • Add Remote Sites: Adds the remote sites "https://us-street.api.smartystreets.com" and "https://international-street.api.smartystreets.com". This is required so the plugin can connect with SmartyStreets.
  • Use for [record type]: These buttons make it so clicking the "New" or "Edit" buttons for that record type will take you to non-standard versions of those pages that support address validation. It will also cause that record type to be included during batch verification. If you want to use SmartyStreets to validate addresses for one record type, but not another, simply don't click the button for the record type that you don't want validated.

Step 2.a: Get a SmartyStreets account

Sign up to get a SmartyStreets account if you don't have one already. Otherwise, proceed to step 2.b below.

Step 2.b: Generate a Website Key

First, open the API Keys tab of your account. If you aren't already logged in, you will be prompted to do so.

In the Website Keys section, under the Hosts column, you should see a place to enter a Domain name and generate a new key.

API Keys tab of your SmartyStreets account

To find what domain name you should use, you can follow these steps:

  • Make certain you are in Salesforce Classic and not Lightning Experience
  • From within the SmartyStreets app, click on the Configure SmartyStreets tab.
  • Look at the URL for the configuration page. Copy the part of the URL that is between // and the first /. It may look similar to smartystreets1.na12.visual.force.com
  • Paste the URL fragment into the Domain Name field (it's circled in green in the image above).

Once you have the right domain name entered, press the Generate button. You will find your sparkly new key under the column called Website Key (for website use), and it could be something like 86753094815162342. It won't have letters in it.

Step 2.c: Find/generate your Secret Keys

On the same page that you generated your Website Key, you'll find a section called Secret Keys. Here you will find an Auth ID and Auth Token. You can generate a new pair if you want to, or just use the one that's there.

Step 2.d: Enter and verify your keys

Back on the Address Validation by SmartyStreets configuration page, you will find a friendly set of text fields waiting eagerly to receive your shiny new keys and tuck them safely away. Just enter your keys into the matching fields and use the Verify Keys button below them. If all goes well, the warning icon will change to a happy green check mark.

Click Save Settings, and you're all set! If you want to use the custom fields included with the package, proceed to the optional Step 3.

Step 3: Choose some settings

Choose when to use international lookups

Your SmartyStreets account may have a US subscription, an International subscription, or both. If you only have a US subscription, just leave the default ("never") selected and move on.

Some things to keep in mind:

  • International lookups cost more than US lookups
  • International lookups take much longer than US lookups during batch verification

Do you need international geocodes?

If the latitude and longitude of international addresses are important to you, you can opt in by clicking the checkbox. There's no extra cost to you, but there is to us, so if you don't need them, please do us a solid and leave it unchecked.

Choose what counts as "old"

Once an address has been verified, it is a good idea to re-submit it every so often to make sure it is still valid. We recommend doing so every 6 months.

The default setting for "Months before a valid address may be re-submitted" is 6. This means addresses that were last verified less than 6 months ago will not be included when the Batch Verify page is in Valid mode. Set this to whatever integer works for you. Setting it to zero means all valid addresses will be included.

Step 4 (optional): Add our custom fields to your standard page layouts

This managed package includes a number of custom fields to help give you more information about the addresses in your records. Each address type has its own set of fields.

First, open up the Page Layout editor for the record type of your choice. In this example, we'll do Account.

Navigate to Setup->Customize->Accounts->Page Layouts, and click Edit on the layout you want to edit.

This package includes custom fields for Account called:

  • Billing County
  • Billing Verified
  • Billing Last Verified
  • Billing Address Summary
  • Shipping County
  • Shipping Verified
  • Shipping Last Verified
  • Shipping Address Summary

Drag the fields you want to use from the menu at the top and place them wherever you want them to be. Don't forget to save!

Adding custom fields to layout