...
In this article
| Table of Contents | ||||
|---|---|---|---|---|
|
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.
| Info |
|---|
ETL Transformations & Data Flow This Snap enables the following ETL |
...
operations/ |
...
flows:
|
...
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.
|
...
|
...
|
Prerequisites
Workday Account, data to query, and Workday security access to the objects that you want to cancel.
...
Input & Output
...
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 |
...
You must have a Workday Account, data to query, and Workday security access to the objects.
Please contact your organization's Workday Security Administrator for proper access.
Workday recommends to use an Integration System User (Most commonly known as ISU) for use with APIs.
...
Works in Ultra Task Pipelines.
...
Accounts and Access
This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring Workday Accounts for information on setting up this type of account.
Views
| Input | This Snap has exactly one document input view. |
|---|---|
| Output | This Snap has exactly one document output view. |
| Error | This Snap has at most one document error view and produces zero or more documents in the view. |
...
Settings
...
. | ||||
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
| Info |
|---|
|
Field Name | Field Type | Description |
|---|---|---|
Label* |
...
Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.
...
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 |
...
Default value: 60
Service
...
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] |
...
Object
...
Cancel_Customer_Invoice | 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. |
...
Example: Human_Resources-Get_Job_Profiles
Default value: [None]
...
| Multiexcerpt include macro | ||||
|---|---|---|---|---|
|
...
| Multiexcerpt include macro | ||||
|---|---|---|---|---|
|
Troubleshooting
...
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
Following are two examples: the first one to write an object successfully, the second one to handle an error after an attempted write.
...
| title | Cancel an Invoice using the Revenue_Management service. |
|---|
...
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.
The response is shown below, returning the ID of the position that was created.
...
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.
...
...
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
...
| title | Error Handling of the Snap |
|---|
The second example will showcase error handling, here we assume a bad mapping.
Download the example pipeline.
In the below mapping we assume we mapped an invalid type information. Usually when mapping an object, several attempts have to made to map the right fields so it is good to understand how bad mappings are handled.
The Workday Write Snap is configured as in the first example.
The invalid type mapping of "badID" to $Create_Position_Data.Supervisory_Organization_Reference.ID[*].value will trigger the Workday Write Snap to write to the error view (here we enabled the error view on the Snap explicitly).
The error view will show the following:
- The error key will provide the message returned from Workday. In this case mentioning that the badID value for the type field is invalid.
- The envelope key carries the information of the SOAP envelope that populated by applying the variables from the input view into the generated SOAP envelope.
- The stripped envelope key carries the information of the SOAP envelope that will be send to Workday
- The original key carries the document that came in on the input view.
Downloads
...
Downloads
| Info |
|---|
|
| Attachments | ||
|---|---|---|
|
Snap Pack History
...
...
...
...
...
...
4.28
...
main14627
...
Feb 12, 2022
...
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 no records matching 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
Expression Enablericon to pass values during runtime.
...
4.27
...
main12833
...
Nov 13, 2021
...
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
...
426patches11525
...
Sep 6, 2021
...
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
...
Aug 14, 2021
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.25
...
main9554
...
May 8, 2021
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.24
...
main8556
...
Feb 13, 2021
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.23
...
main7430
...
Nov 14, 2020
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.22
...
main6403
...
Sep 12, 2020
...
Stable
...
Removes support for Workday WSDL Account. Pipelines and Snaps using this account type must switch to either Workday Account or Workday Dynamic Account.
...
4.21
...
snapsmrc542
...
May 9, 2020
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.20 Patch
...
workday8817
...
Apr 27, 2020
...
Latest
...
Fixes the Workday Write Snap that ignores the Import Synchronized check box selection while 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 may experience longer execution times due to the synchronous behavior. However, you no longer need to use an additional Snap to capture and pass on the request status to downstream Snaps.
...
4.20 Patch
...
workday8761
...
Mar 6, 2020
...
Latest
...
Fixes the Workday Read Snap that fails to validate when configured in the New Form UI.
...
4.20
...
snapsmrc535
...
Feb 8, 2020
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.19
...
snaprsmrc528
...
Nov 14, 2019
...
Stable
...
The Workday Write Snap includes a Validate Only Load check box, which enables users to upload–and then manually validate–data before importing it into Workday.
...
4.18 Patch
...
workday7837
...
Sep 11, 2019
...
Latest
...
Fixed an issue with the Workday Read Snap wherein the Snap is unable to log SOAP calls.
...
4.18
...
snapsmrc523
...
Aug 10, 2019
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.17
...
ALL7402
...
Jun 11, 2019
...
Latest
...
Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.
...
4.17
...
snapsmrc515
...
Jun 11, 2019
...
Latest
...
Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.
...
4.16 Patch
...
workday6973
...
Mar 20, 2019
...
Latest
...
Fixed an issue with paging variable toggle in Workday Read Snap to produce correct preview data.
...
4.16 Patch
...
workday6862
...
Feb 22, 2019
...
Latest
...
Fixed an issue with the Workday Read Snap not logging SOAP calls.
...
4.16
...
snapsmrc508
...
Feb 16, 2019
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.15 Patch
...
workday6727
...
Jan 28, 2019
...
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
...
Dec 13, 2018
...
Latest
...
Fixed an issue with the Workday Read Snap giving inconsistent results. Reverting the multithreading update resolved the issue.
...
4.15
...
snapsmrc500
...
Dec 15, 2018
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.14
...
snapsmrc490
...
Aug 11, 2018
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.13 Patch
...
workday5247
Jun 19, 2018
...
Latest
...
Fixed the Workday Read Snap that took an extended time to read from the Workday application.
...
4.13
...
snapsmrc486
...
May 12, 2018
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.12
...
snapsmrc480
...
Feb 17, 2018
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.11
...
snapsmrc465
...
Nov 11, 2017
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.10
...
snapsmrc414
...
Aug 12, 2017
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.9
...
snapsmrc405
...
May 13, 2017
...
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
...
Feb 11, 2017
...
Stable
...
Updated the Read Snap with the Simplified output property.
Info tab added to accounts.
...
4.7
...
snapsmrc382
...
Nov 23, 2016
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.6
...
snapsmrc362
...
Aug 13, 2016
...
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
...
May 18, 2016
...
Stable
...
Resolved issues in Workday Snaps to ensure appropriate errors are routed to the error views.
...
4.4.1
...
Mar 18, 2016
...
Stable
...
Upgraded with the latest SnapLogic Platform release.
...
4.4
...
Feb 13, 2016
...
Stable
...
Resolved an exception in Workday Read.
...
4.3.2
...
Jan 15, 2016
...
Stable
Addressed the following issues:
...
Defect: Workday Read Input Using As Of Date/Time in Response_Filter
...
| Multiexcerpt include macro | ||||
|---|---|---|---|---|
|