Business Point Reports (Business Analyst)

Summary

This report shows a listing of businesses or shopping centers in a given area.

Usage

Syntax

BusinessReports_ba (BusinessLayer, ReportTemplates, OutputFolder, {InputFeatureLayer}, {IDField}, {StoreIDField}, {RingIDField}, {UseSelectedFeatures}, {InsertMap}, {ReportsOutputReportType}, {TERRITORY_LEVEL}, {SummarizationOptions}, {StoreNameField}, {ReportFormats})
ParameterExplanationData Type
BusinessLayer

The point layer that contains the business or shopping center 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.

  • TRUEUses selected points to summarize to the boundary layer.
  • FALSESummarizes 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.

  • TRUEInserts the map image.
  • FALSEDoes 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_BOUNDARYGenerates an individual report for each boundary in the boundary layer.
  • SINGLE_REPORTStitches all reports for all boundaries into a single report.
String
TERRITORY_LEVEL
(Optional)

Enter the scripting explanation here.

SummarizationOptions
(Optional)

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

  • INDIVIDUAL_FEATURESGenerates a report for each trade area boundary.
  • WHOLE_LAYEREach variable in the report is summarized for all the boundaries.
  • BOTH_FEATURES_AND_LAYERGenerates 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
(Optional)

Select the desired report output format.

  • Simple XML
  • PDF
  • HTML
  • CSV
  • ZIP
  • XLSV
  • Stripped XLSX
String

Code Sample

BusinessReports Example (Stand-alone Script)
# Create the geoprocessor object
# 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("C:\Program Files\ArcGIS\Desktop10.0\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"
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, Business Summary Report, ReportOut, BoundaryInput, AreaId, StoreID, RingID)
 
# Release extension license 
arcpy.CheckInExtension("Business")
 
except:
print arcpy.GetMessages(2)

Environments

This tool does not use any geoprocessing environments

Related Topics

Licensing Information

ArcView: Requires Business Analyst
ArcEditor: Requires Business Analyst
ArcInfo: Requires Business Analyst

11/8/2010