ArcMap

Profile Segmentation Report

Available with Business Analyst license.

Summary

Shows the Tapestry segments and summary groups that most accurately reflect your customer records and compares your customer profile to the Profile Segmentation Report of your base geography.

Learn more about how the Profile Segmentation Report works

Usage

  • Usually, the Target Segmentation Profile is based on customer records.

  • If you want to use volumetric data instead of the distribution of customers in each segment, you must create the profile with volume information.

  • The Base Segmentation Profile can be generated using the Create Profile by Area Summation tool.

  • Customers in the Target Segmentation Profile should be wholly contained within the Base Segmentation Profile.

  • If you are unclear what to use as the Base Segmentation Profile, you can use the whole United States.

  • The segmentation base can be generated using total adult population or total households.

  • Total adult population includes individuals 18 years old or older.

  • By default, percent penetration is calculated by dividing the target total for each segment by the base total and multiplying by 100. You can change the base multiplier to 1,000 by adjusting this value in Business Analyst > Preferences on the Analysis tab.

Syntax

arcpy.ba.CustTapestryProfile(BaseProfile, TargetProfile, {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
SelectedBaseProfileResult
(Optional)

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

String
SelectedTargetProfileResult
(Optional)

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

String
SortEnable
(Optional)

Provides options to sort the Profile Segmentation Report.

  • True —Allows user-defined sorting.
  • False —Does 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 Profile Segmentation Report Report.

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

Select the sorting order of the sort field.

  • Ascending —Sorts the sort field from low to high value.
  • Descending —Sorts 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
[ReportFormats,...]
(Optional)

The format of the output report

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

Code sample

CustTapestryProfile example (stand-alone script)

# Name: CustTapestryProfile.py
# Description: Generates a Tapestry report based on pre-generated profiles.
# 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 Profile Segmentation Report tool
  BaseSeg = "C:/temp/Profile/Profile.xml"
  TargetSeg = "C:/temp/Profile1/Profile.xml"
  OutPath = "C:/temp/Output_Segmentation2"
 
# Create Profile Segmentation Report
  arcpy.CustTapestryProfile_ba(BaseSeg, TargetSeg, OutPath)
 
# 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