ArcMap

Setup Store Using Existing Data

Available with Business Analyst license.

Summary

Imports stores that are in a shapefile format (already geocoded) and identifies them as stores for further analysis.

Usage

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

Syntax

arcpy.ba.SetupStoreByExistingData(InputFeatureLayer, NameField, StoreIDField, WayToSpecifyStoreIDField, CreateNewFeatureClass, OutputFeatureClass, {UsePictureSymbol}, {ImagePath}, {PictureSymbolSize})
ParameterExplanationData Type
InputFeatureLayer

The existing layer that contains your stores.

Feature Layer
NameField

Selects a field to be used to identify the store name.

Field
StoreIDField

The name used to identify the store ID.

String
WayToSpecifyStoreIDField

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

  • USE_EXISTING —Uses the existing Store ID Field. This is the default.
  • CREATE_NEW —Creates a new store ID field.
Boolean
CreateNewFeatureClass

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. This is the default
Boolean
OutputFeatureClass

The feature class that will contain the store points.

Feature Class
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

SetupStoreByExistingData example (stand-alone script)

# Name: SetupStoreByExistingData.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")

# Defines the parameters for the Setup Store Using Existing Data tool
  InputFeatureLayer = "C:/temp/sf_stores.shp"
  NameField = "NAME"
  StoreIDField = "STORE_ID"

# Sets up a new store layer based on an existing layer
  arcpy.SetupStoreByExistingData_ba(InputFeatureLayer, NameField, StoreIDField)

# 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