ArcMap

Create Trade Area From Online Geography Levels

Available with Business Analyst license.

Summary

Generates trade areas based on standard geographic units from ArcGIS Online. Note that you must be signed into ArcGIS to use this tool.

Usage

  • The spatial reference of the output feature class will be the same as the input geography boundary layer.

  • Use the Append Table Attributes to Output Feature Class option to include the demographic data of an Esri dataset in the output trade areas.

  • The Table Containing Matching Geography IDs must be in a format compatible with ArcMap. Your tabular data can be in the form of a database file format (.dbf) file, a comma- or tab-delimited text (.txt) file, or a relational database management system (RDBMS).

  • All nonmatching ZIP Codes will be excluded in the output trade area.

  • Nonmatching ZIP Codes are ZIP Code records in the Table Containing Matching Geography IDs that are not valid and do not have a corresponding feature in the input geography boundary layer.

  • If you want to select from a list of available geographic features to create a study area, you can use the Trade Area wizard in ArcMap. Selecting geographic features is not available as a geoprocessing tool.

  • In ArcMap, trade areas will only be created for features that are within the active study area or analysis extent.

Syntax

arcpy.ba.GPCreateTAFromOnlineStandardGeographyLevels(OnlineStdLayerID, InputGeographyUnitsTable, InputGeographyUnitsIdField, InputHandleDuplicateBehavior, OutputFeatureClass, {InputAppendVisibleFields}, {InputGeographyUnitsStoreIdField}, {Dissolve})
ParameterExplanationData Type
OnlineStdLayerID

The input level used to build the trade area.

Feature Layer
InputGeographyUnitsTable

The input table used to select the standard geography units that will define the trade area.

Table View
InputGeographyUnitsIdField

The associated geography ID field used to select the geographic units from the input geography boundary layer.

Field
InputHandleDuplicateBehavior

Allows you to filter duplicate fields in the table containing matching geographic IDs.

  • "SUMMARIZE_FIELD" —If a duplicate record exists, this option will summarize the duplicate fields if the Append Fields From Geography Boundary To Output Feature Class option is selected.
  • "USE_FIRST_FEATURE" —If a duplicate record exists, this option will choose the first record in the table. Any tabular data associated with that record can be appended to the output feature class. This option only appends the data of the first record and ignores any others.
String
OutputFeatureClass

The feature class that will contain the trade area features.

Feature Class
InputAppendVisibleFields
(Optional)

Appends the fields from the geography boundary to the output feature class.

  • TRUE —Appends fields to the output feature class.
  • FALSE —Does not append fields to the output feature class. This is the default.
Boolean
InputGeographyUnitsStoreIdField
(Optional)

This field assigns the same standard geography units to several stores.

Field
Dissolve
(Optional)

This option dissolves the output based on the selected Store ID.

  • TRUE —Dissolves boundaries based on selected Store ID.
  • FALSE —Does not dissolves boundaries. This is the default.
Boolean

Code sample

CreateTAFromOnlineGeographyLevels example (stand-alone script)

# Name: CreateTAFromOnlineGeographyLevels.py
# Description: The following stand-alone script demonstrates how to use the CreateTAFromOnlineGeographyLevels tool.
# 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")

# Acquire extension license
arcpy.CheckOutExtension("Business") 
 
# Define input and output parameters for the Create Trade Area From Online Geography Levels tool.
# Please note that your paths may be different.
InputOnlineLayer = "US.Zip5"
InputGeographyUnitsTable = "C:/ArcGIS/Business Analyst/US_2022/Datasets/Tutorial/sf_custs.dbf"
InputGeographyUnitsIdField= "ZIP"
InputHandleDuplicateBehavior = "USE_FIRST_FEATURE"
OutputFeatureClass = "C:/temp/CreateTAO.shp"
InputAppendVisibleFields = "TRUE"
InputGeographyUnitsStoreIdField = "STORE_ID"
Dissolve = "FALSE"

# Create standard online geography based trade area
arcpy.CreateTAFromOnlineGeographyLevels_ba(InputOnlineLayer,
						InputGeographyLevelIdField,
						InputGeographyUnitsTable,
						InputGeographyUnitsIdField,
						InputHandleDuplicateBehavior,
						OutputFeatureClass,
						InputAppendVisibleFields,
						InputGeographyUnitsStoreIdField,
						Dissolve)
    
# 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