Versions Compared

Old Version 70

changes.mady.by.user Leena Gopal

Saved on

compared with

New Version 71

changes.mady.by.user Leena Gopal

Saved on

Key

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

In this article

...

Info

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.

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

Note
  • 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:

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

Here's how it works:

  1. 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
  2. The Snap evaluates any defined property expressions and then creates and submits a SOAP request with authentication.
  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 or error, the Snap performs the task specified for error management.

...

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

The Outputs fieldset limits the kind and amount of information returned by your query. Excluding unnecessary fields increases Snap throughput and simplifies downstream Snap pipeline development.

See For more information refer to, Workday Web Services Directory for additional information on the Workday Web Services API.


PathString/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

ValueDropdown 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 further 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 NumberInteger/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 SizeInteger/Expression

Specify the number of records to fetch per page.

Default Value: 100
Example:100

Info

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-threadedCheckbox

Select this checkbox to enable the Snap to expedite reading the requests by using multiple threads.

Note

This feature may yield inconsistent results.


Max Pool SizeInteger

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
Multiexcerpt include macro
nameSnap_Execution_Introduced
pageAnaplan Read

...

Note

You can also use Pipeline parameters to specify short strings for complicated service and objects in Workday. For step-by-step information on managing properties of Pipelines, see refer to Pipeline Properties Parameters.

...

This Pipeline retrieves a list of workers, with detailed documents accompanying each worker. We shall see what the output looks like without the Simplified view restriction , and then generate a Simplified view of the output using the Workday Read Snap.

...

Expand
titleUnderstanding the Pipeline

This Pipeline is structured as follows:

  • Mapper Snap: Passes the Transaction Log criteria to the Workday Read Snap.
  • Workday Read Snap: Retrieves data matching the criteria.

To use the Transaction Logs service in the Workday Read Snap, you must first pass the following Transaction Log criteria into the Workday Read Snap:

  • Date range
  • Modified entity's name
  • Modified entity's value

The above criteria is passed through the Mapper Snap, which is configured as shown below:

The output from the Mapper Snap is as shown below:

To use a Workday service, the Workday Read Snap's Output field must be configured to set the service to True:

The output from the Workday Read Snap is as shown below:

Below is a screenshot of the Workday Read Snap without using the Transaction Log service:

Comparing both outputs, you can see that using the Transaction Logs service is much more efficient.


Download this Pipeline.

...