Newer Version Available

This content describes an older version of this product. View Latest

SurveySettings

Represents an org’s survey settings. Use the SurveySettings component to enable Salesforce Surveys, enable Customer Lifecyle Maps and choose whether the owner of a survey can manage the responses. This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for details.

SurveySettings values are stored in a single file named Survey.settings in the settings folder. The .settings files are different from other named components because there is only one settings file for each settings component.

Version

SurveySettings is available in API version 47.0 and later.

Fields

Field Name Field Type Description
enableIndustriesCxmEnabled boolean Indicates whether Customer Lifecycle Maps is enabled for your org (true) or not (false). The default value is false.
enableSurvey boolean Indicates whether Surveys is enabled for your org (true) or not (false). The default value is false.
enableSurveyOwnerCanManageResponse boolean Indicates whether the owner of a survey can manage its responses. The default value is false.

Declarative Metadata Sample Definition

The following is an example of a SurveySettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<SurveySettingsxmlns="http://soap.sforce.com/2006/04/metadata">
3<enableIndustriesCxmEnabled>false</enableIndustriesCxmEnabled>
4<enableSurvey>true</enableSurvey>
5<enableSurveyOwnerCanManageResponse>false</enableSurveyOwnerCanManageResponse>
6</SurveySettings>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>Survey</members>
5        <name>Settings</name>
6    </types>
7    <version>47.0</version>
8</Package>