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

  3. Upgrading and Migrating Workday Connector

All Connectors

Upgrading and Migrating Workday Connector to 17.x

Upgrade Anypoint Connector for Workday (Workday Connector) from version 16.x to version 17.x.

Supported Upgrade Paths

From Version To Version

16.x

17.x

Changes in This Release

17.0

  • This connector is now compatible with Java 17 only.

  • The connector now uses Workday API v47.0 instead of v46.0. Workday removes three operation choices from the Financial Management and Compensation services. Service-specific connector operations remain available. Review the required migrations in Removed Workday Operations. Workday-deprecated operation choices remain available. See Workday-Deprecated Operations when planning replacements. For more information, see Financial Management and Compensation.

  • Workday API v47.0 adds 51 operation choices across 15 existing service components. Select the service component and choose the API operation in its Operation field. These choices aren’t new dedicated connector components. See Added Workday Operations for the complete list and links to the service reference sections.

  • The SOAP engine is upgraded to version 3.0.3. Test SOAP requests, response mappings, and authentication before deploying to production.

  • Timeout unit XML attributes are renamed: responseTimeoutUnit is now responseTimeoutTimeUnit, connectionTimeoutUnit is now connectionTimeoutTimeUnit, and connectionIdleTimeoutUnit is now connectionIdleTimeoutTimeUnit. The Response Timeout default remains 60 seconds, and the Connection Timeout and Connection Idle Timeout defaults remain 30 seconds. For migration steps, see Configuration Migration. For more information, see Configuration and Workday Basic Authentication Connection Type.

  • The Signature Algorithm for X.509 authentication now supports only RSA_SHA256, which replaces the previous RSA_SHA1 default. Custom SOAP headers are now sent and included in the signed envelope. The header input must have a headers root element. For more information, see X.509 Authentication Connection Type.

  • The OAuth State field is now labeled OAuth State. The X.509 Type, Password, and Alias fields are now labeled Key Store Type, Key Store Password, and Key Alias. Their XML attribute names are unchanged. For more information, see Workday OAuth Code Authentication Connection Type and X.509 Authentication Connection Type.

  • Host name now accepts only a hostname with an optional port. Values containing a URL scheme, user information, path, query, fragment, or spaces are rejected. Tenant names are URL-encoded in service addresses, and user and tenant values are XML-escaped in SOAP requests. For more information, see Workday Basic Authentication Connection Type, Workday OAuth Code Authentication Connection Type, and X.509 Authentication Connection Type.

  • Content and Headers for SOAP operations now use the Any type, instead of Binary. Operations also expose Encoding to override the configuration encoding and Error Mappings to map connector errors. For more information, see the Workday Connector Reference and Error Mapping.

  • Authentication faults on Basic and X.509 connections now raise WORKDAY:UNAUTHORIZED. Authorization and invalid-ID validation faults can raise WORKDAY:INSUFFICIENT_PRIVILEGES and WORKDAY:NOT_FOUND. Transport failures raise WORKDAY:CONNECTIVITY, and request timeouts raise WORKDAY:TIMEOUT. Review error handlers and reconnection behavior in Understand Commonly Thrown Exceptions.

  • The new WORKDAY:SERVICE_UNAVAILABLE error is a child of WORKDAY:CONNECTIVITY. HTTP 429 and 503 responses map to this error internally and can surface as WORKDAY:CONNECTIVITY after runtime retries. For more information, see Understand Commonly Thrown Exceptions.

  • Object Type on the On Modified Objects source is now an enumeration instead of a string. The supported object types are unchanged. For more information, see On Modified Objects.

  • Watermark Enabled on the On Modified Objects source now defaults to true. After a restart, a stored watermark takes precedence over Updated From. Watermarks now represent the end of the polling window instead of the time a record was emitted. For more information, see On Modified Objects.

  • The On Modified Objects source now uses the same time bounds for every page in a poll. With watermarks enabled, a window limited by maxItemsPerPoll is fetched again on subsequent polls so Mule can filter previously emitted records. Invalid Updated From or Time Zone values now fail at source startup with WORKDAY:VALIDATION_ERROR. Review replay and restart considerations in Polling Migration. For more information, see On Modified Objects.

  • The SoapAttributes class moves from com.mulesoft.connector.workday.extension.api to com.mulesoft.connector.workday.extension.api.attributes. The class is now immutable and adds Status Code and Reason Phrase. Algorithm and keystore parameter classes move to com.mulesoft.connector.workday.extension.api.parameter. Update custom Java imports and DataWeave references. For more information, see SOAP Attributes.

  • Transport Headers in SOAP response attributes now preserve case-insensitive header lookup. For more information, see SOAP Attributes.

  • SOAP debug logging now redacts password, binary security token, and signature values. Other payload data and custom headers can still contain sensitive information. Enable debug logging only when necessary and restrict access to the logs.

  • The connector no longer depends on the REST SDK commons library.

  • These libraries are updated:

    • The jackson-core and jackson-databind libraries now use version 3.2.4 and the tools.jackson.core group. The jackson-annotations dependency remains on the 2.x line.

    • The asm library is upgraded to version 9.11.1.

    • The commons-collections4 library is upgraded to version 4.6.0.

    • The guava library is upgraded to version 33.8.0-jre.

    • The commons-lang3 library is upgraded to version 3.21.0.

    • The connector now uses the commons-text library version 1.15.0.

    • The mule-wsdl-parser library is upgraded to version 1.4.14.

Requirements

Ensure your system meets these requirements before upgrading:

Application/Service Version

Mule runtime

4.9.0 and later

Workday API

v47.0

OpenJDK

17

X.509 authentication isn’t supported in FIPS mode.

Upgrade Prerequisites

Before you upgrade:

  1. Back up your application, configuration, mappings, and source object stores.

  2. Upgrade the application’s Mule runtime to 4.9.0 or later and use Java 17.

  3. Inventory the Workday service operations and source configurations in your flows, including operation names supplied dynamically through properties or expressions.

  4. Review the removed Workday operations, timeout XML attributes, X.509 signing algorithm, custom Java references, error handlers, and polling behavior described in this guide.

  5. Confirm that your Workday integration user has the required domain-security permissions for the v47 replacement operations.

Added Workday Operations

Workday API v47.0 adds these 51 operation choices. In Studio, add the corresponding Workday service component to your flow and select the API operation in its Operation field. For example, select Resource Management to use Get_Project_Notes. Refresh metadata to obtain the v47 request and response structures.

Service Component Added API Operations

Admissions

  • Bulk_Import_Put_Student_Application_Change_Published_Admissions_Decision_Details

  • Put_Student_Application_Change_Published_Admissions_Decision_Details

Cash Management

  • Get_Bank_Connectivity_Reference_Data_Mappings

  • Get_Normalized_Balances

  • Put_Bank_Connectivity_Reference_Data_Mapping

  • Put_Normalized_Balance

Compensation

  • Correct_Compensation_Change

Financial Aid

  • Get_COD_Loan_Limit_Exception_for_Financial_Aid_Period_Records

  • Import_COD_Loan_Limit_Exception

Financial Management

  • Get_Cost_and_Profitability_Condition_Rules

  • Get_Cost_and_Profitability_Group_Sets

  • Get_Cost_and_Profitability_Model_Definitions

  • Get_Cost_and_Profitability_Rules

  • Put_Cost_and_Profitability_Condition_Rule

  • Put_Cost_and_Profitability_Group_Set

  • Put_Cost_and_Profitability_Model_Definition

  • Put_Cost_and_Profitability_Rule

  • Submit_Tax_Declaration_Run

Integrations

  • Get_Custom_Sequence_Generator_Locales

  • Put_Custom_Sequence_Generator_Locale

Payroll

  • Get_Payroll_Election_Worker_Data

  • Put_Payroll_Election_Worker_Data

Recruiting

  • Get_Recruiting_Document_Category_Groups

  • Put_Recruiting_Document_Category_Group

Resource Management

  • Assign_Capital_Project_Transaction

  • Capitalize_Project_Asset

  • Get_Capital_Project_Transactions

  • Get_Company_Expenses_Options

  • Get_Project_Assets_for_Capitalization

  • Get_Project_Notes

  • Get_Project_Resource_Assignments

  • Get_Project_Resource_Requests

  • Get_Resource_Notes

  • Get_Supplier_Contract_CLM_Assignment_Rules

  • Put_Company_Expenses_Options

  • Put_Project_Note

  • Put_Resource_Note

  • Put_Supplier_Contract_CLM_Assignment_Rule

  • Submit_Project_Resource_Assignment

  • Submit_Project_Resource_Request

Revenue Management

  • Get_Customer_Invoice_Narrative_Templates

  • Put_Customer_Invoice_Document_Attachment

  • Put_Customer_Invoice_Narrative_Template

  • Submit_Full_Credit_Adjustment_for_Contract-Based_Customer_Invoice

Scheduling

  • Get_Maintain_Scheduling_Settings_Template

  • Put_Maintain_Scheduling_Settings_Template

Staffing

  • Correct_Organization_Assignments

Student Records

  • Submit_Academic_Period_Record_Override_for_Registration

Talent

  • Get_Company-Defined_Career_Paths

  • Put_Company-Defined_Career_Path

Time Tracking

  • Put_Time_Attendance_Points

Removed Workday Operations

Workday API v47.0 removes these operation choices. The Financial Management and Compensation connector components remain available.

Search your application XML, deployment properties, and shared configuration for the removed names. Also review operation names selected dynamically through expressions. Flows using these removed choices can’t resolve or invoke them after upgrading.

Service Removed Operation Migration

Financial Management

Get_Receivables_Overpayment_Reasons

Use Get_Receivables_Reasons. Review filtering because the replacement also returns on-account, write-off, collection, and dispute reasons.

Financial Management

Put_Receivables_Overpayment_Reason

Use Put_Receivables_Reason. Update request and response mappings to use the Receivables_Reason_* structures and provide Receivables_Reason_Type_Reference as required by the v47 schema.

Compensation

Retrieve_Severance_Worksheet

No confirmed equivalent replacement exists. Consult your Workday administrator or Workday support before redesigning the integration.

For example, change the Operation field on Financial Management:

<!-- Before: removed from Workday API v47.0 -->
<workday:financial-management config-ref="Workday_Config"
    operation="Get_Receivables_Overpayment_Reasons" />

<!-- After: review the request and response mappings against v47 metadata -->
<workday:financial-management config-ref="Workday_Config"
    operation="Get_Receivables_Reasons" />

Use your application’s existing configuration reference and regenerate metadata for the replacement operation. An operation-name change alone isn’t sufficient for Put_Receivables_Reason.

Create_Severance_Worksheet starts a business process. It doesn’t retrieve an existing worksheet and isn’t an equivalent replacement for Retrieve_Severance_Worksheet.

Workday-Deprecated Operations

These operation choices remain available in v47.0, but Workday marks them as deprecated. These deprecations also exist in the packaged v46.0 contracts and aren’t new removals in connector 17.0. Avoid them for new integrations when a supported alternative is available, and plan replacements before a future Workday API version removes them.

Service Component Deprecated API Operations

Benefits Administration

  • Get_Employee_Defined_Contribution_Elections

  • Put_Dependent

  • Put_Employee_Defined_Contribution_Elections

Financial Aid

  • Put_COD_Attendance_Dates

Financial Management

  • Get_Company_Ownership_Details

  • Put_Company_Ownership_Detail

Human Resources

  • Find_Business_Site

  • Get_Business_Site

  • Put_Dependent

  • Update_Contingent_Worker_Personal_Info

  • Update_Employee_Personal_Info

Payroll Interface

  • Put_Batch

Professional Services Automation

  • Add_Update_Expense_Report

Resource Management

  • Get_PO_for_PO_Issue_Outbound

  • Get_Supplier_Order_Contracts

  • Put_Card_Holder_Listing_File

  • Put_Expense_Credit_Card

  • Put_Expense_Credit_Card_Transaction

  • Put_Expense_Credit_Card_Transaction_File

  • Put_Supplier

  • Submit_Supplier_Order_Contract

Revenue Management

  • Get_Customer_Refunds

  • Submit_Customer_Refund

Staffing

  • Assign_Organization_Roles

  • Put_Dependent

Student Records

  • Get_Course_Offering_Sets

Workforce Planning

  • Get_Headcount_Plan_Structures__Do_Not_Use_

  • Get_Headcount_Plan_Templates__Do_Not_Use_

  • Maintain_Headcount_Plan

  • Put_Headcount_Plan_Structure__Do_Not_Use_

  • Put_Headcount_Plan_Template__Do_Not_Use_

Don’t select Workforce Planning operation choices containing _Do_Not_Use for new development. Existing integrations should be reviewed with your Workday administrator for a supported replacement.

The packaged Interview_Feedback__Do_Not_Use_ WSDL isn’t exposed as a connector service and isn’t a new service in 17.0. Use Recruiting for Get_Interview_Feedbacks and Put_Interview_Feedback, as directed by Workday.

For API details and retirement notices, see the Workday v47.0 service directory.

Configuration Migration

Replace the old timeout unit attributes wherever they’re configured. For example:

<workday:config name="Workday_Config"
    responseTimeout="60" responseTimeoutTimeUnit="SECONDS">
    <workday:basic-authentication-api-connection
        hostName="${workday.host}" tenantName="${workday.tenant}"
        userName="${workday.username}" password="${workday.password}"
        connectionTimeout="30" connectionTimeoutTimeUnit="SECONDS"
        connectionIdleTimeout="30" connectionIdleTimeoutTimeUnit="SECONDS" />
</workday:config>

Don’t rename timeUnit on a scheduling strategy. Timeout duration values and Studio display labels are unchanged.

For X.509 connections, replace signatureAlgorithm="RSA_SHA1" with signatureAlgorithm="RSA_SHA256" and verify that the tenant accepts the signed request. Test custom SOAP headers because they’re now included in the signature.

Update custom code that imports SoapAttributes, C14nAlgorithm, DigestAlgorithm, KeyStoreType, or SignatureAlgorithm from their previous packages. Replace mutation of SoapAttributes with construction of a new attributes object.

Polling Migration

With Watermark Enabled set to true, the source resumes at its stored polling-window end after a restart, even if Updated From is configured. Without Updated From or a stored watermark, polling starts 15 seconds before source startup.

To replay records, stop the source, back up and clear its object store, and set Updated From to the required earlier time before restarting. Disabling watermarks ignores the stored watermark, but also disables recovery of records beyond maxItemsPerPoll.

Updated From accepts a date and time with seconds and an optional fraction of up to nine digits, such as 2026-11-06T09:00:00 or 2026-11-06T09:00:00.123. Don’t include an offset. The configuration’s Time Zone supplies the offset.

Review these considerations:

  • maxItemsPerPoll limits emitted records, not the number of HTTP requests or records fetched.

  • With watermarks enabled, a limit-hit window is fetched again with the same bounds on subsequent polls, and Mule filters already emitted records.

  • A restart during that repeated window can resume at the stored window end and skip records that weren’t emitted. Don’t rely on this behavior for exactly-once delivery across restarts.

  • A stored 16.x emission-time watermark can be later than the previous polling-window end. If recovery is required, clear the store and choose an earlier Updated From value. Make downstream processing tolerate duplicates when replaying.

Upgrade Steps

  1. In Studio, open the existing Mule project.

  2. In the Mule Palette view, click Search in Exchange.

  3. In Add Dependencies to Project, search for Workday.

  4. Select Workday Connector - Mule 4, click Add, and click Finish.

  5. Verify that the com.mulesoft.connectors:mule-workday-connector dependency in pom.xml uses version 17.0.0.

  6. Apply the configuration, operation, mapping, error-handling, and source changes described in this guide.

Verify the Upgrade

  1. Verify that Studio shows no errors in the Problems or Console views and that pom.xml resolves successfully.

  2. Test each connection type used by your app, including TLS and proxy configurations.

  3. Refresh v47 metadata and test request and response mappings for migrated operations with representative data.

  4. Test authentication faults, insufficient privileges, invalid IDs, connectivity failures, and timeouts. A timeout doesn’t trigger reconnection retries because Workday might already have applied the request.

  5. Test source startup, restart, watermark recovery, and limit-hit polling windows. Check downstream duplicate handling during replay.

  6. Validate the upgraded application in a non-production Workday tenant before production deployment.

Troubleshooting

If metadata isn’t refreshed after upgrading, restart Studio and regenerate the operation metadata. If a removed Workday operation can’t be resolved, update its Operation value and mappings as described in Removed Workday Operations.

For startup validation, authentication, and timeout errors, see Troubleshooting Workday Connector.

Revert the Upgrade

To revert, restore the backed-up application and its previous mule-workday-connector version, such as 16.7.1, in pom.xml.

Restore the previous timeout XML attributes, X.509 settings, Workday operation choices, mappings, custom Java imports, and source configuration. Review source state before restarting because 17.x watermarks represent polling-window ends, not 16.x emission times.

See Also

Back to top