Skip to Content

PGP (Beta) Encrypt activity

Introduction

A PGP (Beta) Encrypt activity, using its PGP (Beta) connection, encrypts files and is intended to be used as a target to consume data in an operation.

Note

For beta access and to provide feedback, contact the Jitterbit Product Team.

Create a PGP (Beta) Encrypt activity

An instance of a PGP (Beta) Encrypt activity is created from a PGP (Beta) connection using its Encrypt activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an activity instance in Component reuse.

An existing PGP (Beta) Encrypt activity can be edited from these locations:

Configure a PGP (Beta) Encrypt activity

Follow these steps to configure a PGP (Beta) Encrypt activity:

Step 1: Enter a name and specify settings

In this step, provide a name for the activity and specify the PGP encryption settings. Each user interface element of this step is described below.

PGP Encrypt activity configuration step 1

Tip

Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

  • Name: Enter a name to identify the activity. The name must be unique for each PGP (Beta) Encrypt activity and must not contain forward slashes / or colons :.

  • Algorithm: Select the symmetric key algorithm to use for encryption. Choose one of AES_128, AES_192, AES_256, BLOWFISH, CAMELLIA_128, CAMELLIA_192, CAMELLIA_256, CAST5, DES, IDEA, SAFER, TRIPLE_DES, or TWOFISH.

  • Compression types: Select the compression algorithm, one of BZIP2, ZIP, ZLIB, or UNCOMPRESSED.

  • Data format: Select the data format of the file content, either BINARY or TEXT.

  • Recipient public key: Enter the recipient's public key.

  • File content: Enter the file content.

  • Base64 Encoded: Select if the file content is Base64-encoded.

  • Dual Key Encryption: Select to enable dual key encryption.

  • Sender public key: If Dual Key Encryption is selected, enter the sender's public key.

  • Optional settings: Click to expand additional optional settings:

    • File name: Enter the name of the file.
    • Recipient key ID: Enter the recipient's key ID.

    • Sender key ID: Enter the sender's key ID.

      Important

      A key ID must be a 64-bit long hex-format string (16 hexadecimal digits). For example, 0xAC859CC9E1257F19.

      If a key ID field is left empty, the key ID embedded in the corresponding recipient or sender public key is used.

    • Integrity Check: Select to protect the encrypted files with an integrity packet.

    • Armor: Select to encode the encrypted files with ASCII armor, a non-binary encoding.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the data schemas

Any request or response schemas are displayed. Each user interface element of this step is described below.

PGP Encrypt activity configuration step 2

  • Data schema: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

    The response schema's status field returns either "Success" or "Failure". On failure, the errorDetails field is populated with the exception associated with the failure.

    Note

    Data supplied in a transformation takes precedence over the activity configuration.

    The PGP (Beta) connector uses the Bouncy Castle API v1.80 which implements the OpenPGP encryption standard. Refer to the API documentation for additional information.

  • Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the PGP (Beta) endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next steps

After configuring a PGP (Beta) Encrypt activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.

PGP (Beta) Encrypt activities can be used as a target with these operation patterns:

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.