ArcMap

Assign By Trade Area

Available with Business Analyst license.

Summary

Assigns customers to stores by using existing trade areas.

Learn more about how Assign By Trade Area works

Usage

  • You cannot undo the assignment of customers to stores in an existing field.

  • Any customers that do not fall inside a trade area will not be assigned to a store.

  • If any of the trade areas are overlapping, you can remove trade area overlap before executing this tool.

  • You can remove trade area overlap using the Remove Trade Area Overlap tool.

Syntax

arcpy.ba.AssignCustomersByTA(InputFeatureLayer, IDField, CustomerLayer, LinkField, {UseSelectedFeatures}, {WayToDefineLinkField}, {CreateNewFeatureClass}, {OutputFeatureClass})
ParameterExplanationData Type
InputFeatureLayer

The trade area layer that will be used to assign customers to a store.

Feature Layer
IDField

The store ID field with which to assign customers.

Field
CustomerLayer

The customer layer used to make the customer assigments to each store.

Feature Layer
LinkField

The field that will be populated with the associated store ID.

String
UseSelectedFeatures
(Optional)

Customers are assigned by selected features of the customer layer.

  • True —Assigns selected customers to the trade area.
  • False —Assigns all customers to the trade area.
Boolean
WayToDefineLinkField
(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.
Boolean
CreateNewFeatureClass
(Optional)

Generates a new feature class based on the existing layer or uses the existing layer.

  • True —Creates a new feature class.
  • False —Does not create a new feature class. The original layer will be used.
Boolean
OutputFeatureClass
(Optional)

The feature class that will contain the customer features.

Feature Class

Code sample

AssignCustomersByTA example (stand-alone script)

# Name: AssignCustomersByTA.py
# Description: Assign customers located in trade areas generated in San Francisco County to select stores.
# 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 Assign by Trade Area tool
  TAPath = "C:/temp/TradeArea.shp"
  CustPath = "C:/temp/sf_cust.shp"
  StoreId = "STORE_ID"
  StoreLink = "STORE_ID"
 
# Create output file for Assign by Trade Area tool
  arcpy.AssignCustomersByTA_ba (TAPath,
	  CustPath,
	  StoreId,
	  StoreLink)
	 
# 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