Skip To Content

Summary Reports

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.

Syntax

SummaryReports_ba (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})
ParameterExplanationData Type
in_features

The boundary layer containing one or more polygons used to create reports.

Feature Layer
report_templates
[report_templates,...]

Select one or more summary report templates. You must be signed in to ArcGIS Online or have Business Analyst Data installed.

String
reports_folder

Select the output location to save summary reports.

Folder
summarization_options
(Optional)

How the data will be displayed on 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_LAYERReturns selected report templates for both individual features and the whole layer.
String
single_report
(Optional)

Generates reports per boundary or stitches all reports into a single report file.

  • CREATE_SINGLE_REPORT Stitches all reports together into a single output.
  • CREATE_REPORT_PER_TEMPLATE Generates separate files for each selected report. This is the default.
Boolean
formats
[formats,...]
(Optional)

Select the desired report output format. The default value is PDF.

String
store_id_field
(Optional)

The store ID associated with each boundary.

Field
store_name_field
(Optional)

The store name associated with each boundary.

Field
store_address_field
(Optional)

The store address associated with each trade area.

Field
store_latitude_field
(Optional)

The field containing your latitude coordinates (y field).

Field
store_longitude_field
(Optional)

The field containing your longitude coordinates (x field).

Field
ring_id_field
(Optional)

The ring ID associated with each boundary.

Field
area_description_field
(Optional)

Additional descriptive information associated with each boundary.

Field
title
(Optional)

Title on the report header.

String
subtitle
(Optional)

Subtitle on the report header. The default value is Prepared by Business Analyst Pro.

String

Code sample

SummaryReports example (Python window)

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

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

Licensing information

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

Related topics