Workday Write

Workday Write

In this article

Overview

You can use this Snap to write objects into 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).

workday-write-overview.png

This Snap creates a SOAP request based on the Workday Write object input schema and the input data passed into the Snap. The Snap then submits the SOAP request to Workday and converts the Workday SOAP XML response to JSON in the output view.

  1. The Snap collects user account information, Workday service information, and object input for the Workday server to process.

  2. The Snap transforms the input document data, matching the Workday input schema, to create and submit a SOAP request.

  3. On a successful Workday server response, the Snap converts the returned SOAP XML response into JSON for the output view.

  4. If there is an exception, the Snap writes an error to the output view.

Snap Type

The Workday Write is a Write type Snap.

Prerequisites

  • You must have a Workday Account, data to query, and Workday security access to the objects. Contact your organization's Workday Security Administrator for proper access.

  • Workday recommends using an Integration System User (commonly known as ISU) for use with APIs. 

Support and limitations

Works in Ultra Tasks.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input

Document

Min: 1

Max: 1

  • JSON Generator

  • Mapper

The fields that can be set on the object are provided in the input view of the Snap and can be mapped using an upstream Mapper Snap.  

Output

Document

Min: 1

Max: 1

  • Mapper

  • File Reader

The output document represents the record structure of the retrieved Workday service object. 

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:

  • Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the rest of the records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

  • Asterisk (*): Indicates a mandatory field.

  • Suggestion icon (:Suggestible_icon: ): Indicates a list that is dynamically populated based on the configuration.

  • Expression icon (: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 (:Add_Fieldset_Row: ): Indicates that you can add fields in the field set.

  • Remove icon (:Remove_icon:): Indicates that you can remove fields from the field set.

 

Field

Field Type

Description

Label*

String

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 Write
Example: Workday Write

Timeout

Integer

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

Default value: 60
Example: 0

Service

String/Expression

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.

Default Value: [None]
Example: Revenue_Management

Object*

String/Expression

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.

Default Value: [None]
ExamplePut_Alternate_Customer_Contract

Preserve empty input values

Checkbox

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.

Default Value: [None]
Example: Revenue_Management

Import Synchronized

Checkbox

Select this checkbox to use synchronous import. In a synchronized import, the current import request must complete before the next request can be initiated. In an asynchronous import, the next import request can be initiated immediately upon current request submission.     

Default Value: Not selected

Validate Only Load

Checkbox

Select this check box while working with import objects. This enables the Snap to upload processed data for validation without importing it into the endpoint. Once an authorized user review and validates the uploaded data, deselect this check box and execute the Pipeline to update the actual records in the endpoint.

Select this check box only when working with import objects.

Default Value: Not selected

Import Batch size

Integer

The number of documents to be batched together as a single request. This also requires "Import Batch Node path" property.(This is only for Import_ objects and doesn't affect other objects)

Default Value: 1
Example: 5

Import Batch Node path

Integer

The node path of the soap message under which the documents need to be batched. The suggested option accesses schema on its input view or through an upstream reference.

This is applicable to Import objects only and does not affect the other objects.

Default Value: N/A

Number of Retries 

Integer/Expression

Enter the integer value to specify the number of attempts the snap should make to perform the selected operation in case of connection failure or timeout.

Minimum value: 0

Default Value: 0
Example: 3

Retry Intervals (seconds)

Integer/Expression

Enter the time interval in seconds between retry attempts.

Minimum value: 1

Default Value: 1
Example: 3

Snap Execution

Dropdown list

Troubleshooting

Ensure that the capitalization of the keys in the input document matches the capitalization of the WSDL elements. If the upstream source does not use the same case for some reason, a Mapper can be used to handle the conversion as a workaround.

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

Typical Snap Configurations


The key configuration of the Snap lies in how the statements are passed to write the Workday objects. As it applies in SnapLogic, the statements can be passed in the following manner: 

Without Expression

In this pipeline, the Workday Write Snap writes the objects from a specified Object.
  

With Expression

  • Pipeline Parameters
    In the below pipeline, the Workday Write Snap uses the values as set in the pipeline parameters.

  • With specific Parameters in Settings
    In the below pipeline, the Workday Write Snap uses the values you provide in Settings in quotes. 



Examples


The examples below demonstrate how the Snap functions in a Pipeline:

You must have a Workday Account, and Workday writes security access to the objects in the following examples.

This pipeline shows how the Workday Write Snap supports the import objects.

In this pipeline, the Mapper Snap passes the values to be configured under various parameters for the Object, Import_Accounting_Journal.

The Workday Write Snap writes the data from the object, Import_Accounting_Journal. Note the Import Synchronized property is selected with an import batch size of 1. The import Batch node suggests the path under which the documents need to be batched under.

Successful execution of the pipeline displays the below output preview:

In the first example, we will create a Position using the Staffing service.

We will start with a Mapper Snap where we map the position details such as Availability_Date and Job_Posting_Title

The Workday Write Snap was configured to use the Staffing service with the Create_Position object.

The response returns the ID of the position that was created.