ArcMap

Customer Geographic Summary Report

Available with Business Analyst license.

Summary

Lists standard geographic distributions for your customer layer.

Usage

  • This report uses a point-in-polygon procedure to assign customers to a given geography and outputs them in a report format.

  • Use this report to outline the frequency and distribution of customer points for the base set of Business Analyst data layers. For example, you may want to know how many customers are in the State of California, in the county of San Diego, and in ZIP Code 92123.

  • Counts of customers will be gathered for the top 20 ranks:

    • States
    • ZIP Codes
    • Counties
    • Core-Based Statistical Areas (CBSA), formerly Metropolitan Statistical Areas

  • The customer layer must be a point feature class.

  • In ArcMap, reports will only be created for customer features that are within the active study area or analysis extent.

  • Customer points that do not fall inside the base Business Analyst layers will not be included in the report. For example, if a customer point is not within the United States state boundaries, it will not be counted in the report statistics.

Syntax

arcpy.ba.GeographicCustomerSummaryReport(CustomerLayer, ReportFile, {UseSelectedFeatures}, ReportTitle, {ReportFormats})
ParameterExplanationData Type
CustomerLayer

The input feature class containing the points for the customer distribution. In most cases, this will be a Business Analyst customer layer.

Input
ReportFile

Outputs the report to a directory for retrieval later.

File
UseSelectedFeatures
(Optional)

Generates a report on selected features of the customer layer.

  • True —Generates the Customer Geographic Summary Report on selected features.
  • False —Generates the Customer Geographic Summary Report on all features. This is the default.
Boolean
ReportTitle

Name and title for the report.

String
ReportFormats
(Optional)

Select the desired report output format.

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

Code sample

GeographicCustomerSummaryReport example (stand-alone script)

# Name: GeographicCustomerSummaryReport.py
# Description: Summarizes the geographic features associated with a sample customer dataset in San Francisco.
# 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 Geographic Summary Report tool
  Cust = "C:/temp/sf_cust.shp"
  OutputFile = "C:/temp/CustGeoRpt.rpt"
  Title = "Customer Summary Report"
 
# Create customer geographic summary reports
  arcpy.GeographicCustomerSummaryReport_ba(Cust, OutputFile, "false", Title)
 
# 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