OrgSettings

Represents the settings for org-wide functionality that isn’t associated with any specific feature.This type extends the Metadata metadata type and inherits its fullName field.

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

File Suffix and Directory Location

A 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 is only one settings file for each settings component.

Version

OrgSettings components are available in API version 46.0 and later.

Fields

Field Name	Field Type	Descriptions

enableCustomerSuccessPortal	boolean	Indicates whether Customer Portal is enabled (`true`) or not (`false`).
enableExtendedMailMerge	boolean	Indicates whether the Salesforce Classic product, Extended Mail Merge, is enabled (`true`) or not (`false`). Use Extended Mail Merge to generate large volumes of Microsoft Word documents — such as form letters or address labels — from Word document templates. Default value is `false`. Available in API version 47.0 only.
enableManageSelfServiceUsers	boolean	Indicates whether mass management of self-service users is enabled through the Self-Service Portal (`true`) or not (`false`).
saveMailMergeDocsAsSalesforceDocs	boolean	Indicates whether users can save all documents that are generated using Extended Mail Merge as Salesforce documents (`true`) or not (`false`). If (`false`), Extended Mail Merge documents that are smaller than 3 MB are emailed to users who run the merge. Default value is (`false`). Available in API version 47.0 only.

Declarative Metadata Sample Definition

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    <enableIncludeContractStatus>false</enableIncludeContractStatus>
5    <enableMakeDeploymentsMandatory>true</enableMakeDeploymentsMandatory>
6    <enableManageSelfServiceUsers>false</enableManageSelfServiceUsers>
7    <enableOrgFeedSentimentAnalysis>false</enableOrgFeedSentimentAnalysis>
8    <enableRADeploymentAttributeOnly>true</enableRADeploymentAttributeOnly>
9    <enableResetDivisionOnLogin xsi:nil="true"/>
10</OrgSettings>

Example Package Manifest

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>

Wildcard Support in the Manifest File

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.

Metadata API Developer Guide