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

Reference: Retrieve Step Properties

Common Tab

Property
XML Attribute Name
Description
Step ID
id
Specifies the unique ID of the
retrieve
step within the assembly.
Output
output
Specifies where the
retrieve
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
    .
When you configure a Document Retrieval Service on a Business Process, Workday uses the string you enter in the
Custom Content Type
field as the mimetype for the document stored by that service.
When you retrieve the document with a
retrieve
step, either directly or through a document iterator or document accessor helper object, Workday automatically marks it with the stored mimetype so later steps can process it correctly. If you don’t enter a
Custom Content Type
, Workday uses UTF-8 encoding. To avoid errors, always enter the appropriate
Custom Content Type
for data that isn't UTF-8 encoded.
Collection
collection
The name of the collection that stores your document.
Entry
entry
The identifier of the document in your collection. Retrievable from the
MediationContext
using an MVEL expression.
Example:
@{parts[0].xpath('//blob:entry', 'blob urn:com.workday/bsvc/blob')}
Password
password
The password credentials for accessing your document.
Username
username
The username credentials for accessing your document.

Advanced Tab

Property
XML Attribute Name
Description
Description
description
A description of the
retrieve
step that 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
retrieve
step executes.