Workday Cancel
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.
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.
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
Snap Pack History
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.