ArcMap

Benchmark Report

Available with Business Analyst license.

Summary

A comparative report that benchmarks two or more trade areas based on selected volumetric data (typically demographic data).

Usage

  • When selecting more than a handful of variables or trade areas to be displayed as columns, choose the export option for Excel instead of a Crystal Report .RPT due to formatting restrictions.

  • All results will automatically be stored in the Project/Reports folder.

  • The Benchmarks can only be made on variables that exist in both trade areas being compared.

  • Variables and trade areas can be shown as either rows or columns.

  • When benchmarking all trade areas against a single trade area, the average or the median of all the trade areas is calculated and used as the benchmark.

Syntax

arcpy.ba.BenchmarkReport(IN_IN_BDS_FEATURE_LAYER, IN_SELECTED_SUMMARIZATIONS, BOUNDARY_LAYERS, {IN_TA_FIELDS}, {IN_BENCHMARK_OPTIONS}, {IN_BENCHMARK_TA}, {InLayoutOptions}, {InSortTA}, {InSortTAField}, {InSortTADescend}, {OutFolder}, {NeedReportOutput}, {OutReportName}, {BenchmarkReport}, {NeedExcelOutput}, {NeedTableOutput}, {ReportFormats}, {UseOnlineData})
ParameterExplanationData Type
IN_IN_BDS_FEATURE_LAYER

The input layer containing the variables to be used in the report.

Feature Layer
IN_SELECTED_SUMMARIZATIONS
[IN_SELECTED_SUMMARIZATIONS,...]

The selected variables from the Input Data Layer to be used in the report.

String
BOUNDARY_LAYERS
[[Layer, {Area ID Field}, {Store Name Field}, {Area Description Field}, {Selection}, {Single ID}],...]

The trade area(s) or boundary layers to be used for benchmarking.

Value Table
IN_TA_FIELDS
[IN_TA_FIELDS,...]
(Optional)

The fields of the trade areas that will appear on the report.

String
IN_BENCHMARK_OPTIONS
(Optional)

Determines the desired approach to compare the trade area values against a benchmark.

  • NONE —Compares the selected variables in the report against the totals of those variables in all the trade areas.
  • USE_AVERAGE —Compares the selected variables in the report against an average of those variables in all trade areas.
  • USE_MEDIAN —Compares the selected variables in the report against a median of those variables in all trade areas.
  • USE_TRADE AREA —Compares the selected variables in the report against the totals of those variables in a selected trade area.
String
IN_BENCHMARK_TA
(Optional)

The trade used as the benchmark to compare against all other trade areas.

String
InLayoutOptions
(Optional)

Determines the orientation of the selected variables in the report.

  • VARIABLES_IN_COLUMNS —Outputs the report with the variables in columns and the trade areas in row.
  • VARIABLES_IN_ROWS —Outputs the report with the variables in rows and the trade areas in columns.
String
InSortTA
(Optional)

Defines how the report will be sorted.

  • True —Sorts the report by the trade area.
  • False —Does not sort the trade area.
Boolean
InSortTAField
(Optional)

The field in the trade area that will be used for sorting.

String
InSortTADescend
(Optional)

Determines if the trade areas will be sort in descending order.

  • True —The trade areas will be sorted in descending order.
  • False —The trade areas will not be sorted in descending order.
Boolean
OutFolder
(Optional)

The report output directory folder.

Folder
NeedReportOutput
(Optional)

Determines if a formatted report will be generated.

  • CREATE_REPORT —Select this option to generate a formatted report.
  • DONT_CREATE_REPORT —Will not generate a formatted report.
Boolean
OutReportName
(Optional)

The name that will appear on the report.

String
BenchmarkReport
(Optional)

Names the report for use/access in the Business Analyst reports wizard.

String
NeedExcelOutput
(Optional)

Select this option to export the report as an Excel output.

  • CREATE_EXCEL —Output is in Excel format.
  • DONT_CREATE_EXCEL —Output will not be in Excel format.
Boolean
NeedTableOutput
(Optional)

Select this option to export the report as a dBASE output.

  • CREATE_TABLE —Output is in dBASE format.
  • DONT_CREATE_TABLE —Output will not be in dBASE format.
Boolean
ReportFormats
(Optional)

Select the desired report output format.

  • Simple XML
  • PDF
  • HTML
  • CSV
  • ZIP
  • XLSX
  • Stripped XLSX
String
UseOnlineData
(Optional)

Select to access online Business Analyst data to use in the analysis.

  • True —Allows you to acess online Business Analyst data.
  • False —You will only have access to locally loaded Business Analyst data. This is the default.
Boolean

Code sample

BenchmarkReport example (stand-alone script)

# Name: BenchmarkReport.py
# Description: Benchmarks current total households and current year total population from drive time trade areas generated for the same location from different years.
# 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 Benchmark Report tool
  InputPath = "C:/ArcGIS/Business Analyst/US_2022/Data/Demographic Data/BlockGroups_bg.bds"
  SelectedVars = "TOTHH_CY;TOTHH_FY"
  Boundary = "C:/My Output Data/Projects/Default Projects/Trade Areas/Drive Time New.shp"
  TAFields = "AREA_ID;NAME;AREA_DESC;ALL"
   
 
# Create Benchmark Report output file
  arcpy.BenchmarkReport_ba(InputPath,
	  SelectedVars,
	  Boundary,
	  TAFields)
 
# 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