Skip to content

Configure Batch Address Verification

Overview

Batch address verification works through your existing address records rather than waiting for someone to edit them. You point it at a Salesforce report listing the records you want checked, and AddressTools verifies every address in that report whose status is Not checked or blank.

You can run a batch immediately, or schedule one to run daily.

Batch verification relies on address verification being enabled in your org, so turn that on first. See Verification, which covers the settings involved both org-wide and on each address block.

Before You Start

  • The address block you want to verify must be configured, with an address status field mapped. See Binding an Address Block and Create an Address Status Field.
  • Verification must be enabled for your org and for that address block. An address block with verification off does not appear in the list at all, and Verify Now stays disabled until verification is enabled for the org.
  • Verification consumes one verification lookup per address, so check you have enough before running a large batch. Your remaining lookups are shown on the Licensing & Lookups tab of AddressTools Administration.

Note

The first time address verification is used in an org, the org is given a trial allocation of verification lookups, shown on the Licensing & Lookups tab of AddressTools Administration. On a trial allocation, or in a sandbox org, batch verification has to be enabled for you. Contact support@provenworks.com with your Org ID.

Step 1: Build a Report of the Records to Verify

Batch verification takes its list of records from a Salesforce report.

  1. Navigate to the Reports tab and click New Report.
  2. Choose the report type for the object holding the addresses, then click Continue.
  3. Add filters for the records you want to verify, using the address fields on the object. For example, filter an Account report on Billing Country, on a created date, or on the record owner.
  4. Click Outline, find the object ID field under Columns, and add it to the report, for example Account ID or Contact ID.
  5. Add any other columns you would like in the report.
  6. Click Save, name the report, and save it into the AddressTools report folder.
  7. Run the report and check that the records you expect are listed.

Note

Two things are necessary for a batch to run on the report. It must be saved in the AddressTools folder or it will not appear in the picklist, and it must include the object ID column so AddressTools knows which records to verify.

Warning

Filter logic is not supported. Batch verification adds its own filters to the report when it runs, and a report that uses filter logic will not run correctly.

Do not filter on the address status field either. Batch verification already restricts itself to records whose status is Not checked or blank, and a status filter of your own replaces that restriction, so addresses that have already been verified can be checked again and consume lookups.

Step 2: Assign the Report to an Address Block

  1. Click the App Launcher to search for and select AddressTools Administration.
  2. Select Batch Address Verification from the left menu.
  3. In the Objects and Fields section, find the row for your address block. Each row shows its Object, Address Block and Record Type.
  4. In the Report column, select the report you saved.

Step 3: Enable the Address Block

  1. Set the toggle on that row to Enabled.

Only enabled rows are included when a batch runs, so this is how you choose which address blocks a scheduled job covers.

Step 4: Size the Job

  1. Click Calculate Now.

A row is added to Job History, and its Total column shows how many records need verifying for that address block. Add the totals across your enabled rows to see how many lookups a run will consume.

Step 5: Run or Schedule the Verification

Verify Now

  1. Click Verify Now.
  2. A confirmation explains that every address configured on the page that has not already been verified will be checked, and that this consumes one verification lookup per address.
  3. Click OK to proceed, or Cancel to go back and use Calculate Now first.

The job appears in Job History, where you can follow its Status and see the Processed, Errors and Total counts as it works.

Schedule a Daily Run

  1. Click New Schedule.
  2. Set Daily start time: to the time the job should run.
  3. Click Save.

The job is listed in the Schedule section with its Job Name, when it was Submitted and its Next Scheduled Run. We recommend choosing a time outside business hours.

Deleting a Schedule

Schedules are removed through Salesforce rather than from this page.

  1. In the Schedule section, use the link to open the Salesforce Scheduled Jobs viewer.
  2. Find the job named Daily Batch Premise-Level Address Verification.
  3. Click Del beside it.

Note

Deleting a scheduled job requires the Modify All Data permission.

Monitoring and Errors

Job History keeps a row per run, showing the object, address block, record type, report, who created it, when it completed, and the processed, error and total counts. The section also links to the Salesforce Apex Jobs viewer if you need to see the underlying job.

Every run is given a trace ID when it starts, shown in the Trace ID column with a button that copies it to the clipboard. If you ever need to contact support about a run, quoting this ID lets them find its logs. See Trace IDs.

Alert Emails

When a batch run finishes with errors, AddressTools emails the details to the Batch Verification Alert Email Address. The email includes the job ID, the errors raised and the run's trace ID. The address is set to the email of the user who installed AddressTools; if it is left blank, alerts go to the user who started the run.

To send alerts to a monitored address instead:

  1. In AddressTools Administration, select Settings from the left menu.
  2. In the Verification Settings section, click the pencil icon beside Batch Verification Alert Email Address.
  3. Enter the address, then click Save.

Note

If the alerts do not arrive, check Setup > Email > Deliverability and make sure Access to Send Email is set to All email.

After a Run

Verified records carry their result in the address status field, and any address AddressTools was able to clean has its street, city, state, country and postal code updated, along with any optional fields mapped on the block. Records it could not match keep their original values and take a status explaining why. See Create an Address Status Field for what each status means.

To verify addresses as they change rather than on a schedule, see Configure Automated Verification via a Record-Triggered Flow.