Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Snap type:

Transform

Description:

This Snap encrypts

In this article

Table of Contents

Overview

You can use this Snap to encrypt the binary documents that it receives on its input view using the AES algorithm and user-specified encryption parameters.

Note

The default security in the JRE limits the key length for encryption keys. For stronger encryption keys, you would need to manually install the Java Cryptographic Extension JARs on your JCC nodes.

  • Expected upstream Snaps: Any Snap that produces binary data in the output view such as File Reader or Compress.
  • Expected downstream Snaps: Any Snap that accepts binary data in the input view such as File Writer or Decompress.
Prerequisites:

[None]

Support and limitations:

Snap Type

AES Encrypt Snap is a TRANSFORM-type Snap.


Prerequisites

  • A valid account with the required permissions.

Support for Ultra Pipelines

Works in Ultra Pipelines.


Limitations and Known Issues

None.

Account: 

This Snap uses account references created on the Accounts page of the SnapLogic Manager to handle access to this endpoint. This Snap supports a Symmetric crypto account, or no account. See Configuring Binary Accounts for information on setting up accounts that work with this Snap.

Views:
InputThis Snap has exactly one binary input view.
OutputThis Snap has exactly one binary output view.
ErrorThis Snap has at most one binary error view and produces binaries in the view.

Settings

Label

Snap Views

TypeFormatNumber of ViewsExamples of Upstream and Downstream SnapsDescription

Input 

Binary



  • Min: 1
  • Max: 1
  • File Reader
  • Compress

Requires the EDI data and internal ID as a JSON document.

Output

Binary



  • Min: 1
  • Max: 1
  • File Writer

  • Decompress

The EDI transaction ID and order confirmation.

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 while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

  • Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the rest of the records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

Field Name

Field TypeDescription

Label


Default ValueAES Encrypt
ExampleAES Encrypt


String
Insert excerpt
SPD:Snap Label
SPD:Snap Label
nopaneltrue

Password


Default Value: N/A
Example
K1qjoeFQTr



String

The string used to generate a secret key and an initialization vector.

Note

If Password is set, the Secret key is ignored.

Example:

 

K1qjoeFQTr

Secret key

The The


Default Value: N/A
Example
:VsWLDQMvz9LaCaB3aaDHBw==


String

Specify the secret key used for encryption.

Note

If Password is set, the Secret key is ignored.


Initialization vector


Default Value: N/A
Example

VsWLDQMvz9LaCaB3aaDHBw==Initialization vector

6df68cdf3a6c48b2fde727541f3cecc


String

Specify the initialization vector used for encryption. It should be in hexadecimal format, and is not used in ECB mode.
 

Cipher mode*


Default ValueECB
Example

6df68cdf3a6c48b2fde727541f3cecc

CFB8

Cipher mode
Required. The
Dropdown list

Select the mode of operation for a block cipher.

The available options include: ECB, CBC, PCBC, CTR, CTS, CFB, CFB8, CFB16, CFB24, CFB32, CFB40, CFB48, CFB56, CFB64, CFB72, CFB80, CFB88, CFB96, CFB104, CFB112, CFB120, CFB128, OFB, OFB8, OFB16, OFB24, OFB32, OFB40, OFB48, OFB56, OFB64, OFB72, OFB80, OFB88, OFB96, OFB104, OFB112, OFB120, OFB128.


Encryption padding*


Default

value: ECBEncryption padding
Required. The

Value:PKCS5PADDING
Example
:NOPADDING

Dropdown list

Select the encryption padding.

 The

 The available options include: PKCS5PADDING, ISO10126PADDING, NOPADDING.


Snap Execution


Default

value: PKCS5PADDING Multiexcerpt include macronameSnap ExecutionpageAnaplan Read

Value: Validate & Execute
Example
: Execute only


Dropdown list
Multiexcerpt include macro
nameSnap_Execution_Introduced
pageAnaplan Read


Insert excerpt
Binary Snap Pack
Binary Snap Pack
nopaneltrue