ArcMap

Match Level Summary Report

Available with Business Analyst license.

Summary

Creates a report that assigns customer records to one of four match levels based on the geographic code assigned to each customer using the address information from your customer file.

Learn more about how Match Level Summary Report (Business Analyst) works

Usage

  • The customer layer must be a point feature class.

  • You can only use this report on customer layers that were created with Business Analyst or Address Coder.

  • Check the Use Selected Features Only check box if you want to examine a subset of customer records.

  • You can regeocode your file after you make edits to the address records if you want to improve the statistics in the report.

Syntax

arcpy.ba.MatchLevelSR(CustomerLayer, CustomerLayerDescr, OutputDirectoryParameterName, {UseSelectedFeatures}, {TitleParameterName}, {ReportFormats})
ParameterExplanationData Type
CustomerLayer

The point input feature class containing the customer layer. Typically, this will be a Business Analyst customer layer.

Feature Layer
CustomerLayerDescr

Description or alias for the term customer. For example, this could be patients, subscribers, customers, and so forth.

String
OutputDirectoryParameterName

The output directory that will contain the report.

Folder
UseSelectedFeatures
(Optional)

Generates a report on selected features of the customer layer.

  • TRUE —Generates the Match Level Summary Report on selected features.
  • FALSE —Generates the Match Level Summary Report on all features. This is the default.
Boolean
TitleParameterName
(Optional)

Title for the report.

String
ReportFormats
[ReportFormats,...]
(Optional)

Select the desired report output format.

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

Code sample

MatchLevelSR example (stand-alone script)

# Name: MatchLevelSR.py
# Description: Generates a report with how accurately a customer file geocoded in the San Francisco market.
# 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 Match Level Summary Report tool
  Customers = "C:/temp/sf_cust.shp"
  OutPath = "C:/temp/Output_Segmentation"
 
# Create Match Level Summary Report
  arcpy.MatchLevelSR_ba(Customers, "Customers", OutPath)
 
# 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