Contact Free trial Login

Workday Connector Reference

Support Category: Select

Workday Connector v11.0

Workday version 32

Configurations


Default Configuration

Parameters

Name Type Description Default Value Required

Name

String

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

x

Connection

The connection types to provide to this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when it sees fit.

Connection Types

Basic Authentication API
Parameters
Name Type Description Default Value Required

Proxy Configuration

One of:

Use Persistent Connections

Boolean

true

Max Connections

Number

-1

Connection Idle Timeout

Number

Timeout in milliseconds.

30000

Stream Response

Boolean

false

Response Buffer Size

Number

-1

Connection Timeout

Number

Timeout in milliseconds.

30000

User Name

String

x

Password

String

x

Tenant Name

String

x

Host Name

String

impl-cc.workday.com

TLS Configuration

TLS

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.

Operations

Absence Management

<workday:absence-management>

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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Academic Advising

<workday:academic-advising>

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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

  • WORKDAY:CONNECTIVITY

Academic Foundation

<workday:academic-foundation>

Public web service for creating, editing, and retrieving the foundational objects for the student system, such as programs of study, educational institutions, and other 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

  • WORKDAY:CONNECTIVITY

Admissions

<workday:admissions>

Web service for creating, editing, and retrieving objects related to admissions, such as 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Adoption

<workday:adoption>

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

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Benefits Administration

<workday:benefits-administration>

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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Campus Engagement

<workday:campus-engagement>

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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Cash Management

<workday:cash-management>

The Cash Management web service contains operations that expose Workday financial cash management data. It 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Compensation

<workday:compensation>

The Compensation web service contains operations that expose Workday human capital management business services compensation-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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Compensation Review

<workday:compensation-review>

The Compensation Review web service contains operations that expose 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Dynamic Document Generation

<workday:dynamic-document-generation>

Web service for creating, editing, and retrieving 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

External Integrations

<workday:external-integrations>

The External Integrations web service 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Financial Aid

<workday:financial-aid>

This web service is 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Financial Management

<workday:financial-management>

The Financial Management web service contains operations that expose Workday financial 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Human Resources

<workday:human-resources>

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 or other provisioning sub-systems, or any other systems needing worker and 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Identity Management

<workday:identity-management>

The Identity Management web service 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Integrations

<workday:integrations>

This web service 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Inventory

<workday:inventory>

The Inventory web service contains operations that expose Workday financial 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Learning

<workday:learning>

The Learning web service contains operations for creating, editing, and retrieving Workday learning-related data such 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Notification

<workday:notification>

The Notification web service provides an operation that informs external systems of 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Payroll

<workday:payroll>

The Workday Payroll web service 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Payroll CAN

<workday:payroll-can>

The Workday Payroll CAN web service contains operations that expose Workday Canadian 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Payroll FRA

<workday:payroll-fra>

The Workday Payroll FRA web service contains operations that expose Workday French 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Payroll GBR

<workday:payroll-gbr>

The Workday Payroll GBR web service 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Payroll Interface

<workday:payroll-interface>

The Payroll Interface web service 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Performance Management

<workday:performance-management>

The Performance Management web service 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Professional Services Automation

<workday:professional-services-automation>

The Professional Services Automation web service contains operations that expose Workday financial 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Recruiting

<workday:recruiting>

The Recruiting web service 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Resource Management

<workday:resource-management>

The Resource Management web service contains operations that expose Workday financial resource management data. It 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Revenue Management

<workday:revenue-management>

The Revenue Management web service contains operations that expose Workday financial revenue management data. It 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Settlement Services

<workday:settlement-services>

Web service 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Staffing

<workday:staffing>

The Staffing web service operations expose 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Student Finance

<workday:student-finance>

Web service 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Student Records

<workday:student-records>

Web service for creating, editing, and retrieving objects related to student records, such as student courses, sections etc.

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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Student Recruiting

<workday:student-recruiting>

Web service 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Talent

<workday:talent>

This web service 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Tenant Data Translation

<workday:tenant-data-translation>

Public web service to export and import 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Time Tracking

<workday:time-tracking>

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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Workday Connect

<workday:workday-connect>

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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Workday Extensibility

<workday:workday-extensibility>

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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Workforce Planning

<workday:workforce-planning>

The Workforce Planning web service operations 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.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • WORKDAY:CONNECTIVITY

  • WORKDAY:RETRY_EXHAUSTED

  • WORKDAY:UNKNOWN

Sources

New Objects Trigger

<workday:new-objects-trigger>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Object Type

Enumeration, one of:

  • ABSENCE_INPUTS

  • ACADEMIC_CONTACTS

  • ALL_CURRENCIES

  • APPLICANTS

  • BASIC_CUSTOMERS

  • CANDIDATES

  • CERTIFICATION_ISSUERS

  • CERTIFICATIONS

  • COMPETENCIES

  • DEGREES

  • DONORS

  • EDUCATION_TEST_RESULTS

  • EDUCATIONAL_INSTITUTION_COURSE

  • HEALTH_CARE_RATES

  • INVESTORS

  • ORGANIZATIONS

  • PAYMENTS

  • PROGRAMS_OF_STUDY

  • STUDENTS

  • STUDENTS_APPLICATIONS

  • WORKERS

x

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster.

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Redelivery Policy

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

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

String

Attributes Type

Any

For Configurations

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 of the trust store, which resolves relative to the current classpath and file system, if possible.

Password

String

The password used to protect the trust store.

Type

String

The type of 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 of the key store, which resolves relative to the current classpath and file system, if possible.

Type

String

The type of 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 in milliseconds to reconnect.

Count

Number

How many reconnection attempts to make.

blocking

Boolean

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

true

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

blocking

Boolean

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

true

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:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime 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 may only be set if useSecureHash is false.

Object Store

Object Store

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

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of memory that will be 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

Max 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

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub