ArcMap

Setup Customers Using Tabular Data

Available with Business Analyst license.

Summary

Geocodes tabular data and defines the output feature class as a customer file for use in the Analysis And Trade Areas tools.

Learn more about Setup Customers Using Tabular Data

Usage

  • When geocoding stores, it is best to have address, city, state, and ZIP Code fields to ensure the best results for the geocoder.

  • View the geocoding output log to examine the match rate of your input addresses.

  • The standard input tabular data formats used are .dbf (IV), .csv, and tab-delimited text (.txt).

  • Relational database files can also be accessed through this tool utilizing the Database Connections wizard in ArcCatalog.

  • If importing from Excel to .dbf, make sure your field headers are eight characters or less and do not have special characters embedded in the description.

Syntax

arcpy.ba.SetupCustomersByTable(Table, Locator, MatchFields, NameField, LinkField, OutputFeatureClass, {CS_AppendsegmentationCodes}, {CS_CreateCustomerProfile}, CS_CustomerProfileName, {InputVolumeInfoFieldName}, SegmentationBase)
ParameterExplanationData Type
Table

The input table used for setting up your customer layer.

Table View
Locator

The predefined address locator service.

Address Locator
MatchFields

Input fields for geocoding addresses.

Field Info
NameField

The unique identifier for the input feature class (commonly the customer name).

Field
LinkField

Unique ID linking the customer file with the store file.

Field
OutputFeatureClass

The feature class that will contain the customer points.

Feature Class
CS_AppendsegmentationCodes
(Optional)

Appends Tapestry Segmentation codes to the customer layer.

  • True —Appends the Tapestry Segmentation code to the customer file.
  • False —Will not append Tapestry Segmentation codes to the customer file. This is the default.
Boolean
CS_CreateCustomerProfile
(Optional)

Creates a Tapestry Segmentation Profile based on the customer layer.

  • True —Creates a apestry Segmentation Profile based on the customer layer.
  • False —Will not create a apestry Segmentation Profile based on the customer layer. This is the default.
Boolean
CS_CustomerProfileName

The name of the customer profile.

String
InputVolumeInfoFieldName
(Optional)

The field containing your volumetric field. Typically this is a sales filed associated with customer data.

Field
SegmentationBase

The base data to be used in creating the customer profile.

  • Total Households —This option will use the Total Households segmentation base to create the customer profile. This is the default.
  • Total Adult Population —This option will use the Adult Population (18+) segmentation base to create the customer profile.
String

Code sample

SetupCustomersByTable example (stand-alone script)

# Name: SetupCustomersByTable.py
# Description: Geocodes San Francisco customers using tabular data. 
# Author: Esri

# Import system modules
import arcview
import arcpy

arcpy.ImportToolbox(r"C:\Program Files (x86)\ArcGIS\Desktop10.8\Business Analyst\ArcToolbox\Toolboxes\Business Analyst Tools.tbx")
 
try:
# Acquire extension license 
  arcpy.CheckOutExtension("Business") 
 
# Defines the parameters for the Setup Customers Using Tabular Data tool
  Input = 'C:/ArcGIS/Business Analyst/US_2022/Datasets/Tutorial/sf_custs.dbf'
  OutFC= "C:/temp/sf_customers.shp"
  Locator = "C:/ArcGIS/Business Analyst/US_2022/Data/Geocoding Data/USA_StreetAddress.loc"
  CustName = "NAME"
  StoreId = "STORE_ID"
  FldCol = "Addr ADDRESS VISIBLE;City City VISIBLE;State State VISIBLE;ZIP ZIP VISIBLE"
 
# Generate customer layers with tabular data
  arcpy.SetupCustomersByTable_ba(Input,
	  OutFC,
	  Locator,
	  CustName,
	  StoreId,
	  FldCol)
 
# Release extension license 
arcpy.CheckInExtension("Business")

Environments

This tool does not use any geoprocessing environments.

Licensing information

  • Basic: Requires Business Analyst
  • Standard: Requires Business Analyst
  • Advanced: Requires Business Analyst

Related topics