Skip to main content
Documentation
Documentation
Administrator Guide
Last Updated: 2023-06-23
Reference: PGP-Encrypt Step Properties

Reference: PGP-Encrypt Step Properties

Common Tab

Property
XML Attribute Name
Description
Step ID
id
The unique ID of the
pgp-encrypt
 step within the assembly.
Input
input
Specifies where the
pgp-encrypt
 step obtains data as input. There are 5 possible values:
  • message
    : the entire message, including
    rootpart
     and attachments.
  • soapbody
    : the content of the SOAP body from the
    rootpart
     of the message. Only applicable when the input contains a SOAP message.
  • attachment
    : a MIME attachment within the message. Specify the attachment index.
  • rootpart
    : the content of the
    rootpart
     of a MIME message. If the message isn't MIME, Workday selects the entire message.
  • variable
    : use a named variable from the
    MediationContext
    .
Output
output
Specifies where the
pgp-encrypt
 step directs the output. There are 5 possible values:
  • message
    : the entire message, including
    rootpart
     and attachments. This value creates a new message, effectively removing any attachments.
  • soapbody
    : the content of the SOAP body from the
    rootpart
     of the message.
  • attachment
    : a MIME attachment within the message. Specify the attachment index.
  • rootpart
    : the content of the
    rootpart
     of a MIME message. If the message isn't MIME, Workday selects the entire message. This value preserves any attachments on the original message.
  • variable
    : save the output as a named variable in the
    MediationContext
    .
Ascii Armored
ascii-armored
Indicates whether the
pgp-encrypt
 step generates PGP data in ASCII-armored format (a PGP version of Base64) or in pure binary. ASCII-armored formatting produces email-friendly text, including a header and a footer.
Certificate
certificate
The certificate used for encryption, provided by 1 of these types of URL:
  • An attachment URL for retrieving the public key from the tenant. Must follow the pattern
    attachment:certificate/WIDvalue
    , where
    WIDvalue
     is the WID of the public key stored in the tenant. Example: you can configure the reference using an integration attachment in the form
    attachment:certificate/@ {intsys.getAttributeReferenceData('PGP Encryption Key', 'WID')}
     where
    PGP Encryption Key
     is the name of the integration attribute.
  • An mctx URL for retrieving the public key from the context variable where the integration stored it. Example:
    mctx:vars/MyPublicKey
     where
    MyPublicKey
     is the name of the context variable.
  • The filename of a public key stored in the assembly's WSAR-INF folder or in one of its subfolders. Examples:
    PublicKey.asc
     or
    /keys/PublicKey.asc
    .
Containing Integrity Check
containing-integrity-check
Indicates whether the
pgp-encrypt
 step generates a message signature for integrity checking by the receiver.
Decrypted Filename
decrypted-filename
A name for the decrypted file. Example:
yourname.plaintext.mail
. Workday includes the specified value in the hash string.
Pgp26x Compatible
pgp26x-compatible
Indicates whether the
pgp-encrypt
 step generates encrypted data that is backward compatible with the older pgp26x version.
Private Key Passphrase
private-key-passphrase
Specifies the passphrase for the private key.
Signing Private Key
signing-private-key
The private key used to sign messages as a filename, using the
file://
 protocol.
Best practice for Workday Studio integrations is to use a delivery service rather than the
pgp-encrypt
 step to perform encryption.
Textmode
textmode
Specify
true
 to indicate that the data to be encrypted is in text format, containing <CR><LF> line endings.
If you specify
true
 for data that doesn't contain <CR><LF> line endings, Workday reports an error.

Advanced Tab

Property
XML Attribute Name
Description
Description
description
A description of the
pgp-encrypt
 step that displays in the consolidated log. You can use this feature to describe the step's function and the data on which it's operating.
Execute When
execute-when
A condition that determines whether the
pgp-encrypt
 step executes.