--- schema_version: "1" id: aa61e6a4c020c09f39d9f1f47e2cf6759d9a08a8569f0e3703572f0e61197f46 title: DataMaskSettings collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_datamasksettings.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datamasksettings.htm source_site: developer.salesforce.com content_type: documentation content_hash: 2981d5da680e261af82640eec8af618663f1625d45c4631af75929faa96ad74e description: Represents org-level setup (features and preferences) for use with Data Mask & Seed. --- # DataMaskSettings Represents org-level setup (features and preferences) for use with Data Mask & Seed. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm) for more details. Use DataMaskSettings to configure and deploy these settings and preferences as part of an automated org setup. ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png) #### Note Each of the available Data Mask & Seed metadata types, DataMaskSettings and DataMaskPolicy, serves a different purpose and can be deployed independently of each other. ## 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 ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png) #### Note The Data Mask & Seed app is available for production orgs and sandboxes. Run masking jobs on sandboxes only, not in production orgs. - 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. ![Note](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note.png) #### Note Server-side validation and access controls enforce all business rules across all access paths, including Metadata API. ## Fields | Field Name | Description | | --- | --- | | enableDataMaskGPTEnabled | Field Type boolean Description Optional. Indicates whether the ability to use the Einstein tool to generate values for Data Mask & Seed custom libraries is turned on (true) or turned off (false) for the admin/developer. The default value is false. To turn on the user's ability to use the Einstein tool, set this field to true. | ## Declarative Metadata Sample Definition The following is an example of a DataMaskSettings component. true 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. DataMask Settings 67.0 ## 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm). #### See Also - [DataMaskPolicy](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_datamaskpolicy.htm "Represents a masking policy for use with Data Mask & Seed.") - [Data Mask & Seed Release Notes](https://help.salesforce.com/s/articleView?id=release-notes.rn_data_mask_and_seed.htm&release=262&type=5&language=en_US) - [_Salesforce Help_: Protect Sensitive Data with Data Mask & Seed](https://help.salesforce.com/s/articleView?id=platform.data_mask_and_seed.htm&type=5&language=en_US)