Newer Version Available

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

DevHubSettings

Represents Dev Hub settings.

Parent Type and Manifest Access

This type extends the Metadata metadata type and inherits its fullName field.

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

File Suffix and Directory Location

DevHubSettings values are stored in the DevHub.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

DevHubSettings are available in API version 47.0 and later.

Fields

Field Name Field Type Description
enableDevOpsCenterGA boolean Indicates whether DevOps Center is enabled: true or false. When enabled, you can install and use the generally available (GA) DevOps Center package in the org.

Available in API version 56.0 and later.

enableDevOpsCenter boolean (Deprecated) Indicates whether DevOps Center beta is enabled: true or false. When enabled, you can install and use the DevOps Center beta package in the org.
enableALMSimpleDeployDataPref boolean Indicates whether configuration data migration to a target org is enabled: true or false. When enabled, you can migrate configuration data from a Salesforce org to a target org.

To enable enableALMSimpleDeployDataPref, first enable enableALMSimpleDeployPref.

Available in API version 65.0 and later.

enableALMSimpleDeployDataPref is available as a developer preview. Feature isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. All commands, parameters, and other features are subject to change or deprecation at any time, with or without notice. Don't implement functionality developed with these commands or tools.

Note

enableALMSimpleDeployPref boolean Indicates whether metadata deployment to a target org is enabled: true or false. When enabled, you can deploy the metadata from a Salesforce org to a target org.

Available in API version 65.0 and later.

enableALMSimpleDeployPref is a pilot or beta service that is subject to the Beta Services Terms at Agreements - Salesforce.com or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the Product Terms Directory. Use of this pilot or beta service is at the Customer's sole discretion.

Note

enablePackaging2 boolean Indicates whether unlocked and second-generation managed packaging is enabled: true or false.

To enable enablePackaging2, first enable enableScratchOrgManagementPref.

enableScratchOrgManagementPref boolean Indicates whether Dev Hub is enabled: true or false. When enabled, a Dev Hub allows you to create and manage scratch orgs.
enableScratchOrgSnapshotPref boolean Indicates whether Scratch Org Snapshots is enabled: true or false. When enabled, you can create snapshots of a fully configured scratch org. A snapshot is a point-in-time copy of a scratch org that you can use to create additional scratch orgs.

Available in API version 61.0 and later.

enableShapeExportPref boolean Indicates whether Org Shape is enabled: true or false. When enabled, you can create org shapes as the basis for scratch orgs.

Available in API version 55.0 and later.

Declarative Metadata Sample Definition

The following is an example of a DevHubSettings component.

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

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.