Encrypt Field
Overview
Transform-type Snap
Works in Ultra Tasks
Snap views
| View | Description | Examples of upstream and downstream Snaps |
|---|---|---|
| Input | Stream of documents with a nested or flat map data. | Any Snap with a document output view |
| Output | Same as input documents with specified field values encrypted. | Any Snap with a document input view |
| Error |
Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:
Learn more about Error handling in Pipelines. |
|
Snap settings
- Expression icon (
): Allows using
pipeline parameters to set field values dynamically (if enabled). SnapLogic Expressions
are not supported. If disabled, you can provide a static value. - SnapGPT (
): Generates SnapLogic Expressions
based on natural language using SnapGPT. Learn
more. - Suggestion icon (
): Populates a
list of values dynamically based on your Snap configuration. You can select only one
attribute at a time using the icon. Type into the field if it supports a comma-separated
list of values. - Upload
: Uploads files. Learn more.
| Field / Field set | Type | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Label | String | Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline. Default value: Encrypt Field Example: Encrypt Field |
||||||||||
| Fields to encrypt |
Use this field set to define the field path. |
|||||||||||
| Field path | String/Suggestion | Required. A table for JSON-path expressions to fields to encrypt. Use the suggest button to select the field to encrypt. | ||||||||||
| Transform type | String/Expression/ Suggestion | Required. The cryptographic transformation to perform,
expressed as algorithm/mode/padding. Use the suggest button to select a
desired transformation type. When set to auto the transformation will be
automatically selected based on the type of encryption key using the following
table:
|
||||||||||
| Advanced Options |
Use this fieldset to specify the key when no account is selected. |
|||||||||||
| Key | Dropdown list/Expression | Specify a JSON path or select the path by enabling the expression field that the Snap must evaluate with input document or pipeline parameter. The result must be the base64, PEM-encoded key, or non-encoded RSA public key. Note:
Default value: None. Example: $key |
||||||||||
| Initialization vector | Dropdown list/Expression | JSON-path expression to be evaluated with input documents or pipeline
parameters to be the base64-encoded initialization vector. Leave empty to generate
one automatically. Note that the content of the initialization vector should be
different for every encryption operation. Reusing IVs will make the encryption
operation less secure. Default value: None. Example: $iv |
||||||||||
| Encapsulate output | Checkbox | If selected, encrypted fields are JSON-encoded and encapsulated between "ENC:"
and ":ENC" strings. When unselected, the field to be encrypted will be replaced with
an object with the output of the encryption operation as needed to perform the
decryption. Default status: Deselected |
||||||||||
| Snap execution | Dropdown list |
Choose one of the three modes in
which the Snap executes. Available options are:
Default value: Validate and Execute Example: Execute only |
||||||||||