PGP

Discover more about the PGP component and how to use it on the Digibee Integration Platform.

PGP (Pretty Good Privacy) is an encryption connector that provides authentication and privacy for data communication.

Parameters

Configure the connector using the parameters below. Fields that support Double Braces expressions are marked in the Supports DB column.

General

Parameter	Description	Data type	Supports DB	Default	Visible when
Use Dynamic Account	If enabled, the connector uses the account dynamically via the Store Account connector; otherwise, it uses the account statically as configured in Accounts on the Platform.	Boolean	❌	false	—
Scoped	If enabled, isolates the stored account from other sub-processes. Not supported for accounts used in headers or body. To learn more, read the Dynamic Accounts documentation.	Boolean	❌	false	Use Dynamic Account is enabled
Account Name	Name of the account defined in the Store Account connector.	String	✅	N/A	Use Dynamic Account is enabled
Account	Account to be used by the connector. Must be a Public or Private Key account type, configured in Accounts on the Platform.	String	❌	N/A	Use Dynamic Account is disabled
Operation	Defines the type of operation to be performed: Encrypt Fields, Decrypt Fields, Encrypt Payload, Decrypt Payload, Encrypt File, or Decrypt File.	String	❌	Encrypt Fields	—
Fields	Names of the fields to be encrypted or decrypted within the JSON entry. Multiple fields must be separated by commas (e.g., param1, param2).	String	❌	parameter	Operation is Encrypt Fields or Decrypt Fields
Payload	Content to be encrypted or decrypted. Can be defined as a single fixed value or dynamically referenced using Double Braces expression to get and set the payload.	String	✅	N/A	Operation is Encrypt Payload or Decrypt Payload
Charset	Character encoding used to interpret the text.	String	❌	UTF-8	—
File Name	Name or full path of the file to be encrypted or decrypted (e.g., tmp/processed/file.txt).	String	✅	N/A	Operation is Encrypt File or Decrypt File
Output File Name	Name to be assigned to the resulting encrypted or decrypted file.	String	✅	N/A	Operation is Encrypt File or Decrypt File
Hexadecimal	If enabled, the value to be signed or verified must be provided in hexadecimal format; otherwise, it is signed or verified in base64 format.	Boolean	❌	true	—
Armor	If enabled, encrypts the message using ASCII armor so it can be transmitted in standard text-based formats, such as email.	Boolean	❌	false	Operation is Encrypt Fields, Encrypt Payload, Encrypt File
Zip	If enabled, compresses the message before encryption.	Boolean	❌	false	Operation is Encrypt Fields, Encrypt Payload, Encrypt File
Integrity Check	If enabled, verifies the integrity of the message during the operation.	Boolean	❌	true	Operation is Encrypt Fields, Encrypt Payload, Encrypt File
Fail On Error	If enabled, interrupts pipeline execution when an error occurs. Otherwise, execution proceeds and the result returns false for the "success" property.	Boolean	❌	false	—

Documentation

Parameter	Description	Data type	Supports DB	Default value
Documentation	Optional field to describe the connector configuration and any relevant business rules.	String	❌	N/A

Messages flow

Operation Encrypt Fields

Input

{  
    "parameter": "TEXT TO BE ENCRYPTED"
}

Output

{  
    "parameter": "AA01FF" // text encrypted
}

Operation Decrypt Fields

Input

{  
    "parameter": "AA01FF" // text encrypted
}

Output

{  
    "parameter": "TEXT DECRYPTED"
}

Operation Encrypt Payload

Input

{  
    "parameter": "TEXT TO BE ENCRYPTED"
}

Output

{  
    "result": "AA01FF" // text encrypted
}

Operation Decrypt Payload

Input

{  
    "parameter": "AA01FF" // text encrypted
}

Output

{  
    "result": "TEXT DECRYPTED"
}

Operation Encrypt File

Input

{  
    "fileName": "file.txt"
}

Output

{  
    "outputFileName": "file.txt.pgp" // file encrypted
}

Operation Decrypt File

Input

{  
    "fileName": "file.txt.pgp" // file encrypted
}

Output

{  
    "outputFileName": "file.txt.dec" // file decrypted
}

Output with error

{   
    "error": "java.io.FileNotFoundException: data1.csv (No such file or directory)",  
    "success": false
}

• success: “false” when the operation fails.

• error: information about the occurred error.