Format

Number of Views

Examples of Upstream and Downstream Snaps

Descirption

Document

• Min:1

• Max:1

Any Snap with a document output view

Stream of documents with a nested or flat map data

Document

• Min:1

• Max:1

Any Snap with a document input view

Same as input documents with specified field values encrypted

This Snap has at most one document error view and produces zero or more documents in the view.

Label

Default Value: Encrypt Field
Example: Encrypt Field

String

Fields to encrypt

Default Value:
Example:

String

Use this field set to define the field path.

Field path*

Default Value:
Example:

String

A table for JSON-path expressions to fields to encrypt. Use the suggest button to select the field to encrypt.

Transform type

Default Value: auto
Example:

• AES/GCM/NoPadding

• DES/CBC/PKCS5Padding

String

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

String

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.

• For a sample pipeline using X.509 certificate, refer to the attached pipeline file below:

Example_BINARY_Encrypt Decrypt X.509 certificate from input document.

• For a sample pipeline using the RSA public key, refer to the attached pipeline file below:

Example_Encrypt Decrypt_RSA public key from input document.

String

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.

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.

Snap Execution

Default Value: Vallidate & Execute
Example: Execute only

Dropdown list

Select one of the following three modes in which the Snap executes:

• Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.

• Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.

• Disabled: Disables the Snap and all Snaps that are downstream from it.