Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this Page

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

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]

Multiexcerpt include macro
nameSnap Execution
pageSOAP Execute

Multiexcerpt include macro
nameExecution_Detail_Write
pageSOAP Execute

Troubleshooting

Multiexcerpt macro
nameWorkday_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.

Expand
titleCancel 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.


Expand
titleHandle 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.



Expand
titleError 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

Attachments
uploadfalse
oldfalse
patterns*.slp, *.zip

Excerpt Include
Workday Snap Pack
Workday Snap Pack
nopaneltrue