Generate Survey Report For Profile (Business Analyst)

Available with Business Analyst license.

Summary

Displays characteristics from the consumer survey data for your target profile to determine customer lifestyle habits and preferences.

Usage

• A report is generated for all the characteristics from the selected Survey Category parameter value.

• The generated report is based on the Target Profile parameter value compared to a base profile.

• Reports can be sorted using the Sort Column parameter's Expected Number or Index options. Expected Number is based on counts, for example, number of adults, and Index is based on a rank.

Parameters

Dialog

Label	Explanation	Data Type
Target Profile	A segmentation profile representing the segments that will be analyzed. The target profile typically 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 typically represents your market area segmentation profile.	File
Survey Category	A category that contains characteristics from the consumer survey.	String
Output Report Folder	The output location where the report will be saved.	Folder
Sort Column (Optional)	Specifies the column that will be used to sort the report. Expected Number—The report will be sorted based on counts—for example, number of adults. This is the default. Index—The report will be sorted based on rank.	String
Sort Order (Optional)	Specifies the order of the report, based on the sort column, in ascending or descending order. Ascending—The report will be sorted in ascending order. Descending—The report will be sorted in descending order. This is the default.	String
Report Title (Optional)	The title of the report.	String
Report 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.GenerateSurveyReportForProfile(target_profile, base_profile, survey_category, report_folder, {sort_column}, {sort_order}, {report_title}, {report_format})

Name	Explanation	Data Type
target_profile	A segmentation profile representing the segments that will be analyzed. The target profile typically 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 typically represents your market area segmentation profile.	File
survey_category	A category that contains characteristics from the consumer survey.	String
report_folder	The output location where the report will be saved.	Folder
sort_column (Optional)	Specifies the column that will be used to sort the report. EXPECTED_NUMBER—The report will be sorted based on counts—for example, number of adults. This is the default. INDEX—The report will be sorted based on rank.	String
sort_order (Optional)	Specifies the order of the report, based on the sort column, in ascending or descending order. ASCENDING—The report will be sorted in ascending order. DESCENDING—The report will be sorted in descending order. This is the default.	String
report_title (Optional)	The title of the report.	String
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

GenerateSurveyReportForProfile example (stand-alone script)

The following stand-alone script demonstrates how to use the GenerateSurveyReportForProfile function.

import arcpy
arcpy.ba.GenerateSurveyReportForProfile(r"C:\Users\MyProject\customerprofile.sgprofile", r"C:\Users\MyProject\MarketAreaprofile.sgprofile", "Automobiles and Automotive Products", r"C:\Users\MyProject\Reports_Output", "EXPECTED_NUMBER", "DESCENDING", "Auto Survey Profile Report", "PDF")

Environments

Current Workspace, Data Source, Use Segment Names

Licensing information

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