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

Reference: Zip Step Properties

Common Tab

Property
XML Attribute Name
Description
Step ID
id
The unique ID of the
zip
 step within the assembly.
Input
input
Specifies where the
zip
 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
zip
 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
    .
Format
format
The format of the zipped file. The options are:
  • zip
  • tar
The TAR format supports archiving but not compression. To compress TAR files, use either of these commands:
  • gzip, which replaces the .tar file extension with .tar.gz or .tgz
  • bzip2, which replaces the .tar file extension with .tar.bz2
You can compress and decompress TAR archives produced in the
zip
 step using the
compress
 and
decompress
 steps, respectively.
Level
level
The level of compression in the range zero to 9, with 9 being maximum compression. The default value is -1.

Advanced Tab

Property
XML Attribute Name
Description
Description
description
A description of the
zip
 step. Displays in the consolidated log. You can use this feature to describe the step's function and the data on which it is operating.
Execute When
execute-when
A condition that determines whether the
zip
 step executes.
Comment
comment
A comment that's embedded in the ZIP file. The comment is an arbitrary ASCII string of up to 65,535 bytes.