Summary Reports (Business Analyst)

Available with Business Analyst license.

Summary

Populates and creates demographic style summary reports for any boundary layer using Esri report templates.

Usage

• Input layers should be polygons within the extent of the active dataset.

• Template names generally describe the type of data to be contained within.

• Reports can be generated for boundary layers or for multiple polygons within a boundary layer. Use the Summarization Options parameter to set how reports will be generated when one or more features are present.

• Business Analyst Data, used in summarizations and reports, is specified through the geoprocessing Data Source environment setting.

• When using ModelBuilder, you must create an output folder or select an existing folder before running Summary Reports.

• The Ring ID Field parameter controls the display of data for each polygon, with the lowest values presented first.

• The Area Description Field parameter values are displayed as output report headers that distinguish the data for each input polygon.

• To properly display data for the input sites with multiple polygons, the Store ID Field, Store Name Field, Ring ID Field, and Area Description Field parameters must be set.

Syntax

arcpy.ba.SummaryReports(in_features, report_templates, reports_folder, {summarization_options}, {single_report}, {formats}, {store_id_field}, {store_name_field}, {store_address_field}, {store_latitude_field}, {store_longitude_field}, {ring_id_field}, {area_description_field}, {title}, {subtitle})

Parameter	Explanation	Data Type
in_features	The boundary layer containing one or more polygons that will be used to create reports.	Feature Layer
report_templates [report_templates,...]	One or more report templates that will be used to create the summary report. You must be signed in to ArcGIS Online or have Business Analyst Data installed.	String
reports_folder	The output location where the summary reports will be saved.	Folder
summarization_options (Optional)	Specifies how the data will be displayed in a report. INDIVIDUAL_FEATURES —Returns selected report templates for each individual trade area polygon. This is the default. WHOLE_LAYER —Returns selected report templates representing only the full extent of the trade area. BOTH_FEATURES_AND_LAYER —Returns selected report templates for both individual features and the whole layer.	String
single_report (Optional)	Specifies whether a single output will be generated or if a separate file will be generated for each report. CREATE_SINGLE_REPORT —All reports will be combined into a single output. CREATE_REPORT_PER_TEMPLATE —A separate file will be generated for each selected report. This is the default.	Boolean
formats [formats,...] (Optional)	The report output format. The default value is PDF.	String
store_id_field (Optional)	The field that will be used to group data for each site in output reports. These field values are not displayed in the header.	Field
store_name_field (Optional)	The field values that will be displayed in the output report headers that identify the site corresponding to each polygon's data.	Field
store_address_field (Optional)	The store address associated with each trade area.	Field
store_latitude_field (Optional)	The field that will contain the latitude coordinates (y field).	Field
store_longitude_field (Optional)	The field that will contain the longitude coordinates (x field).	Field
ring_id_field (Optional)	The field that will control the presentation order of data for inputs with multiple polygons per site.	Field
area_description_field (Optional)	The field that will be displayed as the output template header with values corresponding to each input polygons' data.	Field
title (Optional)	The title on the report header.	String
subtitle (Optional)	The subtitle on the report header. The default value is Prepared by Business Analyst for ArcGIS Pro.	String

Derived Output

Name	Explanation	Data Type
output_files	The output report.	File

Code sample

SummaryReports example (Python window)

The following Python window script demonstrates how to use the SummaryReports function.

import arcpy
arcpy.env.baDataSource = "ONLINE;US;"
arcpy.ba.SummaryReports("TradeArea50", "Age 50+ Profile", r"C:\Temp", "INDIVIDUAL_FEATURES", "CREATE_REPORT_PER_TEMPLATE", "PDF", "ID", None, None, "STORE_LAT", "STORE_LONG", "RING", "AREA_DESC", "Age 50 Plus Store Trade Area", "Prepared By Business Analyst Pro")

Environments

Current Workspace, Data Source

Licensing information

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