Import Segmentation Profile (Business Analyst Tools)

Summary

Generates a segmentation profile from a table.

Usage

Optimally, the input table should contain the Segment ID, Segment Name, Count, and Percent fields. If the table was built with volumetric data, the Total Volume and Average Volumetric fields should also be included.

Tip:

Remove any additional fields that exist in the input table before importing it.
The Segment ID and Count fields are required in the input table.
The Segment ID field values in the input table must exist in the active Business Analyst dataset.

The input table must be in a tabular format supported by ArcGIS Pro. Supported formats include the following:
- Geodatabase
- Database
- Feature layer attribute table
- dBASE
- Microsoft Excel
- Text, ASCII, and comma-separated values files (.csv)
If the Segment Name field does not exist in the input table, it will be added during the import process. The new field will be populated with values based on correlation to the Segment ID field.

If only a subset of Segment ID values are included in the input table, the balance of the full distribution of segments will be added during processing. The Count and Percent fields for these additions will be zero filled.

Label	Explanation	Data type
Input Table	The input table with segmentation information.	Table View
Segmentation Base	The segmentation base for the profile being created. Available options are provided by the segmentation dataset in use.	String
Output Profile	The name of the segmentation file that will be created.	File
Segment ID Field	A string field that contains the segmentation code.	Field
Count Field	A numeric field that contains segment count information.	Field
Total Volume Field (Optional)	A numeric field that contains volume information.	Field

arcpy.ba.ImportSegmentationProfile(in_table, segmentation_base, out_profile, segment_id_field, count_field, {total_volume_field})

Name	Explanation	Data type
in_table	The input table with segmentation information.	Table View
segmentation_base	The segmentation base for the profile being created. Available options are provided by the segmentation dataset in use.	String
out_profile	The name of the segmentation file that will be created.	File
segment_id_field	A string field that contains the segmentation code.	Field
count_field	A numeric field that contains segment count information.	Field
total_volume_field (Optional)	A numeric field that contains volume information.	Field

Code sample

ImportSegmentationProfile example (Python window)

The following Python window script demonstrates how to use the ImportSegmentationProfile function.

import arcpy
arcpy.ba.ImportSegmentationProfile(r"C:\temp\importprofile.csv", "Total Households", r"C:\output\CustomerProfile.sgprofile", "Seg_ID", "Count_int", "Total_Volume")

Environments

Current Workspace, Data Source, Display Segment Names

Licensing information

Basic: Requires Business Analyst
Standard: Requires Business Analyst
Advanced: Requires Business Analyst