ArcMap

Business Point Reports

Available with Business Analyst license.

Summary

This report shows a listing of businesses in a given area.

Usage

  • The available reports are dependent on the point layer selected.

  • If a Business point layer is selected, you can select one of two reports: the Business Summary report or the Detailed Summary report.

  • This tool only functions when selecting the native Business point data that comes standard with Business Analyst

  • 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

arcpy.ba.BusinessReports(BusinessLayer, ReportTemplates, OutputFolder, {InputFeatureLayer}, {IDField}, {StoreIDField}, {RingIDField}, {UseSelectedFeatures}, {InsertMap}, {ReportsOutputReportType}, {TERRITORY_LEVEL}, {SummarizationOptions}, {StoreNameField}, {ReportFormats}, {ReportStyle}, {Header1Field}, {Header2Field})
ParameterExplanationData Type
BusinessLayer

The point layer that contains the business points you wish to report on.

Feature Layer
ReportTemplates
[ReportTemplates,...]

Select from a list of standard business point report templates.

String
OutputFolder

The report is created in this output directory.

Folder
InputFeatureLayer
(Optional)

This layer defines the mapping extent at which the Business Points Report will run. Only points that intersect this boundary will be included in the report.

Feature Layer
IDField
(Optional)

The area ID associated with each trade area. For trade areas derived from Business Analyst this will be a combination of the store ID and the ring ID.

Field
StoreIDField
(Optional)

The store ID associated with each trade area.

Field
RingIDField
(Optional)

The ring ID associated with each trade area.

Field
UseSelectedFeatures
(Optional)

Uses selected points to summarize to the boundary layer.

  • TRUE —Uses selected points to summarize to the boundary layer.
  • FALSE —Summarizes the points to the boundary layer on all features. This is the default.
Boolean
InsertMap
(Optional)

Inserts a map from ArcMap into an applicable report template.

  • TRUE —Inserts the map image.
  • FALSE —Does not insert the map image.
Boolean
ReportsOutputReportType
(Optional)

This option allows a user to select between generating individual reports per boundary or stitching all reports into a single report file.

  • REPORT_PER_BOUNDARY —Generates an individual report for each boundary in the boundary layer.
  • SINGLE_REPORT —Stitches all reports for all boundaries into a single report.
String
TERRITORY_LEVEL
(Optional)

Select a layer created using the Territory Manager.

String
SummarizationOptions
(Optional)

This option determines how the data will be displayed on a report

  • INDIVIDUAL_FEATURES —Generates a report for each trade area boundary.
  • WHOLE_LAYER —Each variable in the report is summarized for all the boundaries.
  • BOTH_FEATURES_AND_LAYER —Generates a report for each trade area boundary, and at the end of the report, each variable in the report is summarized for all the boundaries.
String
StoreNameField
(Optional)

The store name associated with each trade area.

Field
ReportFormats
[ReportFormats,...]
(Optional)

Select the desired report output format.

  • Simple XML
  • PDF
  • HTML
  • CSV
  • ZIP
  • XLSX
  • Stripped XLSX
String
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
Header1Field
(Optional)

Optional description on the report header.

Field
Header2Field
(Optional)

Optional sub-description on the report header.

Field

Code sample

BusinessReports example (stand-alone script)

# Name: BusinessReports.py
# Description: Summarizes business points in a customer derived trade area and outputs these results in a preformatted report.
# Author: Esri

# Import system modules
import arcview
import arcpy

arcpy.ImportToolbox(r"C:\Program Files (x86)\ArcGIS\Desktop10.8\Business Analyst\ArcToolbox\Toolboxes\Business Analyst Tools.tbx")
 
try:
# Acquire extension license 
  arcpy.CheckOutExtension("Business")
     
# Define input and output parameters for the Business Points Report tool

  Business = "C:/Projects/Default Project/Custom Data/Business.shp"
  Template = "Business Summary Report"
  ReportOut = "C:/My Output Data/Projects/Reports"
  BoundaryInput = "C:/My Output Data/Projects/Default Project/TradeAreas/Customer_Derived_TradeAreas.shp"   
  AreaId = "AREA_ID"
  StoreID = "STORE_ID"
  RingID = "RING"
   
	   	   
# Create the Business Points Report
  arcpy.BusinessReports_ba(Business,
	  Template,
	  ReportOut,
	  BoundaryInput,
	  AreaId,
	  StoreID,
	  RingID)
 
# Release extension license 
arcpy.CheckInExtension("Business")

Environments

This tool does not use any geoprocessing environments.

Licensing information

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

Related topics