ArcMap

Customer Demographic Comparison Report

Available with Business Analyst license.

Summary

Compares the demographic profiles of two customer files and reports on the differences.

Usage

  • The report results are more easily interpreted using medians and averages.

Syntax

arcpy.ba.CustomerDemographicComparisonReport(CustomerLayer, {UseSecondCustomerLayer}, UseSelectedCustomers, {SecondCustomerLayer}, {UseSelectedCustomersSelectedLayer}, InputBoundaryLayer, InputGeographyLevel, InputFieldsToProfile, ReportTitle, OutputFolder, {ReportFormats})
ParameterExplanationData Type
CustomerLayer

Select the primary customer layer to analyze.

Feature Layer
UseSecondCustomerLayer
(Optional)

Select this option to compare the first Customer Layer with this layer in the report.

  • TRUE —A second customer layer is used in the comparison report.
  • FALSE —Selected features of the first Customer Layer will be used in the comparison report. This is the default.
Boolean
UseSelectedCustomers

Select this option to compare the first Customer Layer against selected features of that same layer in the report.

  • TRUE —Selected features of the first Customer Layer are used in the comparison report.
  • FALSE —Selected features of the first Customer Layer will be not be used in the comparison report. A second customer layer will be selected and used for the comparison. tThis is the default.
Boolean
SecondCustomerLayer
(Optional)

The second customer layer used in the comparison report.

Feature Layer
UseSelectedCustomersSelectedLayer
(Optional)

Select this option to compare the first Customer Layer with selected features of the second Customer Layer in the report.

  • TRUE —Selected features of the second Customer Layer are used in the comparison report against the first Customer Layer.
  • FALSE —Selected features of the second Customer Layer will be not be used in the comparison report. The entire second customer layer will be used for the comparison. This is the default.
Boolean
InputBoundaryLayer

The boundary file that defines the extent of the customers to be analyzed.

Feature Layer
InputGeographyLevel

The input feature layer that contains the data that can be selected to be compared in the report. This will commonly be the Block Groups.

Feature Layer
InputFieldsToProfile
[InputFieldsToProfile,...]

Select from a list of available variables to compare. These variables are typically demographic variables.

Field
ReportTitle

Enter the name of the report.

String
OutputFolder

The file folder output path.

Folder
ReportFormats
(Optional)

Select the desired report output format.

  • Simple XML
  • PDF
  • HTML
  • CSV
  • ZIP
  • XLSX
  • Stripped XLSX
String

Code sample

CustomerDemographicComparisonReport example (stand-alone script)

# Name: CustomerDemographicComparisonReport.py
# Description: Compares the current year total population and future year total population on selected customers from the San Francisco customer layer against the balance of that customer 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") 
     
# Define input and output parameters for the Customer Demographic Comparison Report tool
  CustLayer = "C:/My Output Data/Projects/Default Project/CustLayers/sf_custs/CustomerLayer.shp"
  Extent = "C:/My Output Data/Projects/Default Project/TradeAreas/Customer_Derived_TradeAreas.shp"
  Geog = "C:/ArcGIS/Business Analyst/US_2022/Data/Demographic Data/BlockGroups_bg.bds"   
  Vars = "TOTPOP_CY;TOTPOP_FY"
  ReportName = "Customer_Demo_Report"
  ReportDir = "C:/My Output Data/Projects/Default Project/Reports/Customer Demographic Comparison Report"
   
	   	   
# Create the Customer Demographic Comparison Report
  arcpy.CustomerDemographicComparisonReport_ba(Cust,
	  Extent,
	  Geog,
	  Vars,
	  ReportName,
	  ReportDir)
 
# 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