Newer Version Available

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

SourceTrackingSettings (Beta)

Represents settings for source tracking, so that changes you make in your Developer and Developer Pro sandboxes or local workspace can be tracked. 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

SourceTrackingSettings values are stored in the SourceTracking.settings file in the settings folder. The .settings files are different from other named components because there is only one settings file for each settings component.

Version

SourceTrackingSettings is available in API version 49.0 and later.

Fields

Field Name Field Type Description
enableSourceTrackingSandboxes boolean Indicates whether to enable source tracking automatically when Developer or Developer Pro sandboxes are created or refreshed (true) or not (false). The default value is false.

If you set enableSourceTrackingSandboxes back to false after it was enabled, a sandbox that is tracking source changes continues to do so until it is refreshed.

You don't need to have the Developer Hub (DevHub) enabled in the same org to enable source tracking.

Note

This field applies to production orgs only; in other orgs, this field is ignored.

Declarative Metadata Sample Definition

The following is an example of a SourceTrackingSettings component.

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

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.