ArcMap

Setup Store Using Tabular Data

Available with Business Analyst license.

Summary

Allows you to turn tabular data (.dbf, .txt, or RDBMS format) into store points.

Learn more about how Setup Store Using Tabular Data works

Usage

  • When geocoding stores, it's best to have address, city, state, and ZIP 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 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.SetupStoreByTable(Table, Locator, MatchFields, NameField, StoreIDField, OutputFeatureClass, {WayToSpecifyStoreIDField}, {UsePictureSymbol}, {ImagePath}, {PictureSymbolSize})
ParameterExplanationData Type
Table

The tabular data (.dbf, .txt, or RDBMS format) that will be used to geocode your stores.

Table View
Locator

The address locator service to use to geocode addresses.

Address Locator
MatchFields

Input fields for geocoding addresses.

Field Info
NameField

The field containing the store name.

Field
StoreIDField

The name used to identify the store ID.

String
OutputFeatureClass

The feature class that will contain the store points.

Feature Class
WayToSpecifyStoreIDField
(Optional)

Selects an existing store ID field or creates a new field.

  • USE_EXISTING —Uses an existing store ID field.
  • CREATE_NEW —Creates a new store ID field. This is the default.
Boolean
UsePictureSymbol
(Optional)

Inserts custom store symbology into point feature class.

  • True —Inserts custom symbology.
  • False —Will not insert custom symbology. This is the default.
Boolean
ImagePath
(Optional)

The file location containing the custom store symbology.

File
PictureSymbolSize
(Optional)

Set the symbol size by points.

Long

Code sample

SetupStoreByTable example (stand-alone script)

# Name: SetupStoreByTable.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 Store Using Tabular Data tool
  Table = "C:/ArcGIS/Business Analyst/US_2022/Datasets/Tutorial/sf_stores.dbf"
  Locator = "C:/ArcGIS/Business Analyst/US_2022/Data/Geocoding Data/USA_StreetAddress.loc"
  MatchFields = "Addr ADDRESS VISIBLE;Addr2 <none> VISIBLE;City <none> VISIBLE;State <none> VISIBLE;ZIP ZIP VISIBLE;ZIPExt <none> VISIBLE;Firm NAME VISIBLE"
  NameField = "NAME"
  StoreIDField = "STORE_ID"
  OutputFeatureClass = "C:/temp/sf_store.shp"
 
  # Setup Store Using Tabular Data
  arcpy.SetupStoreByTable_ba(Table, Locator, MatchFields, NameField, StoreIDField, OutputFeatureClass)
 
  # 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