Privacy configuration for UI Capture

Tealeaf UI Capture enables the blocking and masking of sensitive information within the client browser, before the data is forwarded to Tealeaf for capture, while it allows the data to be forwarded to your web servers for normal processing.

Sensitive data that was cleansed through UI Capture never reaches Tealeaf, which ensures that your customer's interactions are secure in UI Capture.

UI Capture enables the blocking of user input data by element ID, name, or xpath.
Masks can be expressed as explicit strings, replacements for character types, or custom functions.
Note: If you have questions about implementing data privacy in UI Capture, contact Professional Services.

To specify a privacy rule, you must define:

The type of identifier.
The targets to which the rule applies.
The type of masking to apply to the targets.

Specify a privacy rule

In the configuration, a single privacy rule is specified within the privacy object by using the following configuration template.

              {
                   targets: [
                       {
                           id: "htmlid",
                           idType: -1
                       }
                   ],
                   maskType: 3
               }

Specify targets

To specify a target, you must specify the following properties.

Note: You can specify multiple id or idType targets for each masking rule.

id

The identifier for the target element. This value is specified according to the idType value. In the configuration file, you can use a regular expression to specify matching identifiers. For example, the following target configuration matches all HTML identifiers that end with _pii:

message: {
    privacy: [
        {
            targets: [
                {
                    id: { regex: ".+_pii$" },
                    idType: -1
                },
            ],
            "maskType": 3
        }
    ]
}

idType

The type of identifier. The following types are supported:

Note: Values for idType are recorded as negative numbers.

-1 - HTML ID
-2 - xpath identifier
-3 - HTML name or other element attribute identifier

CSS selector

In the configuration file, you can also specify CSS selector values to match CSS elements for privacy masking. In the following example, the designated privacy rule is applied to all password input fields:


message: {
    privacy: [
        {
            targets: [
                "input[type=password]"
            ],
            "maskType": 3
        }
    ]
}

Specify mask type

Tealeaf UI Capture supports the following mask types (maskType values):

Table 1. Privacy configuration for UI Capture j2
REQTEXT
Value	Description	Example	Masked example
1	Value is blocked and replaced by an empty string.	`"HelloWorld123"`	`""`
2	Value is masked with a fixed string of `X`'s	`"HelloWorld123"`	`XXXXX`
3	Value is masked according to the following parameters: a lowercase letter is replaced by `x`. an uppercase letter is replaced by `X`. a numeral is replaced by `9`. a non-alphanumeric value is replaced by `@`.	`"HelloWorld123"`	`"XxxxxXxxxx999"`
4	Custom function Note: A masking function must be defined as `maskFunction`.	`"HelloWorld123`	Depends on the defined function

Specify a privacy rule

Specify targets

Specify mask type

Join the community

Academy

Data privacy

Specify a privacy rule

Specify targets

Specify mask type

Related articles

Join the community

Academy