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 your customers.
The report will calculate the volume information if the Base Profile input contains volume information.
This tool requires a local Business Analyst dataset.
Syntax
arcpy.ba.GenerateSegmentationProfileReport(target_profile, base_profile, {report_title}, {report_folder}, {report_format})| Parameter | Explanation | Data Type |
target_profile | A segmentation profile representing the segments to be profiled. The target profile usually represents your customer segmentation profile. | File |
base_profile | A segmentation profile representing the base profile segments. This is the segmentation used for comparison. The base profile usually represents your market area segmentation profile. | File |
report_title (Optional) | The title of the report. | String |
report_folder (Optional) | The output location to which the report will be saved. | Folder |
report_format [report_format,...] (Optional) | The report output format. The default value is PDF. Additional available formats are XLSX, HTML, CSV, and PAGX. | String |
Derived Output
| Name | Explanation | Data Type |
| output_report | The output report file. | File |
Code sample
The following Python window script demonstrates how to use the GenerateSegmentationProfileReport tool.
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
Licensing information
- Basic: Requires Business Analyst
- Standard: Requires Business Analyst
- Advanced: Requires Business Analyst