SchemaSettings

Represents an org’s schema settings, which manage the availability of custom settings and custom metadata type values. 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 details.

File Suffix and Directory Location

SchemaSettings values are stored in the Schema.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

Version

SchemaSettings is available in API version 47.0 and later.

Fields

Field Name	Field Type	Description
enableAdvancedCMTSecurity	boolean	Indicates whether custom metadata type values are available only to Apex, flow, and formula operations (`true`) or exposed in other contexts such as through the Enterprise WSDL or SOAP API (`false`). This field has a default value of `false`.
enableAdvancedCSSecurity	boolean	Indicates whether custom settings type values are available only to Apex, flow, and formula operations (`true`) or exposed in other contexts such as through the Enterprise WSDL or SOAP API (`false`). This field has a default value of `false`.
enableListCustomSettingCreation	boolean	Indicates whether you can create custom settings when using application-level data definitions (`true`) or not (`false`). This field has a default value of `false`.
enableSOSLOnCustomSettings	boolean	Indicates whether custom settings values are returned in Salesforce Object Search language (SOSL) queries (`true`) or not (`false`). This field has a default value of `false`.

Declarative Metadata Sample Definition

The following is an example of a SchemaSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<SchemaSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <enableAdvancedCMTSecurity>true</enableAdvancedCMTSecurity>
4    <enableAdvancedCSSecurity>true</enableAdvancedCSSecurity>
5    <enableListCustomSettingCreation>false</enableListCustomSettingCreation>
6    <enableSOSLOnCustomSettings>true</enableSOSLOnCustomSettings>
7</SchemaSettings>

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>Schema</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