Skip to main content

Summary Reports (Business Analyst Tools)

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.

  • The Preferred Report Style parameter's Modern option is only available for Esri reports.

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

  • 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, Site Name Field, Ring ID Field, and Area Description Field parameters must be set.

Parameters

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

Site 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 ArcGIS 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 for each 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 data 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

Preferred Report Style

(Optional)

Specifies the style that will be used for the Esri report.

  • Classic—The generated Esri report will use the traditional style. This is the default.

  • Modern—The generated Esri report will use the updated style.

String

Derived output

Label Explanation Data type

Output Files

The output report.

File

Environments

Current Workspace, Data Source, Geographic Transformations

Licensing information

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