Average Drive-Time Report (Business Analyst)

License Level:BasicStandardAdvanced

Summary

Calculates the average drive time within trade areas.

Learn more about Average Drive-Time Report

Usage

Syntax

AverageDTReports_ba (InputFeatureLayer, StoreIDField, AreaDescriptionField, MeasureUnits, OutputFolder, {UseSelectedFeatures}, {StoreLayer}, {AssocStoreID}, {ReportTitle}, {ReportFormats})
ParameterExplanationData Type
InputFeatureLayer

The input feature class that defines the extent of the drive-time analysis.

Feature Layer
StoreIDField

Unique ID field in the trade area center (store) layer.

Field
AreaDescriptionField

Field used to describe or name each feature in the trade area layer.

Field
MeasureUnits

The units used with the distance values. By default, the units defined in the Business Analyst preferences will be selected.

  • Decimal Degrees
  • Feet
  • Kilometers
  • Meters
  • Miles
  • Nautical Miles
  • Yards
String
OutputFolder

The report is created in this output directory.

Folder
UseSelectedFeatures
(Optional)

Uses selected features to calculate the average drive times.

  • TrueUses selected features to calculate the average drive times.
  • FalseCalculates the average drive times on all features.
Boolean
StoreLayer
(Optional)

The input feature class containing center points for the report. In most cases, this will be a Business Analyst store layer. The average drive-time report will use the points in this layer as the starting point for calculating the average drive time.

Feature Layer
AssocStoreID
(Optional)

Unique ID field that defines the (store) layer.

Field
ReportTitle
(Optional)

Names the report for use/access in the Business Analyst reports wizard.

String
ReportFormats
(Optional)

Select the desired report output format

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

Code Sample

AverageDTReports Example (Stand-alone Script)
# Name: AverageDTReports.py
# Description:  Calculates the average drive time of a customer derived trade area output from Business Analyst.
# Author: Esri

# Import system modules
import arcview
import arcpy

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

  Input = "C:/My Output Data/Projects/Default Project/TradeAreas/Customer Derived Areas/TradeArea.shp"
  Id = "STORE_ID"
  AreaDesc = "AREA_DESC"
  Output = "C:/My Output Data/Projects/Default Project/Reports"
  Report = "Average Drive Time Report"
 
# Create Average Drive Time report
  arcpy.AverageDTReports_ba(Input, Id, AreaDesc, "Minutes", "Output false", "#", "#", sReport)
 
# Release extension license 
  arcpy.CheckInExtension("Business")
 
except:
  print arcpy.GetMessages(2)

Environments

This tool does not use any geoprocessing environments

Related Topics

Licensing Information

ArcGIS for Desktop Basic: Requires Business Analyst
ArcGIS for Desktop Standard: Requires Business Analyst
ArcGIS for Desktop Advanced: Requires Business Analyst
3/3/2014