Skip to main content

User Guide

Clip Text

This section provides a comprehensive description of the Clip Text Rule.

For a summary of the rule and its compatibility with Privitar jobs and execution environments, see masking-rules.png Masking Rule Types.

Data Type

The supported data types for this rule are:

  • Text

Description

This rule forms an output value by removing or retaining part of the input value. The clipping can be applied starting from the left of the value (default) or from the right of the value. For example:

SE12 8PZ

can become:

SE12

The clipped output value is obtained by either retaining the specified number of selected characters (if Preserve Selected Characters is checked) whilst removing all other characters, or removing those selected characters whilst retaining the rest (if Preserve Selected Characters is not checked).

For example, if the number of characters to clip is three characters, starting from the left:

SW12 7AH

becomes:

  • SW1 - (if Preserve Selected Characters is checked)

  • 2 7AH - (if Preserve Selected Characters is not checked)

Masking Behavior

The options are described in the following table:

Option

Description

Preserve Selected Characters

The action to take with the characters that have been selected from the input to derive the final output value.

The clipped output value is obtained by either retaining the specified number of selected characters (if Preserve Selected Characters is checked) whilst removing all other characters, or removing those selected characters whilst retaining the rest (if Preserve Selected Characters is not checked).

Start from the Left

Clip characters starting from the left. If this box is not checked, characters are clipped from the right.

Number of Characters to Clip

The number of characters to clip from the input text.

Examples

Here are some examples of the Clip Text rule:

Input

Output

Description

SE12 8PZ

SE12

Clip 4 characters, starting from the left.

(Preserve Selected Characters is checked.)

SE12 8PZ

8PZ

Clip 5 characters, starting from the left.

(Preserve Selected Characters is not checked.)