DynamicFormsSettings

Represents the settings related to Dynamic Forms.

Parent Type and Manifest Access

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

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

File Suffix and Directory Location

DynamicFormsSettings values are stored in the DynamicForms.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

DynamicFormsSettings components are available in API version 58.0 and later.

Special Access Rules

There are no additional access requirements that are specific to this type.

Fields

Field Name Description
enableFormsOnMobile
Field Type
boolean
Description
Determines whether an org has Dynamic Forms for Mobile (Beta) enabled (true) or not (false).

This feature is a Beta Service. Customer may opt to try such Beta Service in its sole discretion. Any use of the Beta Service is subject to the applicable Beta Services Terms provided at Agreements and Terms.

Note

Declarative Metadata Sample Definition

The following is an example of a DynamicFormsSettings component.

<?xml version="1.0" encoding="UTF-8"?>
<DynamicFormsSettings xmlns="http://soap.sforce.com/2006/04/metadata">
    <enableFormsOnMobile>true</enableFormsOnMobile>
</DynamicFormsSettings>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>DynamicForms</members>
        <name>Settings</name>
    </types>
    <version>58.0</version>
</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.