Quick Reports (Business Analyst)

License Level:BasicStandardAdvanced

Summary

Quickly runs reports for single or multiple sites.

Usage

Syntax

QuickReports_ba (InputFeatureLayer, IDField, BDSFeatureClass, ReportTemplates, OutputFolder, {StoreIDField}, {RingIDField}, {UseSelectedFeatures}, {InsertMap}, {ReportsOutputReportType}, {TERRITORY_LEVEL}, {SummarizationOptions}, {StoreNameField}, {OutputReportList}, {ReportStyle}, {ReportFormats})
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.

  • TrueGenerates reports for selected features.
  • FalseGenerates reports for all features. This is the default.
Boolean
InsertMap
(Optional)

Inserts a map from ArcMap into an applicable report template.

  • TrueInserts map image.
  • FalseDoes 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_BOUNDARYGenerates an individual report for each boundary in the boundary layer.
  • SINGLE_REPORTStitches 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_FEATURESGenerates a report for each trade area boundary.
  • WHOLE_LAYEREach variable in the report is summarized for all the boundaries.
  • BOTH_FEATURES_AND_LAYERGenerates 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
OutputReportList
(Optional)

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

File
ReportStyle
(Optional)

Select the report style for your reports.

  • ScreenThis report format will display a modern look and feel using a more visually pleasing format.
  • PaperThis report format will display a classic look and feel using a more generic style.
String
ReportFormats
(Optional)

Select the desired report output format.

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

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("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 Quick Reports tool
  Boundary = "C:/temp/TradeArea.shp"
  Id = "AREA_ID"
  Bds = "C:/ArcGIS/Business Analyst/US_2013/Data/BDS/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

Related Topics

Licensing Information

ArcGIS for Desktop Basic: Requires Business Analyst
ArcGIS for Desktop Standard: Requires Business Analyst
ArcGIS for Desktop Advanced: Requires Business Analyst
3/3/2014