Summary Reports (Business Analyst)

Available with Business Analyst license.

Summary

Creates infographic and summary reports for a boundary layer using standard or custom templates.

Usage

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

• This tool requires a locally stored dataset or a portal connection, such as ArcGIS Online.

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

• Variables used in each infographic and report template are contained in a variable list. You can access the variable lists using the data browser.

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

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

• To create an interactive infographic, select the HTML option for the Report Output Formats parameter.

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

Parameters

Dialog

Label	Explanation	Data Type
Boundary Layer	The boundary layer containing one or more polygons that will be used to create reports.	Feature Layer
Create Reports	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
Output 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—Selected report templates will be returned for each individual trade area polygon. This is the default. For the whole layer—Selected report templates will be returned representing only the full extent of the trade area. For both individual features and the whole layer—Selected report templates will be returned for both individual features and the whole layer.	String
Single Report (Optional)	Specifies whether a single output will be created or a separate file will be created for each report. Checked—All reports will be combined into a single output. Unchecked—A separate file will be created for each selected report. This is the default.	Boolean
Report Output 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 polygon's data.	Field
Report Title (Optional)	The title in the report header.	String
Report Subtitle (Optional)	The subtitle in the report header. The default value is Prepared by Business Analyst Pro.	String
Create Report Per Feature (Optional)	Specifies whether a single report or multiple reports will be created. Checked—A report will be created per feature. Unchecked—A single report will be created. This is the default.	Boolean
Add Infographic Header (Optional)	Specifies whether a header will be added to the infographic. Checked—A header will be added to the infographic. Unchecked—A header will not be added to the infographic. This is the default.	Boolean
Add Infographic Footer (Optional)	Specifies whether a footer will be added to the infographic. Checked—A footer will be added to the infographic. Unchecked—A footer will not be added to the infographic. This is the default.	Boolean
Add Infographic Data Source (Optional)	Specifies whether the source will be added to the infographic. Checked—The data source will be added to the infographic. Unchecked—The data source will not be added to the infographic. This is the default.	Boolean

Derived Output

Label	Explanation	Data Type
Output Files	The output report.	File

Python

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}, {report_per_feature}, {add_infographic_header}, {add_infographic_footer}, {add_infographic_data_source})

Name	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—Selected report templates will be returned for each individual trade area polygon. This is the default. WHOLE_LAYER—Selected report templates will be returned representing only the full extent of the trade area. BOTH_FEATURES_AND_LAYER—Selected report templates will be returned for both individual features and the whole layer.	String
single_report (Optional)	Specifies whether a single output will be created or a separate file will be created for each report. CREATE_SINGLE_REPORT—All reports will be combined into a single output. CREATE_REPORT_PER_TEMPLATE—A separate file will be created 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 polygon's data.	Field
title (Optional)	The title in the report header.	String
subtitle (Optional)	The subtitle in the report header. The default value is Prepared by Business Analyst Pro.	String
report_per_feature (Optional)	Specifies whether a single report or multiple reports will be created. CREATE_REPORT_PER_FEATURE—A report will be created per feature. CREATE_SINGLE_REPORT—A single report will be created. This is the default.	Boolean
add_infographic_header (Optional)	Specifies whether a header will be added to the infographic. ENABLE_INFOGRAPHIC_HEADER—A header will be added to the infographic. DISABLE_INFOGRAPHIC_HEADER—A header will not be added to the infographic. This is the default.	Boolean
add_infographic_footer (Optional)	Specifies whether a footer will be added to the infographic. ENABLE_INFOGRAPHIC_FOOTER—A footer will be added to the infographic. DISABLE_INFOGRAPHIC_FOOTER—A footer will not be added to the infographic. This is the default.	Boolean
add_infographic_data_source (Optional)	Specifies whether the data source will be added to the infographic. ENABLE_INFOGRAPHIC_DATA_SOURCE—The data source will be added to the infographic. DISABLE_INFOGRAPHIC_DATA_SOURCE—The data source will not be added to the infographic. This is the default.	Boolean

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", "CREATE_REPORT_PER_FEATURE")

Environments

Current Workspace, Data Source, Geographic Transformations

Licensing information

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