Versions Compared

Old Version 54

changes.mady.by.user Shilpa

Saved on

compared with

New Version Current

changes.mady.by.user Gouri Bhagchandani

Saved on

Key

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

On In this Pagearticle

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

Overview

Workday Write Snap

type:WriteDescription:This Snap provides the ability

is a Write-type Snap that you can use 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). 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 https://community.workday.com/custom/developer/API/index.html 

Learn more about Workday objects: Workday (SOAP), and Workday ( REST)

Image Added

Info

ETL Transformations & Data Flow

This Snap enables the following ETL operations/flows:

  1. Transform SnapLogic input document data to Workday SOAP XML request
  2. Load data into Workday

This Snap creates a SOAP request based upon 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 the user account information, the Workday service, 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 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.

Input & Output

Input: The document conforms to the input view schema of the Snap. The input
  1. view
schema is provided to an upstream Mapper Snap based on the selected service object. 
Output: The document represents the record structure of the retrieved Workday service object
  1. .
Each record is represented as one document on the output view

Prerequisites

:

  • You must have a Workday Account, data to query, and Workday security access to the objects.

Please contact
  • Contact your organization's Workday Security Administrator for proper access.
  • Workday recommends using an Integration System User (Most commonly known as ISU) for use with APIs. 

Support and limitations

:

Works in Ultra

Task Pipelines.Account:

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. The Workday account credentials in the Workday Account must have Workday write security access to the Workday objects defined for the Workday Write snap configuration. Workday security is done inside of Workday, please see your Workday security documentation on how to configure, or work with the Workday security administrator to gain this access if access is initially restricted.

Views:
InputThis Snap has exactly one input view.
OutputThis Snap has exactly one output view.
ErrorThis Snap has at most one error view and produces zero or more documents in the view.
TroubleshootingEnsure 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.

Settings

Label

Required. 

Tasks.

Snap Views

TypeFormatNumber of ViewsExamples of Upstream and Downstream SnapsDescription
InputDocument
Min: 1
Max: 1
  • JSON Generator
  • Mapper
The document 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. 
OutputDocument
Min: 1
Max: 1
  • Mapper
  • File Reader
Each record is represented as one document on the output view. The 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.

Settings

Info

  • 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.


only retries  intervals page
FieldDescription

Label*

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 pipelinePipeline.

Timeout

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

Default ValueDefault value: 60: 60
Example: 0

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.

Default Value: [None]
Example: Revenue_ManagementDefault value: [None]

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.

Default Value: [None]
Example: Human_Resources-Get_Job_ProfilesDefault value: [None] Put_Alternate_Customer_Contract

Import Synchronized

Select this check box 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 valueValue: Not selected

Validate Only Load

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.

Note

Select this check box only when working with import objects.

Default valueValue: Not selected

Import Batch size

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 valueValue: 1
Example: 5

Import Batch Node path

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.

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

Default value: [None]Value: N/A

Number of Retries 

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.

Example: 3

Minimum value: 0

Default valueValue: 0
Example: 3

Retry Intervals (seconds)name

Enter the time interval in seconds between retry attempts.Example: 3

Minimum value: 1

Default valueValue: 1

Multiexcerpt include macro

Example: 3

Snap Execution

SOAP Execute


Multiexcerpt include macro
nameExecution_Detail_Write
pageSOAP Execute

Troubleshooting

Multiexcerpt include macro
nameWorkday_Troubleshooting
pageWorkday Cancel

Basic Use Cases

The below examples display

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.

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=""

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.
  Image Added

With Expression
  • Pipeline Parameters
    In the below pipeline, the Workday Write Snap uses the values as set in the pipeline parameters.
    Image Added
Image Added
  • With specific Parameters in Settings
    In the below pipeline, the Workday Write Snap uses the values you provide in Settings in quotes. 
    Image Added


Examples

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

Note

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


Expand
titleWorkday Write Snap to support import objects

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:

View file
nameOracle_Select_Workday_read_write with 1 million records.slp
height250
View file
nameNew_Example_Workday write with 1 million records_Advance_Use_cases.slp
height250

Expand
titleWrite an Object successfully

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 is shown below, returning the ID of the position that was created.


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.

  Image Removed

  • With Expression
    • Pipeline Parameters

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

Image Removed

Image Removed

Advanced Use Case

The following describes

ETL transformations with Workday

The following examples describe a pipeline, with a broader business logic involving multiple ETL transformations. Pipeline Attachments links are provided in the Downloads links in the bottom section.transformations using the Workday Write Snap. 

This pipeline reads the documents from the Oracle Database, writes the required documents to the Workday instance, and then reads them. 

Image Removed

Image Added

The ETL transformations

Extract: The Oracle Select Snap retrieves the documents from the Oracle Database.

Transform: The Head Snap is set to retrieve one document to be passed to the Workday instance.

Load: The Mapper Snap maps the input document to the target schema from the Workday service

Load: The Workday Write Snap writes the document to the specified Object on the service.

Read: The Workday Read Snap reads the inserted document on the Workday Object.

Image Removed

Image Added

Another

Advance use case

example where the documents are created and migrated from

the Microsoft CRM

Dynamics 365 for Sales instance to the Workday Write instance.

Image Removed

 Image Added

Image Removed

Downloads

Attachments
patterns*slp, *zip
   

Snap Pack History

Jun 19, 2018 

Release 

Snap Pack Version

Date

Type

  Updates

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 Enabler Image Removed  icon 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

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

    • Defect: Workday Snap Does Not Show All Services

    The ETL transformations

    Extract: The Mapper Snap provides information about the invoice for the Dynamics 365 for Sales Create Snap to create the invoice.

    Transform: The Dynamics 365 for Sales Create Snap creates invoice and the Dynamics 365 for Sales Read Snap reads the new invoice ID. 

    Load: With the customer invoice as the object name, information is loaded into the Workday Write Snap.

    Image Added



    Downloads

    Attachments
    patterns*slp, *zip
       


    Snap Pack History

    Insert excerpt
    Workday Snap Pack
    Workday Snap Pack
    nopaneltrue

    Related Content