Workday Cancel

On this Page

Snap Type:Write
Description:

This Snap provides the ability to cancel the objects in Workday based on the input document field values that match the Workday object schema field names as defined by the Workday Web Service Definition Language (WSDL). The object becomes suggestible once the account is defined. The fields that can be set on the object are provided on the input view of the Snap and can be mapped using an upstream Mapper Snap.

Workday provides documentation for their objects at Workday Web Services Directory (you must have access to the Workday Community).

ETL Transformations & Data Flow

This Snap enables the following ETL operation/ flow:

  1. Transform SnapLogic input document data to Workday SOAP XML request
  2. 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 writes the respective object into Workday and and converts the Workday SOAP XML response to JSON in the output view.

  1. 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.
  2. The Snap transforms the input document data matching the Workday input schema to create and submit a SOAP request.
  3. On successful Workday server response, the Snap will output one document for every record updated, hence any document processing Snap can be used down stream.
  4. The Snap converts the returned SOAP XML response into JSON for the output view.
  5. If there is an exception, the Snap writes an error to the output view.

Input & Output

  • InputDocument 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 which represents the record structure of the retrieved Workday service object. Each record is represented as one document on the output view
  • Expected upstream Snaps: 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. 
  • Expected downstream Snaps: The Snap will output one document for every record written, hence any document processing Snap can be used down stream. 
Prerequisites:

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. 

Limitations and Known issues:

Works in Ultra Task Pipelines.

Configurations:

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

InputThis Snap has exactly one document input view.
OutputThis Snap has exactly one document output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.

Settings

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.

Timeout

Defines the timeout value for each Workday SOAP request. A value of 0 means no timeout. 
Example: 0

Default value: 60

Service


The service to be used. Though all available services are selectable, only Resource_Management, Revenue_Management, Financial_Management, Integrations, Cash_Management may have objects that provide cancellations.

Example: Revenue_Management

Object


Required. The object to write. The field is suggestible once the account is defined. The objects will be 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]

Snap Execution

Select one of the three modes in which the Snap executes. Available options are:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.
  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.

Troubleshooting

ErrorReasonResolution
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: jcc.jvm_options
Value: -Djdk.http.auth.tunneling.disabledSchemes=""

Examples


Following are two examples: the first one to write an object successfully, the second one to handle an error after an attempted write.

 Cancel an Invoice using the Revenue_Management service.

In the first example we will cancel an Invoice using the Revenue_Management service.

Download example pipeline. Note that this pipeline does not work for any Workday tenant since they read by WID.

We will start with a Mapper Snap where we map the customer invoice type and its value (see above). The Workday Cancel Snap was configured 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.

 Handle an error after an attempted cancellation

The second example will showcase error handling. Invoice cancelation can only happen once per invoice, here we catch that error in the error view. 

Download the example pipeline.

Note that 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, with one difference: adding an error view to the Workday Cancel Snap.

The error view will show the following:


  • The error key will provide the message returned from Workday. In this case mentioning that the Invoice is not cancelable.
  • 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.


 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

  File Modified

ZIP Archive WD - Write - Error_2014_09_30_slp.zip

Aug 10, 2018 by Rakesh Chaudhary

ZIP Archive WD - Delete - Error_2014_09_30_slp.zip

Aug 10, 2018 by Rakesh Chaudhary

ZIP Archive WD - Delete - Example_2014_09_30_slp.zip

Aug 10, 2018 by Rakesh Chaudhary

Snap Pack History

 Click to view/expand
Release Snap Pack VersionDateType  Updates
4.27main12833StableEnhanced 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.26426patches11525 LatestEnhanced 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.26main11181 StableUpgraded with the latest SnapLogic Platform release.
4.25main9554
 
StableUpgraded with the latest SnapLogic Platform release.
4.24main8556
StableUpgraded with the latest SnapLogic Platform release.
4.23main7430
 
StableUpgraded with the latest SnapLogic Platform release.
4.22main6403
 
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.21snapsmrc542

 

StableUpgraded with the latest SnapLogic Platform release.
4.20 Patch workday8817 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 Latest

Fixes the Workday Read Snap that fails to validate when configured in the New Form UI.  

4.20snapsmrc535
 
StableUpgraded with the latest SnapLogic Platform release.
4.19snaprsmrc528
 
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 Latest

Fixed an issue with the Workday Read Snap wherein the Snap is unable to log SOAP calls.

4.18snapsmrc523
 
StableUpgraded with the latest SnapLogic Platform release.
4.17ALL7402
 
Latest

Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17snapsmrc515
 
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 Latest

Fixed an issue with paging variable toggle in Workday Read Snap to produce correct preview data.

4.16 Patch workday6862

 

LatestFixed an issue with the Workday Read Snap not logging SOAP calls.
4.16snapsmrc508
 
StableUpgraded with the latest SnapLogic Platform release.
4.15 Patchworkday6727 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 Patchworkday6292 Latest

Fixed an issue with the Workday Read Snap giving inconsistent results. Reverting the multithreading update resolved the issue. 

4.15snapsmrc500
 
StableUpgraded with the latest SnapLogic Platform release.
4.14snapsmrc490
 
StableUpgraded 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

 
StableUpgraded with the latest SnapLogic Platform release.
4.12

snapsmrc480

 
StableUpgraded with the latest SnapLogic Platform release.
4.11snapsmrc465
 
StableUpgraded with the latest SnapLogic Platform release.
4.10

snapsmrc414

 
StableUpgraded with the latest SnapLogic Platform release.
4.9snapsmrc405
 
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

 
StableUpgraded with the latest SnapLogic Platform release.
4.6snapsmrc362
 
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
 StableUpgraded 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