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

  3. Workday Connector Reference

All Connectors

Workday Connector 15.0 Reference - Mule 4

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

Configuration

Default Configuration for Workday Connector.

Name Type Description Default Value Required

Name

String

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

x

Connection

Connection types for this configuration.

x

Time Zone

String

Indicates the timezone. Must 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 Mule waits for a response to complete before the request times out.

60

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

SECONDS

Name

String

ID used to reference this configuration.

x

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.

Workday Basic Authentication Connection Type

Uses your Workday username and password to authenticate the connection.

Name Type Description Default Value Required

Proxy Configuration

One of:

Configures a proxy for outbound connections.

Host name

String

Hostname of your Workday instance.

impl-cc.workday.com

Password

String

Password associated with the user name.

x

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

Indicates whether to use persistent connections:

  • true

    Mule uses persistent connections.

  • false

    Mule closes the connection after the first request completes.

true

Max Connections

Number

Maximum number of parallel outbound connections to keep open. The default value of -1 means unlimited connections for maximum throughput. If resource consumption is too high, lower this value accordingly.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Idle Timeout field.

SECONDS

Stream Response

Boolean

If set to true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

Connection Timeout

Number

How long 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 the Connection Timeout field.

SECONDS

TLS Configuration

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

x.509 Authentication Connection Type

Uses an X.509 certificate to authenticate the connection.

Name Type Description Default Value Required

Proxy Configuration

One of:

Configures a proxy for outbound connections.

Host name

String

Hostname 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

Indicates whether to use persistent connections:

  • true

    Mule uses persistent connections.

  • false

    Mule closes the connection after the first request completes.

true

Max Connections

Number

Maximum number of parallel outbound connections to keep open. The default value of -1 means unlimited connections for maximum throughput. If resource consumption is too high, lower this value accordingly.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Idle Timeout field.

SECONDS

Stream Response

Boolean

If set to true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

Connection Timeout

Number

How long 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 the Connection Timeout field.

SECONDS

TLS Configuration

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

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

C14N (canonicalization) algorithm to use.

EXCLUSIVE_XML_CANONICALIZATION_1_0

Sources

On Modified Objects

<workday:modified-objects-listener>

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Watermark Enabled

Boolean

If set to true, Mule processes an item just once, even if it receives the item multiple times.

false

Object Type

String

Workday object type that applies to this 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

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

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Scheduling Strategy

  • Fixed Frequency

  • Cron

Configures the scheduler that triggers the polling.

x

Streaming Strategy

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

Redelivery Policy

Redelivery Policy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Any

Attributes Type

SOAP Attributes

Associated Configurations

Operations

Absence Management

<workday:absence-management>

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

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Academic Advising

<workday:academic-advising>

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

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Academic Foundation

<workday:academic-foundation>

Invokes 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.

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Admissions

<workday:admissions>

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

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Adoption

<workday:adoption>

Invokes the Adoption web service.

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Benefits Administration

<workday:benefits-administration>

Invokes the Benefits Administration web service. The Benefits Administration web service contains operations that expose Workday Human Capital Management business services benefits-related data.

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. Repeatable streams are the default behavior.

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Campus Engagement

<workday:campus-engagement>

Invokes 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.

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Cash Management

<workday:cash-management>

Invokes 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.

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Compensation

<workday:compensation>

Invokes the Compensation web service, which contains operations that expose compensation data related to Workday Human Capital Management business services.

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Compensation Review

<workday:compensation-review>

Invokes the Compensation Review web service, which contains operations that expose the Workday Human Capital Management business services compensation data that relates to reviews.

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Drive

<workday:drive>

Invokes the Drive web service.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Any

Payload for the operation.

#[payload]

Headers

Any

Headers included in the request.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTE

  • WORKDAY:VALIDATION_ERROR

Dynamic Document Generation

<workday:dynamic-document-generation>

Invokes 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.

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

External Integrations

<workday:external-integrations>

Invokes 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.

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Financial Aid

<workday:financial-aid>

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

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Financial Management

<workday:financial-management>

Invokes 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.

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Human Resources

<workday:human-resources>

Invokes 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.

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Identity Management

<workday:identity-management>

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

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Integrations

<workday:integrations>

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

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Inventory

<workday:inventory>

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

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Learning

<workday:learning>

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

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

Metadata Translations

<workday:metadata-translations>

Invokes the Metadata Translations web service. Imports Metadata Translations using Enterprise Interface Builder (EIB).

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Any

Payload for the operation.

#[payload]

Headers

Any

Headers included in the request.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Moments

<workday:moments>

Invokes the Moments web service for creating, editing, and retrieving objects related to Workday Moments.

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Notification

<workday:notification>

Invokes 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.

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Org Studio

<workday:org-studio>

Invokes the Org Studio web service, which contains operations designed for interacting with Org Studio setup data.

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

Operation

String

Type of operation to execute.

x

Content

Any

Payload for the operation.

#[payload]

Headers

Any

Headers included in the request.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Payroll

<workday:payroll>

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

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Payroll CAN

<workday:payroll-can>

Invokes 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.

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Payroll FRA

<workday:payroll-fra>

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

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Payroll GBR

<workday:payroll-gbr>

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

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Payroll Interface

<workday:payroll-interface>

Invokes the Payroll Interface web service, which contains operations that expose Workday Human Capital Management business services data for integration with external payroll systems.

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Performance Management

<workday:performance-management>

Invokes 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.

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Professional Services Automation

<workday:professional-services-automation>

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

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Recruiting

<workday:recruiting>

Invokes 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.

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Resource Management

<workday:resource-management>

Invokes 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.

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Revenue Management

<workday:revenue-management>

Invokes 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.

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated 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.

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated 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.

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Staffing

<workday:staffing>

Invokes 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.

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Student Core

<workday:student-core>

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

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configure to use repeatable streams

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Student Finance

<workday:student-finance>

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

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Student Records

<workday:student-records>

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

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Student Recruiting

<workday:student-recruiting>

Invokes 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.

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Talent

<workday:talent>

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

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Tenant Data Translation

<workday:tenant-data-translation>

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

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Time Tracking

<workday:time-tracking>

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

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Workday Connect

<workday:workday-connect>

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

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Workday Extensibility

<workday:workday-extensibility>

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

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Workforce Planning

<workday:workforce-planning>

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

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.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

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

Response Timeout

Number

How long Mule waits for a response to complete before the request times out.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Target Variable

String

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

Target Value

String

Expression that evaluates the operation’s output. The outcome of the expression is stored in the Target Variable field.

#[payload]

Reconnection Strategy

Retry strategy for connectivity errors.

Output

Type

Binary

Attributes Type

SOAP Attributes

Associated Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:PROCESSING_ERROR

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:VALIDATION_ERROR

Object Types

CRL File

Specifies the location of the certification revocation list (CRL) file.

Field Type Description Default Value Required

Path

String

Path to the CRL file.

Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

Field Type Description Default Value Required

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

Default

Configures the default HTTP proxy configuration type.

Field Type Description Default Value Required

Host

String

Hostname or IP address of the proxy server.

x

Port

Number

Port of the proxy server.

x

Username

String

Username to authenticate against the proxy server.

Password

String

Password to authenticate against the proxy server.

Non Proxy Hosts

String

Non-proxy hosts.

Expiration Policy

Configures an expiration policy strategy.

Field Type Description Default Value Required

Max Idle Time

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

Key Store

Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.

Field Type Description Default Value Required

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system.

Type

String

Type of keystore.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

Non-Repeatable Stream

Disables the repeatable stream functionality and uses non-repeatable streams to have lower performance overhead, memory use, and cost.

NTLM

Configures the NTLM type.

Field Type Description Default Value Required

Ntlm Domain

String

NTLM domain.

x

Host

String

Hostname.

x

Port

Number

Port.

x

Username

String

Username.

Password

String

Password.

Non Proxy Hosts

String

Non proxy hosts.

Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Count

Number

How many reconnection attempts the Mule app can make.

Reconnect Forever

Configures a forever reconnection strategy by which the connector source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Reconnection

Configures a reconnection strategy for an operation.

Field Type Description Default Value Required

Fails Deployment

Boolean

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

  • true

    Allow the deployment to fail.

  • false

    Ignore the results of the connectivity test.

Reconnection Strategy

Reconnection strategy to use.

Redelivery Policy

Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.

Field Type Description Default Value Required

Max Redelivery Count

Number

Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.

Message Digest Algorithm

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

Message Identifier

Redelivery Policy Message Identifier

One or more expressions that determine if a message was redelivered. This property can be set only if the Use Secure Hash field is false.

Object Store

ObjectStore

Configures the object store that stores the redelivery counter for each message.

Redelivery Policy Message Identifier

Configures how to identify a redelivered message and how to find out when the message was redelivered.

Field Type Description Default Value Required

Use Secure Hash

Boolean

If true, Mule uses a secure hash algorithm to identify a redelivered message.

Id Expression

String

One or more expressions that determine when a message was redelivered. You can set this property only if the Use Secure Hash field is false.

Repeatable File Store Stream

Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is 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

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

  • Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.

  • Configure a smaller buffer size to decrease memory load at the expense of response time.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

Repeatable In-Memory Stream

Configures the in-memory streaming strategy by which the request fails if the data exceeds the MAX buffer size. Always run performance tests to find the optimal buffer size for your specific use case.

Field Type Description Default Value Required

Initial Buffer Size

Number

Initial amount of memory to allocate to the data stream. If the streamed data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.

Buffer Size Increment

Number

Amount by which the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower specifies that the buffer can’t expand.

Max Buffer Size

Number

Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a STREAM_MAXIMUM_SIZE_EXCEEDED error. A value of less than or equal to 0 means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

SOAP Attributes

Configures the SOAP attributes type.

Field Type Description Default Value Required

Transport Additional Data

Object

Transport additional data.

Transport Headers

Object

Transport headers.

Standard Revocation Check

Configures standard revocation checks for TLS certificates.

Field Type Description Default Value Required

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

    Verify only the last element in the certificate chain.

  • false

    Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

    Check the Certification Revocation List (CRL) for certificate validity.

  • false

    Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

    Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

  • false

    Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

    Avoid verification failure.

  • false

    Allow the verification to fail.

TLS

Configures TLS to provide secure communications for the Mule app.

Field Type Description Default Value Required

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Trust Store

Configures the TLS truststore.

Key Store

Key Store

Configures the TLS keystore.

Revocation Check

Configures a revocation checking mechanism.

Trust Store

Configures the truststore for TLS.

Field Type Description Default Value Required

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

Password

String

Password used to protect the truststore.

Type

String

Type of truststore.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

See Also

Back to top
View on GitHub