In this article
Overview
You can use Workday Cancel Snap to cancel the objects in Workday, based on the field values in the input document that match the Workday object schema field names. These field names are defined by the Workday Web Service Definition Language (WSDL). The fields that match the object to be canceled are provided on the input view of the Snap and can be mapped using an upstream Mapper Snap.
Learn more about Workday Web Services (WWS) Directory for information on the Workday objects.
Snap Type
Workday Cancel Snap is a Write-type Snap that cancels the Workday objects that have been created.
ETL Transformations & Data Flow
This Snap enables the following ETL operations/flows:
Transform SnapLogic input document data to Workday SOAP XML request
Loads the update data into Workday and provide the respective data which has being written, in the output view as JSON format
This Snap creates a SOAP request based upon the Workday Cancel object input schema and the input data passed into the snap. The Snap then submits the SOAP request to Workday and deletes the respective object in Workday and and converts the Workday SOAP XML response to JSON in the output view.
The Snap collects the Workday service and object input for the Workday server to process with the expected upstream information.
Field can be mapped using an upstream Mapper Snap which will allow the mapping of fields or values to the field that are available on the selected service object.The Snap transforms the input document data matching the Workday input schema to create and submit a SOAP request.
On successful Workday server response, the Snap displays one output document for every record updated, hence any document processing Snap can be used down stream.
The Snap converts the returned SOAP XML response into JSON for the output view.
If there is an exception, the Snap writes an error to the output view.
Prerequisites
Workday Account, data to query, and Workday security access to the objects that you want to cancel. Contact your organization's Workday Security Administrator for appropriate access.
Workday recommends using an Integration System User (ISU) with APIs.
Support for Ultra Pipelines
Works in Ultra Task Pipelines.
Limitations and Known Issues
None.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
Input | Document |
|
| A document that conforms to the input view schema of the Snap. The input view schema is provided to an upstream Mapper Snap based on the selected service object. |
Output | Document |
|
| A document that represents the record structure of the retrieved Workday service object. Each record is represented as one document on the output view. |
Error | Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:
Learn more about Error handling in Pipelines. | |||
Snap Settings
Asterisk (*): Indicates a mandatory field.
Suggestion icon (
): Indicates a list that is dynamically populated based on the configuration.Expression icon (
): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.Add icon (
): Indicates that you can add fields in the field set.Remove icon (
): Indicates that you can remove fields from the field set.
Field Name | Field Type | Description |
|---|---|---|
Label* Default Value: Workday Cancel | String | Specify a unique name for the Snap. |
Timeout* Default Value: 60 | Integer | Specify the timeout value for each Workday SOAP request. The value of 0 indicates no timeout. As the Workday Cancel supports Workday SOAP pagination, multiple SOAP requests can occur for one execution. Consequently, the timeout can be less than the time it takes to complete writing documents to the output view. |
Service* Default value: [None] | String/Expression/Suggestion | Specify the name of the web service that you want to use for cancelling the objects. Though all available services are selectable, only Resource_Management, Revenue_Management, Financial_Management, Integrations, Cash_Management may have objects that provide cancellations. |
Object* Default value: [None] | String/Expression/Suggestion | Specify the object to write. The objects are suggested based on the selected service, such as selecting the service Payroll will retrieve all objects for Payroll that are retrievable from Workday. |
Number of Retries Default Value: 0 | Integer | Specify the number of attempts the Snap should make, in case of connection failure or timeout. |
Retry Interval (seconds) Default Value: 1 | Integer | Specify the time interval in seconds between the retry attempts. |
Snap Execution Default Value: Execute only | Dropdown list | Select one of the three modes in which the Snap executes. Available options are:
|
Troubleshooting
Error | Reason | Resolution |
|---|---|---|
HTTP/1.1 407 Proxy Authentication required. | The Snap is unable to tunnel through proxy. | Add the following key-value pair values to your Groundplex configuration and restart the plex to reflect the changes. Key: |
Examples
Canceling an Invoice Using the Revenue Management Service
This example Pipeline demonstrates how to cancel an invoice using the Revenue_Manangement service..
This Pipeline does not work for any Workday tenant since they are read by WID.
For each expression field, you must provide a corresponding Workday ID (WID). You can get the WID using the Workday Read Snap.
First, configure the Mapper Snap to map the customer invoice type and its value. Next, configure the Workday Cancel Snap to use the Revenue_Management service with the Cancel_Customer_Invoice object.
In the output preview, you can see the customer invoice reference ID that is canceled.
Handling an Error After an Attempted Cancellation
The second example showcases error handling. Invoice cancelation can only happen once per invoice. This example shows an error when we try to cancel an object that was already canceled.
Download the example Pipeline.
This Pipeline does not work for any Workday tenant since they read by WID
The mapping and the Workday Cancel Snap are configured as in the first example, except that you need to add an Error View to the Workday Cancel Snap.
The error view shows the following:
The error key provides the message returned from Workday ‘Invoice is not cancelable’.
The envelope key contains the information of the SOAP envelope that is populated by applying the variables from the input view into the generated SOAP envelope.
The stripped envelope key contains the information of the SOAP envelope that is sent to Workday
Downloads
Download and import the Pipeline into SnapLogic.
Configure Snap accounts as applicable.
Provide Pipeline parameters as applicable.
Snap Pack History
Release Snap Pack Version Date Type Updates February 2024 436patches25953 Latest Upgraded Apache CXF from version 3.4.2 to 3.6.3 to prevent vulnerability issues. February 2024 main25112 Stable Updated and certified against the current SnapLogic Platform release. November 2023 435patches24944 Latest Fixed an issue with Workday REST Snap where the input schema of the Snap did not populate in the upstream Mapper Snap. November 2023 435patches24309 Latest Added the WorkdayQL Snap in the Workday Snap Pack, which connects with the Workday Query Language (WQL) endpoints. November 2023 main23721 08 Nov 2023 Stable Updated and certified against the current SnapLogic Platform release. August 2023 main22460 Stable Updated and certified against the current SnapLogic Platform release. May 2023 main21015 Stable Upgraded with the latest SnapLogic platform release. February 2023 432patches20313 Latest Fixed an issue with the Workday REST Snap where it failed with a null pointer exception when the input document was null. February 2023 main19844 Stable The Workday REST Snap supports Pass through and Pagination fields. Pass through: Enables the Snap to pass the input data to the output document. Enable Pagination: Enables the Snap to return the response in multiple pages based on the limit and offset query parameters. The maximum limit value is 100. Deselect this checkbox to download only one page of records. January 2023 431patches19450 Latest Introduced the Workday REST Snap to connect to Workday REST APIs. This Snap supports the following new accounts: November 2022 main18944 Stable Upgraded with the latest SnapLogic platform release. October 2022 430patches18358 Latest The Workday Read, Workday Write, and Workday Cancel Snaps are now showing the Services in the suggestions list using the Public Web Service API, which the Snaps failed to use previously. August 2022 430patches17587 Latest The performance of the Workday Read Snap is improved to reduce the execution time. August 2022 main17386 Stable Upgraded with the latest SnapLogic platform release. 4.29 main15993 Stable Added support for the latest version of Workday APIs (certified to be compatible with version 37.0). 4.28 Patch 428patches14290 Latest Enhanced the Workday Cancel Snap with the retry mechanism fields. Number of Retries: Specifies the number of attempts the Snap should make to perform the selected operation in case of connection failure or timeout. Retry Interval (seconds): The time interval in seconds between retry attempts. 4.28 main14627 Stable Enhanced the Workday Read Snap with the following: Added the Pass-through on no lookup match checkbox that allows the input document to pass through to the output view when there are when no records match an input document. Parameterization of the Page Number and Page Size fields using Pipeline parameters. You can define and use the parameters in these fields using the 4.27 main12833 Stable Enhanced the Workday Read Snap with the new field Pool Size that controls the maximum number of threads in the pool. This field is available only when you select the Multi-threaded checkbox. 4.26 Patch 426patches11525 Latest Enhanced the Workday Read Snap with the new field Pool Size that controls the maximum number of threads in the pool. This field is available only when you select the Multi-threaded checkbox. 4.26 main11181 Stable Upgraded with the latest SnapLogic platform release. 4.25 main9554 Stable Upgraded with the latest SnapLogic platform release. 4.24 main8556 Stable Upgraded with the latest SnapLogic platform release. 4.23 main7430 Stable Upgraded with the latest SnapLogic platform release. 4.22 main6403 Stable Removes support for Workday WSDL Account. Pipelines. You must switch these Snaps using either the Workday Account or Workday Dynamic Account type. 4.21 snapsmrc542 Stable Upgraded with the latest SnapLogic platform release. 4.20 Patch workday8817 Latest Fixes the Workday Write Snap that ignores the Import Synchronized checkbox selection when importing object data. The Snap now: Waits for the current import request to complete, whether successfully or with error, before initiating the next import request. Provides accurate real-time status of the request to downstream Snaps. Existing Pipelines using this Snap to might experience longer exercution times because of 4.20 Patch workday8761 Latest Fixes the Workday Read Snap that fails to validate when configured in the New Form UI. 4.20 snapsmrc535 Stable Upgraded with the latest SnapLogic platform release. 4.19 snaprsmrc528 Stable The Workday Write Snap includes a Validate Only Load checkbox, which enables users to upload–and then manually validate–data before importing it into Workday. 4.18 Patch workday7837 Latest Fixed an issue with the Workday Read Snap wherein the Snap is unable to log SOAP calls. 4.18 snapsmrc523 Stable Upgraded with the latest SnapLogic platform release. 4.17 ALL7402 Latest Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers. 4.17 snapsmrc515 Latest Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview checkbox. 4.16 Patch workday6973 Latest Fixed an issue with paging variable toggle in Workday Read Snap to produce correct preview data. 4.16 Patch workday6862 Latest Fixed an issue with the Workday Read Snap not logging SOAP calls. 4.16 snapsmrc508 Stable Upgraded with the latest SnapLogic platform release. 4.15 Patch workday6727 Latest Fixed an issue with the Soap Execute Snap failing for Workday when the Trust All certificate is enabled while using SSL authentication. 4.15 Patch workday6292 Latest Fixed an issue with the Workday Read Snap giving inconsistent results. Reverting the multithreading update resolved the issue. 4.15 snapsmrc500 Stable Upgraded with the latest SnapLogic platform release. 4.14 snapsmrc490 Stable Upgraded with the latest SnapLogic platform release. 4.13 Patch workday5247 Latest Fixed the Workday Read Snap that took an extended time to read from the Workday application. 4.13 snapsmrc486 Stable Upgraded with the latest SnapLogic platform release. 4.12 snapsmrc480 Stable Upgraded with the latest SnapLogic platform release. 4.11 snapsmrc465 Stable Upgraded with the latest SnapLogic platform release. 4.10 snapsmrc414 Stable Upgraded with the latest SnapLogic platform release. 4.9 snapsmrc405 Stable Updated the Snap with Import Synchronized, Import Batch Size and Import Batch Node to enhance the performance for Import objects supporting bulk operations. Updated the Workday Read Snap with the Page Number and the Page Size properties. 4.8 snapsmrc398 Stable Updated the Read Snap with the Simplified output property. Info tab added to accounts. 4.7 snapsmrc382 Stable Upgraded with the latest SnapLogic platform release. 4.6 snapsmrc362 Stable Resolved an issue in Workday Read Snap that caused errors when the timeout field was set. Resolved an issue in Snaps with Workday Dynamic account that caused an error when a pipeline parameter provided an empty value to the password field. 4.5.1 snapsmrc344 Stable Resolved issues in Workday Snaps to ensure appropriate errors are routed to the error views. 4.4.1 Stable Upgraded with the latest SnapLogic Platform release. 4.4 Stable Resolved an exception in Workday Read. 4.3.2 Stable Addressed the following issues: Defect: Workday Read Input Using As Of Date/Time in Response_Filter Defect: Workday Snap Does Not Show All Services
Expression Enabler :Expression_Enabled: icon to pass values during runtime.
the synchronous behavior. However, you no longer need to use an additional Snap to capture and pass the request status to downstream Snaps.