Profile Volume Segmentation Report (Business Analyst)

License Level:BasicStandardAdvanced

Summary

Tool shows the tapestry segments and summary groups that most accurately reflect customer records and compares customer profiles to the tapestry profile of your base geography based on households or adult population and volume (sales).

Learn more about how Profile Volume Segmentation Report works

Usage

Syntax

TapestryProfileVolume_ba (BaseProfile, TargetProfile, VolumeType, {SelectedBaseProfileResult}, {SelectedTargetProfileResult}, {SortEnable}, {FieldsSort}, {SortWay}, {TitleParameterName}, OutputDirectoryParameterName, {ReportFormats})
ParameterExplanationData Type
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
VolumeType

Will modify explanation text and formatting of the volume information of the report to reflect your selection.

  • sales dollarsDisplays the volumetric data in the report as currency with no decimal places and references this data as sales dollars in the text of the report.
  • number of visitsExpresses the volumetric data in the report as whole numbers with no decimal places and references this data as number of visits in the text of the report.
  • dollars spentDisplays the volumetric data in the report as currency with two decimal places and references this data as dollars spent in the text of the report.
String
SelectedBaseProfileResult
(Optional)

Enter a new name of the base profile that will appear on your report.

String
SelectedTargetProfileResult
(Optional)

Enter a new name of the target profile that will appear on your report.

String
SortEnable
(Optional)

Provides options to sort the Customer Tapestry Profile Segmentation report.

  • TRUEAllows user-defined sorting.
  • FALSEDoes not allow user-defined sorting and defaults to sorting the report by Percent Composition.
Boolean
FieldsSort
(Optional)

Select the method that will be used to sort the volumetric data in the Customer Tapestry Profile Report.

  • Number in Target ProfileSorts report based on the total counts of the target profile by segment.
  • Percents of total targetSorts report based on percent value of the total counts of the target profile by segment.
  • Number in Base ProfileSorts report based on the total counts of the base profile by segment.
  • Percents of total baseSorts report based on the percent value of the total counts of the base profile by segment.
  • Penetration Per 100Sorts report based on the penetration rate per 100 households or adults in the base profile.
  • IndexSorts report based on Index value.
String
SortWay
(Optional)

The sorting order of the sort field.

  • AscendingSorts the sort field from low to high value.
  • DescendingSorts the sort field from high to low value.
String
TitleParameterName
(Optional)

Title for the report.

String
OutputDirectoryParameterName

The output directory that will contain the report.

Folder
ReportFormats
(Optional)

Select the desired report output format.

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

Code Sample

TapestryProfileVolume Example (Stand-alone Script)
# Name: TapestryProfileVolume.py
# Description: Creates a segmentation report on selected profiles.
# 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 Customer Tapestry Profile Segmentation Report tool
  BaseSeg = "C:/temp/Profile/Profile.xml"
  TargetSeg = "C:/temp/Profile1/Profile.xml"
  OutPath = "C:/temp/Output_Segmentation"
 
# Create Customer Tapestry Profile Segmentation Report
  arcpy.TapestryProfileVolume_ba(BaseSeg, TargetSeg, "sales dollars", 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

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