Setup Customers Using Tabular Data (Business Analyst)

License Level:BasicStandardAdvanced

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

Syntax

SetupCustomersByTable_ba (Table, Locator, MatchFields, NameField, LinkField, OutputFeatureClass, {CS_AppendsegmentationCodes}, {CS_CreateCustomerProfile}, {CSCustomerProfileName}, {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.

  • TrueAppends the Tapestry Segmentation code to the customer file.
  • FalseWill 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.

  • TrueCreates a apestry Segmentation Profile based on the customer layer.
  • FalseWill not create a apestry Segmentation Profile based on the customer layer. This is the default.
Boolean
CSCustomerProfileName
(Optional)

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 HouseholdsThis option will use the Total Households segmentation base to create the customer profile. This is the default.
  • Total Adult PopulationThis 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("C:\Program Files (x86)\ArcGIS\Desktop10.2\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_2013/Datasets/Tutorial/sf_custs.dbf'
  OutFC= "C:/temp/sf_customers.shp"
  Locator = "C:/ArcGIS/Business Analyst/US_2013/Data/Geocoding Data/USA Geocoding Service.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, Locator, FldCol, CustName, StoreId, OutFC)
 
# Release extension license 
  arcpy.CheckInExtension("Business") 
 
except:
  print arcpy.GetMessages(2)

Environments

This tool does not use any geoprocessing environments

Related Topics

Licensing Information

ArcGIS for Desktop Basic: Requires Business Analyst
ArcGIS for Desktop Standard: Requires Business Analyst
ArcGIS for Desktop Advanced: Requires Business Analyst
3/3/2014