Contact Us 1-800-596-4880
  1. Homepage
  2. Workday Connector (14.1)

  3. Workday Connector Reference

All Connectors

Workday Connector 14.1 Reference - Mule 4

Anypoint Connector for Workday (Workday Connector) provides access to standard Workday operations.

Configurations

Configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration.

x

Time Zone

String

Choose your timezone. Time zone needs to be in the format 'UTC+01:00'

UTC

Encoding

String

Value that overrides the default Mule encoding value. The value must be one of the standard encoding values, for example, UTF-8.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

60

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

SECONDS

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate.

Connection Types

Connection authentication types to provide to this configuration.

Workday Basic Authentication Connection

Uses your Workday username and password for authenticating the connection.

Parameters
Name Type Description Default Value Required

Proxy Configuration

One of:

Password

String

Password associated with the User Name

x

Host name

String

Host name of your Workday instance

impl-cc.workday.com

Tenant name

String

Workday tenant name or ID. Use expressions in this field to configure a connection for multiple tenants.

x

User Name

String

User name

x

Use Persistent Connections

Boolean

If false, each connection is closed after the first request is completed.

true

Max Connections

Number

Maximum number of outbound connections to keep open concurrently. By default, the number of connections is unlimited.

-1

Connection Idle Timeout

Number

Amount of time that a connection can remain idle before it is closed. The value of this attribute is used only when persistent connections are enabled.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for Connection Idle Timeout

SECONDS

Stream Response

Boolean

Whether or not to stream received responses, meaning processing continues as soon as all headers are parsed and the body is streamed as it arrives. When enabled, the response must eventually be read since, depending on the configured buffer size, it might not fit into memory and processing stops until space is available.

false

Response Buffer Size

Number

The space, in bytes, for the buffer where the HTTP response is stored.

-1

Connection Timeout

Number

The number of units that a connection can remain idle before it is closed. The value of this attribute is used only when persistent connections are enabled.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for Connection Timeout

SECONDS

TLS Configuration

TLS

Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol then the user needs to configure at least the keystore in the tls:context child element of the listener-config.

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

x.509 Authentication Workday API v34

Uses a x.509 certificate to authenticate the connection.

Parameters
Name Type Description Default Value Required

Proxy Configuration

One of:

Host name

String

Host name of your Workday instance.

impl-cc.workday.com

Tenant name

String

Workday tenant name or ID. Use expressions in this field to configure a connection for multiple tenants.

x

User Name

String

The user name

x

Use Persistent Connections

Boolean

If false, each connection is closed after the first request is completed.

true

Max Connections

Number

Maximum number of outbound connections to keep open at the same time. By default, the number of connections is unlimited.

-1

Connection Idle Timeout

Number

Amount of time that a connection can remain idle before it is closed. The value of this attribute is used only when persistent connections are enabled.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Unit of time for Connection idle timeout

SECONDS

Stream Response

Boolean

Whether or not to stream received responses, meaning processing continues as soon as all headers are parsed and the body is streamed as it arrives. When enabled, the response must eventually be read since, depending on the configured buffer size, it might not fit into memory and processing stops until space is available.

false

Response Buffer Size

Number

The space, in bytes, for the buffer where the HTTP response is stored.

-1

Connection Timeout

Number

Amount of time that a connection can remain idle before it is closed. The value of this attribute is used only when persistent connections are enabled.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for Connection Timeout

SECONDS

TLS Configuration

TLS

Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol then the user needs to configure at least the keystore in the tls:context child element of the listener-config.

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Key Store Path

String

Location of the keystore file

x

Type

Enumeration, one of:

  • JKS

  • PKCS12

  • JCEKS

Type of the keystore

JKS

Password

String

Password to access the keystore

Alias

String

Alias of the private key to use

x

Signature Algorithm

Enumeration, one of:

  • RSA_SHA1

  • RSA_SHA256

Signature algorithm to use

RSA_SHA1

Digest Algorithm

Enumeration, one of:

  • SHA256

  • SHA512

Digest algorithm to use

SHA256

Canonicalization algorithm

Enumeration, one of:

  • CANONICAL_XML_1_0

  • CANONICAL_XML_1_1

  • EXCLUSIVE_XML_CANONICALIZATION_1_0

The c14n (canonicalization) algorithm to use.

EXCLUSIVE_XML_CANONICALIZATION_1_0

Source

On Modified Objects

<workday:modified-objects-listener>

Initiates a flow when an instance of the specified Workday object type is created, modified, or deleted.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Watermark Enabled

Boolean

If you enable this field, Mule processes an item just once, even if it receives the item multiple times.

false

Object Type

String

The Workday object type that applies to this input source. The following object types are supported:

  • JOB_PROFILES

  • WORKERS

  • POSITIONS

  • EVERGREEN_REQUISITIONS

  • JOB_REQUISITIONS

x

Updated From

String

Required date format is 'yyyy-MM-dd’T’HH:mm:ss.SSS'.

Encoding

String

The value that overrides the default runtime encoding value. The value must be one of the standard encoding values, such as UTF-8. Refer to the java.nio.charset.StandardCharsets Javadoc for the format and valid values for this field.

Scheduling Strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

List of Supported Operations

Operations

Absence Management

<workday:absence-management>

Invoke the Absence Management web service. The Absence Management web service contains operations that expose absence-related data, including employee time off and absence inputs for time off and accrual adjustments and overrides, and leave requests, in Workday Human Capital Management business services.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Academic Advising

<workday:academic-advising>

Invoke the Academic Advising web service. Retrieve objects related to academic advising, such as student academic requirement assignments.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configure how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Academic Foundation

<workday:academic-foundation>

Invoke the Academic Foundation web service, which is a Public web service for creating, editing, and retrieving the foundational objects for the student system. These objects include programs of study, educational institutions, and other objects with cross-module uses.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Admissions

<workday:admissions>

Invoke the Admissions web service, which is a web service for creating, editing, and retrieving objects related to admissions and applicants.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Adoption

<workday:adoption>

This operation invokes the Adoption web service.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Benefits Administration

<workday:benefits-administration>

Invoke the Benefits Administration web service. The Benefits Administration web service contains operations that expose Workday human capital management business services benefits-related data.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Campus Engagement

<workday:campus-engagement>

Invoke the Campus Engagement web service, which is a public web service for creating, editing, and retrieving objects related to planning and organizing communication between student prospects and recruiters.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Cash Management

<workday:cash-management>

Invoke the Cash Management web service, which contains operations that expose Workday financials cash management data. The Cash Management web service includes data relative to banking.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Compensation

<workday:compensation>

Invoke the Compensation web service, which contains operations that expose compensation data related to Workday Human Capital Management Business Services.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Compensation Review

<workday:compensation-review>

Invoke the Compensation Review web service, which contains operations that expose the Workday human capital management business services compensation data that relates to reviews.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Dynamic Document Generation

<workday:dynamic-document-generation>

Invoke the Dynamic Document Generation web service, which contains operations to create, edit, and retrieve objects related to document templates, such as text blocks and text block categories.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

External Integrations

<workday:external-integrations>

Invoke the External Integrations web service, which provides an operation that informs external systems of integration events triggered from within Workday. The WSDL for this service provides the structure that an external system must implement to receive event launch information.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Financial Aid

<workday:financial-aid>

Invoke the Financial Aid web service for the Financial Aid module.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Financial Management

<workday:financial-management>

Invoke the Financial Management web service, which contains operations that expose Workday Financials data. This web service includes data relative to accounts, accounting, business plans, financial reporting, tax, financial organizations, basic worktags, related worktags, and more.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Human Resources

<workday:human-resources>

Invoke the Human Resources web service, which contains operations that expose Workday Human Capital Management Business Services data, including employee, contingent worker, and organization information. Use this web service to integrate with enterprise systems, including corporate directories, data analysis tools, email, other provisioning sub-systems, and any other systems needing worker data, organization data, or both.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Identity Management

<workday:identity-management>

Invoke the Identity Management web service, which contains operations that relate to Workday identity and access management.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Integrations

<workday:integrations>

Invoke the Integrations web service, which contains operations related to all integrations within the Workday system.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Inventory

<workday:inventory>

Invoke the Inventory web service, which contains operations that expose Workday Financials Inventory data.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Learning

<workday:learning>

Invoke the Learning web service, which contains operations for creating, editing, and retrieving Workday Learning-related data such as courses, course offerings, and enrollments.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use

x

Operation

String

The type of operation to execute

x

Content

Binary

The payload for the operation

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

Moments

<workday:moments>

Web service for creating, editing, and retrieving objects related to Workday Moments.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use

x

Operation

String

Type of operation to execute

x

Content

Binary

Payload for the operation

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations.

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Notification

<workday:notification>

Invoke the Notification web service, which provides an operation that informs external systems about business events that occur within Workday. The WSDL for this service provides the structure that an external system must implement to receive notifications for their subscribed Workday business events. Subscriptions and notification details, such as endpoint and security information, are defined within the Workday application.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Payroll

<workday:payroll>

Invoke the Payroll web service, which contains operations that expose Workday Payroll data for integration with third parties, such as time and attendance systems.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Payroll CAN

<workday:payroll-can>

Invoke the Payroll CAN web service, which contains operations that expose Workday Payroll Canadian data for integration with third parties, such as time and attendance systems.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Payroll FRA

<workday:payroll-fra>

Invoke the Payroll FRA web service, which contains operations that expose Workday Payroll France data for integration with third parties.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Payroll GBR

<workday:payroll-gbr>

Invoke the Payroll GBR web service, which contains operations that expose Workday UK Payroll data for integration with third parties.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Payroll Interface

<workday:payroll-interface>

Invoke the Payroll Interface web service, which contains operations that expose Workday Human Capital Management Business Services data for integration with external payroll systems.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Performance Management

<workday:performance-management>

Invoke the Performance Management web service, which contains operations that expose Workday Employee Performance Management Business Services data. Use this web service to integrate with other employee performance management systems.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Professional Services Automation

<workday:professional-services-automation>

Invoke the Professional Services web service, which contains operations that expose Workday Financials Business Services data for integration with Professional Services Automation (PSA) systems.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Recruiting

<workday:recruiting>

Invoke the Recruiting web service, which contains operations that expose Workday Human Capital Management Business Services data for integration with talent management and applicant tracking systems.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Resource Management

<workday:resource-management>

Invoke the Resource Management web service, which contains operations that expose Workday Financials Resource Management data. The Resource Management web service includes data relative to suppliers, supplier accounts, expenses, business assets, and projects.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Revenue Management

<workday:revenue-management>

Invoke the Revenue Management web service, which contains operations that expose Workday Financials Revenue Management data. The Revenue Management web service includes data relative to customers, customer accounts, prospects, and opportunities.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Scheduling

<workday:scheduling>

Invokes the Scheduling web service, which contains operations for importing and exporting scheduling data.

Parameters

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. The default is to use repeatable streams.

Response Timeout

Number

Time to wait for a response.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The unit for Response timeout

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Settlement Services

<workday:settlement-services>

Invokes the Settlement Services web service, which is used for settlement management and services.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Staffing

<workday:staffing>

Invoke the Staffing web service, which exposes Workday human capital management business services and data. These services pertain to staffing transactions for both employees and contingent workers, such as bringing employees and contingent workers on board.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Student Core

<workday:student-core>

Invoke the Student Core Web Service, which is used for creating, editing, and retrieving objects related to students' personal information, such as student documents.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use

x

Operation

String

Type of operation to execute

x

Content

Binary

Payload for the operation

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configure to use repeatable streams

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Student Finance

<workday:student-finance>

Invoke the Student Finance web service, which is used for creating, editing, and retrieving objects related to student finance, such as charges and payments.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Student Records

<workday:student-records>

Invoke the Student Records web service, which is used for creating, editing, and retrieving objects related to student records, such as student courses, sections, and so forth.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Student Recruiting

<workday:student-recruiting>

Invoke the Student Recruiting web service, which is used for creating, editing, and retrieving objects related to student recruiting, such as student recruiting events, campaigns, cycles, recruiters, and prospects.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Talent

<workday:talent>

Invoke the Talent web service, which consists of operations for interfacing with the Workday Talent Management web service operations.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Tenant Data Translation

<workday:tenant-data-translation>

Invoke the Tenant Data Translation web service, which is a public web service for exporting and importing translatable tenant data.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Time Tracking

<workday:time-tracking>

Invoke the Time Tracking web service, which contains operations for importing and exporting time and work schedule information.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Workday Connect

<workday:workday-connect>

Invoke the Workday Connect web service, which contains Get and Put web services used for communication capabilities across applications.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Workday Extensibility

<workday:workday-extensibility>

Invoke the Workday Extensibility web service, which is a public web service for extensibility features across applications.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Workforce Planning

<workday:workforce-planning>

Invoke the Workforce Planning web service, which contains operations that expose Workforce Planning business services and data.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

Headers

Binary

Headers included in the request.

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Response Timeout

Number

How long to wait for a response, based on the unit in the Response Timeout field

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field

Target Variable

String

The name of a variable that stores the operation’s output.

Target Value

String

An expression that evaluates against the operation’s output. The outcome of the expression is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Types

TLS

Defines a configuration for TLS, which can be used from both the client and server sides to secure communication for the Mule app. When using the HTTPS protocol, the HTTP communication is secured using TLS or SSL. If HTTPS is configured as the protocol then the user needs to configure at least the keystore in the tls:context child element of the listener-config.

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Trust Store

For servers, a truststore contains certificates of the trusted clients. For clients, a truststore contains certificates of the trusted servers.

Key Store

Key Store

For servers, a keystore contains the private and public key of the server. For clients, a keystore contains the private and public key of the client.

Revocation Check

Validates that a certificate was revoked.

Trust Store

Field Type Description Default Value Required

Path

String

The location of the truststore. The path is resolved relative to the current classpath and file system, if possible.

Password

String

The password used to protect the truststore.

Type

String

The type of truststore used.

Algorithm

String

The algorithm used by the truststore.

Insecure

Boolean

If true, no certificate validations are performed, which makes connections vulnerable to attacks. Use at your own risk.

Key Store

Field Type Description Default Value Required

Path

String

The location of the keystore. The path is resolved relative to the current classpath and file system, if possible.

Type

String

The type of keystore used.

Alias

String

The alias of the key to use when the keystore contains multiple private keys. If not defined, the first key in the file is used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the keystore.

Algorithm

String

The algorithm used by the keystore.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Verify the last element of the certificate chain only.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method, which is the one selected in the Prefer Crls field.

Soft Fail

Boolean

Avoid verification failure when the revocation server cannot be reached or is busy.

Custom OCSP Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the truststore), if present.

CRL File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often to reconnect, in milliseconds

Count

Number

The number of reconnection attempts to make

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often to reconnect, in milliseconds

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • DAYS

  • HOURS

  • MICROSECONDS

  • MILLISECONDS

  • MINUTES

  • NANOSECONDS

  • SECONDS

A time unit that qualifies the Max Idle Time attribute.

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering a process-failed-message

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

Id Expression

String

Defines one or more expressions to use to determine when a message was redelivered. This property can be set only if the Use Secure Hash field value is false.

Object Store

Object Store

The object store where the redelivery counter for each message is stored.

SOAP Attributes

Field Type Description Default Value Required

Transport Additional Data

Object

Transport Headers

Object

Repeatable In-Memory Stream

When streaming in this mode, Mule does not use the disk to buffer the contents. If you exceed the buffer size, the message fails.

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of memory that is allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the Buffer Size Increment field, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

The maximum amount of memory to use. If more than that is used, then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed

Repeatable File Store Stream

File store repeatable streams require buffering, and there are different buffering strategies. Mule keeps a portion of contents in memory. If the stream contents are larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.

Field Type Description Default Value Required

In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed, then it will start to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed

Non-repeatable Stream

Disable the repeatable stream functionality and use non-repeatable streams to have less performance overhead, memory use, and cost.

Default

Field Type Description Default Value Required

Host

String

x

Port

Number

x

Username

String

Password

String

Non Proxy Hosts

String

NTLM

Field Type Description Default Value Required

Ntlm Domain

String

x

Host

String

x

Port

Number

x

Username

String

Password

String

Non Proxy Hosts

String

Fixed Frequency

Field Type Description Default Value Required

Frequency

Number

The frequency at which the Scheduler initiates the flow, based on the time unit specified in the Time Unit field. The default frequency is 1000ms (1s).

1000ms

*

Start delay

Number

The amount of time that the Scheduler waits before initiating the flow for the first time after the app starts. This value is based on the time unit specified in the Time Unit field.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the frequency value

MILLISECONDS

*

Cron

Field Type Description Default Value Required

Expression

String

Cron expression

*

Time zone

String

ID of the time zone on which to base the expression. Refer to the java.util.TimeZone Javadoc for the format and valid values for this ID.

See Also

Back to top
View on GitHub