Batch Reports (Business Analyst)

License Level:BasicStandardAdvanced

Summary

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

Usage

Syntax

BatchReports_ba (Boundaries, BDSFeatureClass, ReportTemplates, OutputFolder, {StitchReports}, {InsertMap}, {ReportStyle}, {ReportFormats})
ParameterExplanationData 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.

  • TrueGenerates stitched reports.
  • FalseGenerates individual reports for each boundary layer.
Boolean
InsertMap
(Optional)

Determine if map image will be inserted if supported by selected report(s).

  • TrueInserts map image into report based on the current view in ArcMap.
  • FalseWill not insert map image into report based on the current view in ArcMap.
Boolean
ReportStyle
(Optional)

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)

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 (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 Batch Reports tool

  TAs = "C:\\temp\\TradeArea.shp' AREA_ID STORE_ID RING false"
  InputGeo = "C:/ArcGIS/Business Analyst/US_2013/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

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