Benchmark Report (Business Analyst)
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
| Parameter | Explanation | Data 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.
| String |
ReportFormats (Optional) |
Select the desired report output format.
| 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.
| String |
InSortTA (Optional) |
Defines how the report will be sorted.
| Boolean |
InSortTADescend (Optional) |
Determines if the trade areas will be sort in descending order.
| Boolean |
InSortTAField (Optional) |
The field in the trade area that will be used for sorting. | String |
OutFolder (Optional) |
The report output directory folder. | Folder |
NeedReportOutput (Optional) |
Determines if a formatted report will be generated.
| Boolean |
OutReportName (Optional) |
The name that will appear on the report. | String |
Benchmark Report (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.
| Boolean |
NeedTableOutput (Optional) |
Select this option to export the report as a dBASE output.
| Boolean |
UseOnlineData (Optional) |
Access online Business Analyst data to use in the analysis.
Select to access online Business Analyst data to use in the analysis.
| Boolean |
Code Sample
# 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("C:\Program Files (x86)\ArcGIS\Desktop10.2\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_2013/Data/BDS/esri_bg.bds"
Vars = "TOTHH_CY;TOTHH_FY"
TAnew = "C:/My Output Data/Projects/Default Projects/Trade Areas/Drive Time New.shp' AREA_ID;NAME;AREA_DESC;ALL"
TAold = "C:/My Output Data/Projects/Default Projects/Trade Areas/Drive Time Old.shp' AREA_ID;NAME;AREA_DESC;ALL"
# Create Benchmark Report output file
arcpy.BenchmarkReport_ba(InputPath, Vars, TAnew, TAold)
# Release extension license
arcpy.CheckInExtension("Business")
except:
print arcpy.GetMessages(2)