On this page
Overview
Use this Snap to hide sensitive information in your dataset before exporting the dataset for analytics. By using the Mask Snap, you can ensure sensitive data protection by using masking algorithms that the Snap provides out of the box.
Troubleshooting
- None
Snap Input and Output
Input/Output | Type of View | Number of Views | Compatible Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| A dataset where some of the data must be masked. |
Output | Document |
|
| A dataset where the specified data is masked. |
Snap Settings
Parameter Name | Data Type | Description | Default Value | Example |
---|---|---|---|---|
Label | String | Required. The name for the Snap. Modify this to be more specific, especially if there is more than one of the same Snap in the Pipeline. | N/A | Mask |
Mask Policy | N/A | Required. Enables you to specify the policies that you want to use to mask data in the input dataset. | N/A | N/A |
Field | String | The field/parent field in the input dataset that contains the data to be masked. | N/A | name |
Search Mode | N/A | The mode the Snap must use to search sensitive data. Select from the following options:
For example, if you want to mask | N/A | Exact Path |
Match Field | String | The type of field in the input data to be matched. Select from the following options:
The Snap fails to validate if the Match Field is Key and the Mask Field is also Key. In such a case, select Value as the Mask Field. | N/A | Value |
Match Condition | N/A | The match condition that determines whether the Match Field should be matched. For example, if your input dataset contains $credit_card Field and you enter the Match Field as Value and Match Condition as Number, then the Snap masks all $credit_card fields that contain a number as the value. If the field contains text as the value, then the Snap skips masking that value. Select from the following options:
| N/A | Date |
Match Pattern | String | The expression of the information pattern to be matched in the input dataset. This is applicable only when the Match Condition is Regex Match or Date (Text). | N/A | Hello |
Mask Field | N/A | The field that contains sensitive data and will be masked if the matching conditions are met. Select from the following options:
The Snap fails to validate if the Match Field is Key and the Mask Field is also Key. In such a case, select Value as the Mask Field. | N/A | Value |
Mask Method | N/A | The method to use to mask sensitive information. Select from the following options:
| N/A | Remove |
Mask Value |
| The value that must replace the sensitive information in the input dataset. You can enter either a fixed value or an expression. This is applicable only when the Mask Method is Replace. | N/A | 0 |
Execute during preview | N/A | Specify the execution type from the following options:
| Validate & Execute | Validate & Execute |