Overview

Workday Read Snap is a Read-type Snap that you can use to read Workday data using the Workday service name, object, and optionally output fields.

The output fields are the Include and Exclude fields typically defined by Workday in the request's Response_Group section. Output fields prefixed with include, add additional fields to the output document, whereas the output fields prefixed with exclude, excludes fields from the output document. Output fields prefixed with include add additional fields to the output document, whereas the output fields prefixed with exclude excludes fields from the output document.

For more information refer to, Workday Web Services (WWS) Directory for information on the Workday output section to specifically determine the nature and effect that each output field has on the output document.

You can configure this Snap to query data specific to your requirements. This is especially useful when looking for data modifications in specific objects, such as Name_Data, Birth_Date, etc. You can use Workday's Transaction Logs service to do so. Refer to this example to see how this works.
The Workday Read Snap automatically sends multiple SOAP pagination requests to provide the complete set of Workday objects with no additional coding effort.

ETL Transformations & Data Flow

This Snap enables the following ETL operations/flows:

Extract data from Workday
Transform Workday SOAP XML response(s) to JSON output

Here's how it works:

For the Snap to successfully receive data from Workday, you must provide at least the following information:
1. The user account information needed to log into Workday
2. The name of the Workday web service that must be used to access the data needed
3. The name of the object containing the required data, and
4. Output fields that the Workday server must use to populate the returned data
The Snap evaluates any defined property expressions and then creates and submits a SOAP request with authentication.
On successful Workday server response, the Snap converts the returned SOAP XML response into JSON for the output view.
If there is an exception or error, the Snap performs the task specified for error management.

Prerequisites

You must have a Workday Account, data to query, and Workday security access to the objects concerned. 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 Tasks if batch size is set to 1.

Limitations and Known Issues

None.

Snap Views

Type	Format	Number of Views	Examples of Upstream and Downstream Snaps	Description

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input

Document

Min:0
Max:1

Mapper
JSON Generator

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

Min:1
Max:1

File Reader
Mapper
JSON Formatter

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:

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 (
): 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

Field Name	Field Type	Description
Label*	String	Specify the name of the Snap. You can modify this text to indicate what the Snap does. This is especially useful if you have more than one Workday Read Snap in your Pipeline. Default Value: Workday Read Example: Get Cost Center List from Workday
Timeout*	Integer	Specify the timeout value for each Workday SOAP request. The value of 0 means no timeout. Because Workday Read 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. Default value: 60 Example: 0
Service*	String/Expression/Suggestion	Specify the name of the web service that you want to use. Default value: N/A Example: Staffing
Object*	String/Expression/Suggestion	Specify the name of the object from which you want to retrieve data. Select the object from the list of objects returned by the web service you selected in the Service field. For example, if you selected the Payroll Service, the Object field displays all the objects that were retrievable under the Payroll service from Workday. Default value: N/A Example: Get_Workers
Outputs	Use this field set to indicate the data you want the query to return from Workday. Add each output in a separate row. Click Add to add rows. This field set contains Path and Value fields. The Outputs field set limits the kind and amount of information returned by your query. Excluding unnecessary fields increases Snap throughput and simplifies downstream Snap pipeline development. For more information, refer to, Workday Web Services Directory for additional information on the Workday Web Services API.
Path	String/Suggestion	Specify the output to be returned by the request. These work with the include and exclude fields defined by Workday in the request's Response_Group section and include or exclude fields in the output document. For example, the command 'Response_Group.Include_Worker_Documents' includes worker document details in the output. Default Value: [None] Example: Include_Reference
Value	Dropdown list	Specify the value to be set for the path on the request. Default Value: True Example: False
Simplified Output	Checkbox	Select this checkbox to simplify output documents by removing Workday namespace attributes from key names. It also converts the nested ID collection to a simple map data. You can use a JSON Splitter Snap to simplify the output document data structure further. If not selected, the Snap produces an output in a tree structure with nested levels of information. Default Value: Not selected
Pass-through on no lookup match	Checkbox	Select this checkbox to allow the input document to pass through to the output view when there are no records matching an input document. Else, the input document is written to the error view as an error condition. Default Value: Not selected
Page Number	Integer/Expression	Enter the specific page number from which you want to retrieve data. Retain 0 to retrieve data from all the pages. Default Value: 0 Example: 2
Page Size	Integer/Expression	Specify the number of records to fetch per page. Default Value: 100 Example:100 This Snap submits a SOAP request to Workday with an output page size and converts the Workday SOAP XML response to JSON in the output view. If the Snap page setting is 0, and the Workday SOAP response indicates that more pages of data are available, it submits additional SOAP requests, collects all the pages of data, and transforms them into JSON.
Multi-threaded	Checkbox	Select this checkbox to enable the Snap to expedite reading the requests by using multiple threads. This feature may yield inconsistent results.
Max Pool Size	Integer	Activates when Multi-threaded* checkbox is selected.* Specify the value for pool size to control the maximum number of threads in the pool for the instance. Default Value: 10 Example: 5
Number of Retries	Integer	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 Interval (seconds)	Integer	Enter the time interval in seconds between retry attempts. Minimum value: 1 Default Value: 1 Example: 3
Snap Execution	Dropdown list	Select one of the following three modes in which the Snap executes: 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.