Newer Version Available

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

TrialOrgSettings

Represents the settings in a trial user’s 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 details.

File Suffix and Directory Location

TrialOrgSettings values are stored in the TrialOrg.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

TrialOrgsettings is available in API version 48.0 and later.

Special Access Rules

Access to TrialOrgSettings requires users to complete the checkout flow in Enterprise, Professional, or Essentials editions. For Essentials, you can also access TrialOrgSettings by completing step 7 of the Setup Assistant.

Fields

Field Name Field Type Description
enableSampleDataDeleted boolean Indicates whether sample data may be deleted on trial orgs (true) or not (false). The default value is false.

Declarative Metadata Sample Definition

The following is an example of a TrialOrgSettings component.

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

Wildcard Support in the Manifest File

This metadata type doesn’t support the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.