OrgSettings

Represents the settings for org-wide functionality that isn’t associated with any specific feature.

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

This type extends Metadata and inherits its fields.

An OrgSettings component file has the suffix .settings and is stored in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

Introduced in API version 46.0.

Before API version 51.0, the fields enableExtendedMailMerge and saveMailMergeDocsAsSalesforceDocs were found within OrgSettings components. In API version 51.0 and later, those fields are found within MailMergeSettings.

• Type: boolean
• Required: No
• Description: Indicates whether Customer Portal is enabled (true) or not (false).

• Type: boolean
• Required: No

• Type: boolean
• Required: No

• Type: boolean
• Required: No
• Description: Indicates whether mass management of self-service users is enabled through the Self-Service Portal (true) or not (false).

• Type: boolean
• Required: No
• Description: Indicates whether feed sentiment analysis is enabled for the org (true) or not (false).

• Type: boolean
• Required: No

• Type: boolean
• Required: No

The following is an example of a OrgSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<OrgSettings xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
3    <enableCustomerSuccessPortal>false</enableCustomerSuccessPortal>
4    <enableMakeDeploymentsMandatory>true</enableMakeDeploymentsMandatory>
5    <enableManageSelfServiceUsers>false</enableManageSelfServiceUsers>
6    <enableOrgFeedSentimentAnalysis>false</enableOrgFeedSentimentAnalysis>
7    <enableRADeploymentAttributeOnly>true</enableRADeploymentAttributeOnly>
8</OrgSettings>

The following is an example package manifest used to deploy or retrieve the org settings metadata for an organization:

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

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.