Newer Version Available

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

DeploymentSettings

Represents the settings affecting how deployments behave in the org. 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

DeploymentSettings values are stored in the Deployment.settings file 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

DeploymentSettings components are available in API version 47.0 and later.

Fields

Field Name Field Type Description
doesSkipAsyncApexValidation boolean Indicates whether deployments from this org skip asynchronous Apex validations (true) or not (false). The default value is true.

Set this field to false when an Apex class in the package you’re deploying is used by an Apex batch job that could run during the deployment. The deployment of a package containing an Apex class that is used by a running batch job fails without validation.

Declarative Metadata Sample Definition

The following is an example of a DeploymentSettings component.

1<?xml version="1.0" encoding="UTF-8"?>
2<DeploymentSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3   <doesSkipAsyncApexValidation>true</doesSkipAsyncApexValidation>
4</DeploymentSettings>

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>Deployment</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.