Contact Free trial Login

Workday Connector Reference - Mule 4

Support Category: Select

Workday Connector Version 12.0
Workday version 34

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

Configurations


Configuration Version 34

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

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

The unit for the Response Timeout parameter

SECONDS

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

Basic Authentication API v34
Parameters
Name Type Description Default Value Required

Proxy Configuration

One of:

Use Persistent Connections

Boolean

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

true

Max Connections

Number

The maximum number of outbound connections that are kept open at the same time. By default, the number of connections is unlimited.

-1

Connection Idle Timeout

Number

How long a connection can remain idle before it is closed, based on the unit specified in the Connection Idle Timeout Unit field. The value of this attribute is only used when persistent connections are enabled.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The unit for Connection idle timeout

SECONDS

Stream Response

Boolean

Whether or not to stream received responses, meaning processing continues at the moment all headers are parsed and the body streamed as it arrives. When enabled, the response MUST be read because, depending on the configured buffer size, the response might not fit into memory, in which case processing stops until space is available.

false

Response Buffer Size

Number

The space in bytes for the buffer where the HTTP response is stored. The -1 default sets the buffer size to 10 KB.

-1

Connection Timeout

Number

How long a connection can remain idle before it is closed, based on the unit specified in the Connection Timeout Unit field. The value of this attribute is only used when persistent connections are enabled.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

The unit for the Connection Timeout parameter

SECONDS

User Name

String

Username

x

Password

String

Password

x

Tenant name

String

Your Workday tenant name or ID.

x

Host name

String

Host name of your Workday instance.

impl-cc.workday.com

TLS Configuration

TLS

Protocol to use for communication. Valid values are HTTP and HTTPS. When using HTTPS, the HTTP communication is secured using TLS or SSL. In this case, the user must configure at least the keystore in the tls:context child element of this listener-config.

HTTP

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.

Input 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

The 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

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

The unit for the Response Timeout parameter

Reconnection Strategy

A retry strategy for connectivity errors

Output

Type

Binary

Attributes Type

For Configurations

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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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. Public web service for creating, editing, and retrieving the foundational objects for the student system, such as 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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>

Invoke 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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 review 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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. 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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 that have been triggered from within Workday. The WSDL for this service provides the structure that needs to be implemented by an external system 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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. It 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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. The Human Resources web service contains operations that expose Workday Human Capital Management Business Services data, including employee, contingent worker and Organization information. This web service can be used for integration with enterprise systems including corporate directories, data analysis tools, email, other provisioning sub-systems, or any other systems needing worker, and/or organization 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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. The Learning web service 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

Type of operation to execute.

x

Content

Binary

Payload for the operation.

#[payload]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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 needs to be implemented by an external system 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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.

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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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.

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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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. This web service can be used for integration 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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

Settlement Services

<workday:settlement-services>

Invoke 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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 for students.

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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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]

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

The unit for the Response Timeout parameter

Target Variable

String

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

Target Value

String

An expression to evaluate against the operation’s output. The result 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

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

Key Store

Revocation Check

Trust Store

Field Type Description Default Value Required

Path

String

The location (which is resolved relative to the current classpath and file system, if possible) of the trust store.

Password

String

The password used to protect the trust store.

Type

String

The type of trust store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

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

Key Store

Field Type Description Default Value Required

Path

String

The location (which is resolved relative to the current classpath and file system, if possible) of the key store.

Type

String

The type of key store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. 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 key store.

Algorithm

String

The algorithm used by the key store.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

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 trust store), 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 in milliseconds to reconnect.

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 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 has been redelivered. This property can be set only if Use Secure Hash 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

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 bufferSizeIncrement attribute, 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

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

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.