Available with Business Analyst license.
Summary
Profiles demographic attributes of customer data based on a selected demographic or custom data layer.
Usage
In ArcMap, analysis will only be completed on features that are within the active study area or analysis extent.
This tool creates a Demographic Query File that is used as an input to the Customer Prospecting by Demographic Data tool.
When defining the variance of the fields to profile, start with a high variance, for example, (+/-) 20 percent, to establish a general range and refine the variance further as needed.
Filling options allow you to define the upper and lower limits of the range of the demographic or data variables used to establish your customer profile.
Set your boundary layer to include the market to prospect.
Syntax
arcpy.ba.CustomerProfiling(CustomerLayer, InputBoundaryLayer, InputGeographyLevel, InputFieldsToProfile, InputProspectingFillingOptions, InputFillingVariance, OutputDMQFilePath, {UseSelectedFeatures})
Parameter | Explanation | Data Type |
CustomerLayer | The input feature layer containing customer points. | Feature Layer |
InputBoundaryLayer | The input feature layer that determines the extent at which the analysis will query and return results from the geography level layer. | Feature Layer |
InputGeographyLevel | The input feature class that contains the data to be used in the demographic query. | Feature Layer |
InputFieldsToProfile [InputFieldsToProfile,...] | The selected attributes (commonly demographic data) that will be used to define your profile from the geography level. | Field |
InputProspectingFillingOptions | The value ranges for the fields to profile.
| String |
InputFillingVariance | Sets the percentages by which the filling options will be read, for example, plus or minus 20 percent. | Double |
OutputDMQFilePath | The output file that stores the defined parameters (the definition query). This file is used as an input for the Customer Prospecting By Demographic Data tool. | String |
UseSelectedFeatures (Optional) | Defines which customers are used to generate the customer profile.
| Boolean |
Code sample
CustomerProfiling example (stand-alone script)
# Name: CustomerProfiling.py
# Description: Creates a profile of customers in San Francisco based on current year total households.
# 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")
# Define the parameters for the Customer Profiling tool
# Please note that your paths may be different.
CustomerLayer = "C:/temp/sf_cust.shp"
InputBoundaryLayer = "C:/temp/Boundary.shp"
InputGeographyLevel = "C:/ArcGIS/Business Analyst/US_2022/Data/Demographic Data/BlockGroups_bg.bds"
InputFieldsToProfile = "TOTHH_CY"
InputProspectingFillingOptions = "BOTH"
InputFillingVariance = "20"
OutputDMQFilePath = "C:/temp/DMQ_output.dmq"
# Create Customer Profiling output file
arcpy.CustomerProfiling_ba(CustomerLayer,
InputBoundaryLayer,
InputGeographyLevel,
InputFieldsToProfile,
InputProspectingFillingOptions,
InputFillingVariance,
OutputDMQFilePath)
# 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