Settings

Not all feature settings are available in the Metadata API. See Unsupported Metadata Types for information on which feature settings are not available.

1    <types>
2        <members>Security</members>
3        <name>Settings</name>
4    </types>

File Suffix and Directory Location

Each settings component gets stored in a single file in the settings directory of the corresponding package directory. The filename uses the format Setting feature.settings. For example, the SecuritySettings file would be Security.settings. See “File Suffix and Directory Location” information for the individual settings components to determine the exact filename.

Version

Settings is available in API version 27.0 and later. See the version information for the individual setting component to determine which API version the settings component became available.

Declarative Metadata Sample Definition

The following is an example package manifest used to deploy or retrieve only the MobileSettings 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>Mobile</members>
5        <name>Settings</name>
6    </types>
7    <version>27.0</version>
8</Package>

The following is an example package manifest used to deploy or retrieve all the available settings metadata for an organization, using a wildcard:

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