Batch Reports (Business Analyst)

Summary

Allows you to batch reports and run them at a later time.

Usage

• Batch one or more reports to be processed in the order that the reports are added.

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

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

• The layer to summarize is usually ESRI business 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.

• Learn more about the analysis layer setup

• If selecting an ESRI 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.

• Use the Stitch Reports parameter to combine two or more reports for each feature in the input polygon.

Syntax

BatchReports_ba (Boundaries, BDSFeatureClass, ReportTemplates, OutputFolder, {StitchReports}, {InsertMap}, {ReportStyle}, {ReportFormats})

Parameter	Explanation	Data Type
Boundaries [[Layer, {ID field}, {Store ID field}, {Ring ID field}, {Use selected}],...]	The input feature class that defines the boundary layers for which the reports will be generated.	Value Table
BDSFeatureClass	The input feature class that contains the data from which the reports will be generated.	Feature Layer
ReportTemplates [ReportTemplates,...]	Selects from a list of predefined or custom report templates in Business Analyst.	String
OutputFolder	The output directory that will contain the reports.	Folder
StitchReports (Optional)	Takes the report templates selected in the Create Reports parameter and stitches them into a single report based on the order they are added. True —Generates stitched reports. False —Generates individual reports for each boundary layer.	Boolean
InsertMap (Optional)	Determine if map image will be inserted if supported by selected report(s). True —Inserts map image into report based on the current view in ArcMap. False —Will not insert map image into report based on the current view in ArcMap.	Boolean
ReportStyle (Optional)	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
ReportFormats (Optional)	The report output format. Simple XML — PDF — HTML — CSV — ZIP — XLSV — Stripped XLSX —	String

Code Sample

BatchReports Example (Stand-alone Script)

# Name: BatchReports.py
# Description: Places an Age report in the batch queue.
# Author: ESRI

# Import system modules
import arcview
import arcpy

arcpy.ImportToolbox("C:\Program Files\ArcGIS\Desktop10.0\ArcToolbox\Toolboxes\Business Analyst Tools.tbx")
 
try:
# Acquire extension license 
arcpy.CheckOutExtension("Business")
    
# Define input and output parameters for the Batch Reports tool

TAs = "C:\\temp\\TradeArea.shp' AREA_ID STORE_ID RING false"
InputGeo = "C:/Program Files/ArcGIS/Desktop10.0/Business Analyst/Data/BDS/esri_bg.bds"
Rpts = "Age"
OutPath = "C:/temp"
 
# Create batch reports

arcpy.BatchReports_ba(TAs, InputGeo, Rpts, OutPath, "REPORT_PER_BOUNDARY")

# Release extension license 

arcpy.CheckInExtension("Business") 
 
except:
  print arcpy.GetMessages(2)

Environments

This tool does not use any geoprocessing environments

Licensing Information

ArcView: Requires Business Analyst

ArcEditor: Requires Business Analyst

ArcInfo: Requires Business Analyst