ArcMap

Batch Reports

Available with Business Analyst license.

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 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.

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

  • 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.

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.

  • REPORT_PER_BOUNDARY —Generates an individual report for each boundary in the boundary layer.
  • STITCH_REPORTS —Stitches all reports.
  • SINGLE_REPORT —Stitches all reports for all boundaries into a single report.
  • STITCHED_BY_BOUNDARY —Stitches all reports for all boundaries.
String
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
  • XLSX
  • 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(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 Batch Reports tool

  BoundaryLayer = "C:/temp/TradeArea.shp' AREA_ID STORE_ID RING false"
  InputFC = "C:/ArcGIS/Business Analyst/US_2017/Data/Demographic Data/esri_bg.bds"
  Template = "Executive Summary"
  OutPath = "C:/temp"
 
# Create batch reports

  arcpy.BatchReports_ba(BoundaryLayer,
	  InputFC,
	  Template,
	  OutPath)

# 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