DataMaskSettings

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.

Use DataMaskSettings to configure and deploy these settings and preferences as part of an automated org setup.

Prerequisites

Before deploying DataMaskSettings components, confirm these prerequisites.

• Salesforce CLI installed and authenticated to your org
• Familiarity with Metadata API, the sf deploy metadata CLI command, or both

• A target sandbox for testing

  The Data Mask & Seed app is available for production orgs and sandboxes. Run masking jobs on sandboxes only, not in production orgs.

  Note

• The required permissions described in Special Access Rules
• API version 67.0 or later

File Suffix and Directory Location

DataMaskSettings values are stored in the DataMask.settings file in the settings folder. Unlike other metadata components, each settings type has exactly one .settings file.

Version

DataMaskSettings components are available in API version 67.0 and later.

Special Access Rules

Before deploying DataMaskSettings components, your Salesforce admin must configure these permissions. If you don't have admin access, work with your admin.

Production org requirements:

• The org must be licensed for Data Mask & Seed with the Salesforce Data Mask license.

User requirements:

• The user must be assigned the DataMaskAndSeedUserPsl permission set license (PSL).
• The user must be assigned the DataMaskAndSeedUser permission set.
  • Assign the DataMaskAndSeedUserPsl PSL before assigning the DataMaskAndSeedUser permission set. The permission set requires the PSL to be in place first.

Fields

Declarative Metadata Sample Definition

The following is an example of a DataMaskSettings component.

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

This example turns on the ability of the admin/developer to use the Einstein tool to generate values for Data Mask & Seed custom libraries.

Include DataMaskSettings components in your package.xml manifest file when deploying with the Salesforce CLI. This package.xml manifest deploys the DataMask component.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>DataMask</members>
5        <name>Settings</name>
6    </types>
7    <version>67.0</version>
8</Package>

Troubleshooting

API version below 67.0

DataMaskSettings is invisible. Retrieve and deploy operations fail silently or return an unknown-type error.

Missing permissions

If required permissions are missing, you receive an insufficient-access error, or the Data Mask management screens aren't available. Confirm that both the org and the user have the permissions listed in Special Access Rules.

Permission set assigned before the PSL

Assigning the DataMaskAndSeedUser permission set fails without the required PSL already in place.

Versioning and Compatibility

• DataMaskSettings is available starting in API version 67.0. DataMaskPolicy is available starting in API version 61.0. If your client uses an API version below the minimum required version for either type, that metadata type isn't visible. You can't retrieve it or deploy it.
• The two metadata types were introduced in different releases and work independently. If your use case requires only org-level feature settings and preferences for masking, API version 67.0 is sufficient.
• If the production org's release doesn't include the metadata type, the deployment is rejected as an unknown or unsupported metadata type. Target an API version at or above the minimum required version, and confirm that the org is on a release that supports the type.

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.