ArcMap

Quick Reports

Available with Business Analyst license.

Summary

Quickly runs reports for single or multiple sites.

Usage

  • Creates one or more reports for a given boundary layer.

  • This tool should be primarily used to create reports for Business Analyst trade areas.

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

  • The layer to summarize is usually the Esri data that comes standard with Business Analyst but can be any boundary layer that contains quantifiable data that has been set up using the Analysis Layer Setup function.

  • If selecting a Business Analyst dataset to aggregate data, choose the smallest level of geography to improve accuracy. For example, selecting the block group data will provide the greatest amount of accuracy for creating reports for trade areas.

  • The REPORT_PER_BOUNDARY option for the ReportsOutputReportType parameter is the standard default for all Business Analyst reports. This option will only be available if multiple trade areas are selected. For example, if a user had two trade areas they wanted to report on (such as a Static Ring trade area and a Drive Time trade area) and they wanted to run three separate report types (like Age, Population, and Household reports), then selecting this option would create an output file for each trade area and each report.

  • The SINGLE_REPORT option from the ReportsOutputReportType parameter will stitch all selected reports and trade areas into a single report file. For example, if a user had two trade areas they wanted to report on (such as a Static Ring trade area and a Drive Time trade area) and they wanted to run three separate report types (like Age, Population, and Household reports), then selecting this option would create one output file with all the trade areas and all the selected reports stitched together. It is important to note that this option will not sum up all the report data of all the trade areas in the report (see Summarization Options).

  • The INDIVIDUAL_FEATURES option from the SummarizationOptions parameter will generate a report for each trade area boundary. For example, if a three-ring trade area was selected as the input boundary layer and a Demographic and Income report was selected for the report type, the output would be a Demographic and Income report for each of the rings in the three-ring trade area. This is the standard default for all Business Analyst reports.

  • The WHOLE_LAYER option from the SummarizationOptions parameter will take each variable in the report and summarize them for all the boundaries. For example, if a three-ring trade area was selected as the input boundary layer and a Demographic and Income report was selected for the report type, the output would be a single Demographic and Income report summarizing all three rings into a single report.

  • The OutputReportsList parameter is only required as an input to the ReportFile parameter from the Export Reports tool.

  • The InsertMap parameter uses the Business Analyst default basemap. If you would like to use a different basemap (in the current data view), then turn off background processing in the geoprocessing options.

  • Some reports, including the Demographic and Income Report, do not have space for a map image to be included.

Syntax

QuickReports_ba (InputFeatureLayer, IDField, BDSFeatureClass, ReportTemplates, OutputFolder, {StoreIDField}, {RingIDField}, {UseSelectedFeatures}, {InsertMap}, {ReportsOutputReportType}, {TERRITORY_LEVEL}, {SummarizationOptions}, {StoreNameField}, {OutputReportsList}, {ReportFormats}, {ReportStyle}, {Header1Field}, {Header2Field})
ParameterExplanationData Type
InputFeatureLayer

The boundary layer that will be used to generate the reports. This boundary layer is usually a Business Analyst trade area.

Table View
IDField

A unique identifier for each polygon in the boundary layer.

Field
BDSFeatureClass

The layer that contains the data that will be used to generate the report.

Feature Layer
ReportTemplates
[ReportTemplates,...]

Report templates that will be created for each feature in the boundary layer.

String
OutputFolder

Creates a new folder that will store the reports generated by this tool.

Folder
StoreIDField
(Optional)

The store ID associated with each trade area.

Field
RingIDField
(Optional)

The ring ID associated with each trade area.

Field
UseSelectedFeatures
(Optional)

Generates a report on selected features of the trade area layer.

  • True —Generates reports for selected features.
  • False —Generates reports for all features. This is the default.
Boolean
InsertMap
(Optional)

Inserts a map from ArcMap into an applicable report template.

  • True —Inserts map image.
  • False —Does not insert map image. This is the default.
Boolean
ReportsOutputReportType
(Optional)

This option allows a user to select between generating individual reports per boundary or stitching all reports into a single report file.

  • REPORT_PER_BOUNDARY —Generates an individual report for each boundary in the boundary layer.
  • SINGLE_REPORT —Stitches all reports for all boundaries into a single report.
String
TERRITORY_LEVEL
(Optional)

Select a layer created using the Territory Manager.

String
SummarizationOptions
(Optional)

This option determines how the data will be displayed on a report.

  • INDIVIDUAL_FEATURES —Generates a report for each trade area boundary.
  • WHOLE_LAYER —Each variable in the report is summarized for all the boundaries.
  • BOTH_FEATURES_AND_LAYER —Generates a report for each trade area boundary, and at the end of the report, each variable in the report is summarized for all the boundaries.
String
StoreNameField
(Optional)

The store name associated with each trade area.

Field
OutputReportsList
(Optional)

This document lists the Windows directory the reports were saved to and the list of reports selected to be run.

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

Select the desired report output format.

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

Select the report style for your reports.

  • Screen —This report format will display a modern look and feel using a more visually pleasing format.
  • Paper —This report format will display a classic look and feel using a more generic style.
String
Header1Field
(Optional)

Optional description on the report header.

Field
Header2Field
(Optional)

Optional sub-description on the report header.

Field

Code sample

QuickReports example (stand-alone script)

# Name: QuickReports.py
# Description: Runs a Demographic and Income report on a selected trade area.
# Author: Esri

# Import system modules
import arcview
import arcpy

arcpy.ImportToolbox(r"C:\Program Files (x86)\ArcGIS\Desktop10.6\Business Analyst\ArcToolbox\Toolboxes\Business Analyst Tools.tbx")

try:
# Acquire extension license 
  arcpy.CheckOutExtension("Business") 
 
# Define input and output parameters for the Quick Reports tool
  Boundary = "C:/temp/TradeArea.shp"
  Id = "AREA_ID"
  Bds = "C:/ArcGIS/Business Analyst/US_2017/Data/Demographic Data/esri_bg.bds"
  Output = "C:/temp"
  Rpt = "Demographic and Income Report"
 
# Create Quick reports
  arcpy.QuickReports_ba(Boundary, Id, Bds, Rpt, Output)
 
# Release extension license 
  arcpy.CheckInExtension("Business")
 
except:
  print arcpy.GetMessages(2)

Environments

This tool does not use any geoprocessing environments.

Licensing information

  • ArcGIS Desktop Basic: Requires Business Analyst
  • ArcGIS Desktop Standard: Requires Business Analyst
  • ArcGIS Desktop Advanced: Requires Business Analyst

Related topics