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

• Generates a report for all the characteristics from the selected Survey Category parameter value.

• The generated report is based on the Target Profile input 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—while Index is based on a rank.

Syntax

GenerateSurveyReportForProfile(target_profile, base_profile, survey_category, report_folder, {sort_column}, {sort_order}, {report_title}, {report_format})

Parameter	Explanation	Data Type
target_profile	A segmentation profile representing the segments to be analyzed. 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
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 to use to sort the report. EXPECTED_NUMBER —Sort is based on counts—for example, number of adults. This is the default. INDEX —Sort is based on rank.	String
sort_order (Optional)	Specifies the order of the report, based on the sort column, in ascending or descending order. ASCENDING —Sort in ascending order. DESCENDING —Sort in descending order. This is the default.	String
report_title (Optional)	The title of the report.	String
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

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

Licensing information

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