ArcMap

Setup Customers Using Existing Data

Available with Business Analyst license.

Summary

Defines an output feature class based on an existing feature class as a customer file for use in the Analysis And Trade Areas tools.

Usage

  • Import customers that are already stored in a feature class—for example, a shapefile.

  • The existing customer layer must be a point feature class.

  • Customers should already be geocoded.

Syntax

arcpy.ba.SetupCustomersByExistingData(InputFeatureLayer, NameField, LinkField, {CreateNewFeatureClass}, {OutputFeatureClass})
ParameterExplanationData Type
InputFeatureLayer

The input feature layer.

Feature Layer
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
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. The original layer will be used. This is the default.
Boolean
OutputFeatureClass
(Optional)

The feature class that will contain the customer features.

Feature Class

Code sample

SetupCustomersByExistingData example (stand-alone script)

# Name: SetupCustomersByExistingData.py
# Description: Creates a customer layer using an existing point layer. 
# 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") 
 
# Sets up a new customer layer based on an existing layer
  CustPath = "C:/temp/sf_cust.shp"
  CustId = "CUST_ID"
  StoreId = "STORE_ID"
 
# Sets up a new customer layer based on an existing layer    
  arcpy.SetupCustomersByExistingData_ba(CustPath,
	  CustId,
	  StoreId)
 
# 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