Generate Segmentation Profile Report (Business Analyst)

Available with Business Analyst license.

Summary

Creates a report that displays segments of your customers and compares them to the study area (base profile).

Usage

• The report displays the count, percent, and index of each segment of customers.

• The report will calculate the volume information if the Base Profile parameter value contains volume information.

Parameters

Dialog

Label	Explanation	Data Type
Target Profile	A segmentation profile representing the segments that will be profiled. The target profile typically represents your customer segmentation profile.	File
Base Profile	A segmentation profile representing the base profile segments. This is the segmentation that will be used for comparison. The base profile typically represents your market area segmentation profile.	File
Report Title (Optional)	The title of the report.	String
Output Report Folder (Optional)	The output location where the report will be saved.	Folder
Report Output Formats (Optional)	Specifies the format of the output report. PDF—The report will be in PDF format. This is the default. XLSX—The report will be in XLSX format. HTML—The report will be in HTML format. CSV—The report will be in CSV format. PAGX—The report will be in PAGX format.	String

Derived Output

Label	Explanation	Data Type
Output Report	The output report file.	File

Python

arcpy.ba.GenerateSegmentationProfileReport(target_profile, base_profile, {report_title}, {report_folder}, {report_format})

Name	Explanation	Data Type
target_profile	A segmentation profile representing the segments that will be profiled. The target profile typically represents your customer segmentation profile.	File
base_profile	A segmentation profile representing the base profile segments. This is the segmentation that will be used for comparison. The base profile typically represents your market area segmentation profile.	File
report_title (Optional)	The title of the report.	String
report_folder (Optional)	The output location where the report will be saved.	Folder
report_format [report_format,...] (Optional)	Specifies the format of the output report. PDF—The report will be in PDF format. This is the default. XLSX—The report will be in XLSX format. HTML—The report will be in HTML format. CSV—The report will be in CSV format. PAGX—The report will be in PAGX format.	String

Derived Output

Name	Explanation	Data Type
output_report	The output report file.	File

Code sample

GenerateSegmentationProfileReport example (stand-alone script)

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

import arcpy
arcpy.ba.GenerateSegmentationProfileReport(r"C:\Users\MyProject\customerprofile.sgprofile", r"C:\Users\MyProject\MarketAreaprofile.sgprofile", r"C:\Users\MyProject\Reports_Output", "PDF")

Environments

Current Workspace, Data Source, Use Segment Names

Licensing information

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