--- schema_version: "1" id: ca00aa586d05c0b00ad4a794b8688365ae2a14df68dc8e6814b8465bcf398525 title: LiveChatSensitiveDataRule collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_livechatsensitivedatarule.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_livechatsensitivedatarule.htm source_site: developer.salesforce.com content_type: documentation content_hash: c392718f81d6c2a01a9b9504bbf85f18f858838c4965c7fafa25a7f74e97322e description: Represents a rule for masking or deleting data of a specified pattern. Written as a regular expression (regex). --- # LiveChatSensitiveDataRule Represents a rule for masking or deleting data of a specified pattern. Written as a regular expression (regex). Use this object to mask or delete data of specified patterns, such as credit card, social security, phone and account numbers, or even profanity. This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field. ## File Suffix and Directory Location LiveChatSensitiveDataRule components have the suffix .liveChatSensitiveDataRule and are stored in the liveChatSensitiveDataRule folder. ## Version LiveChatSensitiveDataRule components are available in API version 35.0 and later. ## Fields
Field Name Field Type Description
actionType SensitiveDataActionType (enumeration of type string) Required. The action to take on the text when the sensitive data rule is triggered. Possbile values are:
  • Remove
  • Replace
description string The description of the sensitive data rule—for example, “Block social security numbers.”
enforceOn int Required. Determines the roles on which the rule is enforced. The value is determined using bitwise OR operation. There are seven possible values:
  1. Rule enforced on Agent
  2. Rule enforced on Visitor
  3. Rule enforced on Agent and Visitor
  4. Rule enforced on Supervisor
  5. Rule enforced on Agent and Supervisor
  6. Rule enforced on Visitor and Supervisor
  7. Rule enforced on Agent, Visitor, and Supervisor
isEnabled boolean Required. Specifies whether a sensitive data rule is active (true) or not (false). Default value (if none is provided) is false.
pattern string Required. The pattern of text blocked by the rule. Written as a JavaScript regular expression (regex).
replacement string The string of characters that replaces the blocked text (if ActionType Replace is selected).
## Declarative Metadata Sample Definition The following is an example of a LiveChatSensitiveDataRule component. REPLACE 7 true \[aeiou\] œ The following is an example package.xml that references the previous definition. Unrestricted Change\_For\_all LiveChatSensitiveDataRule 35.0 ## Wildcard Support in the Manifest File This metadata type supports 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).