Skip to end of metadata
Go to start of metadata

Encrypts clear text target files using PGP.

NameTypeRequiredDescription
Jitterbit.PGP.PublicKeyDatastringfalseThe ASCII representation of the public key. Alternatively, place the public key file directly on the Jitterbit Agent itself (assuming you have access to it), and set the data element $Jitterbit.PGP.PublicKeyFile to the path of the file.
Jitterbit.PGP.PublicKeyFilestringfalseThe path to the public key file, in the case where the public key file is stored on the Jitterbit Agent. The file must be readable by the user that runs Jitterbit (more specifically the Jitterbit Process Engine). Alternatively, you can set $Jitterbit.PGP.PublicKeyID to the ASCII representation of the key itself by using scripting to define $Jitterbit.PGP.PublicKeyID as a global variable before you call your operation. More information on how to do this can be found under Cloud Studio Global Variables or Design Studio Global Variables.
Jitterbit.PGP.UserIDstringfalseThe user ID of the public key to use for encryption. If this variable is not set, $Jitterbit.PGP.PublicKeyID must be set instead. This value is ignored if $Jitterbit.PGP.PublicKeyID has been set.
Jitterbit.PGP.PublicKeyIDstringfalseThe ID of the public key to use for encryption. This should either be a string in hex-format, such as "0xAC859CC9E1257F19", or the corresponding value in base-10, such as "12431514737305812761". Note that the key ID must be 64 bits long in order to work with the crypto-library used by this plugin; some tools report only the 32 lowest bits when asked for the ID of a key. If this variable is not set, $Jitterbit.PGP.UserID must be set instead.
Jitterbit.PGP.AsciiArmorboolfalseSetting this data element to true results in the encrypted files being ASCII-armored. The default setting (false) results in the encrypted files being created in binary form.
Jitterbit.PGP.PrivateKeyDatastringfalseIf both signing and encrypting the file, this data element should contain the ASCII representation of the private key file that will be used for signing the file. Alternatively, place the key file directly on the Jitterbit Agent (assuming you have access to it) and set the path to the file in the data element $Jitterbit.PGP.PrivateKeyFile.
Jitterbit.PGP.PrivateKeyFilestringfalseIf both signing and encrypting the file, this data element should contain the path to the private key file that will be used for signing the file, assuming that the private key file is stored on the Jitterbit Agent itself. Alternatively, pass in the ASCII representation of the key itself in the data element $Jitterbit.PGP.PrivateKeyData.
Jitterbit.PGP.PrivateKeyIDstringfalseIf both signing and encrypting the file, this data element can be used to specify the ID of the private key. The same format rules apply as for $Jitterbit.PGP.PublicKeyID (see above). If this value is not set, Jitterbit will use the first applicable key it finds in the private key file for signing.
Jitterbit.PGP.PassphrasestringfalseIf both signing and encrypting the file, this data element should contain the passphrase that protects the private key. This data element must be set if $Jitterbit.PGP.PrivateKeyFile has been set, otherwise the plugin will fail.

Last updated:  Feb 06, 2020