Market Potential Report (Business Analyst)

Summary

Measures the likely demand for a product or service for your market area by a specific geography level from market potential data.

Learn more about how Market Potential Report works

Usage

Syntax

MarketPotentialReport_ba (InputGeographyLevel, BaseProfile, TargetProfile, OutputDirectoryParameterName, {TitleParameterName}, {SegmentationBase}, {CreateThematicMap}, {ThematicMapField}, {OutputFeatureClass}, {ReportFormats})
ParameterExplanationData Type
InputGeographyLevel

The level of geography that will be used to calculate the Market Penetration.

Feature Layer
BaseProfile

The base profile used in the calculation of the index and percent penetration. This profile is usually based on the geographic extent of your customers.

Folder
TargetProfile

The target profile that will be compared to the base profile. Typically, this is based on your customers and is generated using the Segmentation Profile tools.

Folder
OutputDirectoryParameterName

The output directory that will contain the report.

Folder
TitleParameterName
(Optional)

Title for the report.

String
SegmentationBase
(Optional)

Defines the base for the profile.

  • Total Adult PopulationGenerates a profile using Total Adult Population (18+) as the base.
  • Total HouseholdsGenerates a profile using Total Households as the base.
String
CreateThematicMap
(Optional)

Select this option to generate a thematic map on a selected variable.

  • CREATE_THEMATICGenerates a thematic map.
  • NO_THEMATICDoes not generate a thematic map.
Boolean
ThematicMapField
(Optional)

Select the field to generate the thematic map.

  • Expected CustomersThe estimated number of adults or households that use a particular product or service.
  • Percent PenetrationThe measure of the percent of adults or households that use a particular product or service compared to the Total Households or Total Adults in the geography.
  • IndexMeasures the likelihood of adults or households in a specified area to exhibit certain consumer behavior compared to the U.S. nation average. The index is tabulated to represent a value of 100 as the overall demand for the base area. A value of more than 100 represents high demand and a value of less than 100 represents low demand.
String
OutputFeatureClass
(Optional)

The output feature class for the market potential report.

Feature Class
ReportFormats
(Optional)

Select the desired report output format.

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

Code Sample

MarketPotentialReport Example (Stand-alone Script)
# Name: MarketPotentialReport.py
# Description: Generates a market potential report based on ZIP Codes.
# 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 Market Potential Report tool
GeoLayer = "C:/Program Files/ArcGIS/Desktop10.0/Business Analyst/Data/BDS/esri_zip5.bds"
Base = "C:/My Output Data/Projects/Default Project/Segmentation/Profiles/Base/Profile.xml"
Target = "C:/My Output Data/Projects/Default Project/Segmentation/Profiles/Target/Profile.xml"
OutPath = "C:/My Output Data/Projects/Default Project/Reports/Market Potential"
 
# Create a Market Potential Report
arcpy.MarketPotentialReport_ba(GeoLayer, Base, Target, OutPath)
 
# 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