Versions Compared

Old Version 7

changes.mady.by.user Kalpana Malladi

Saved on

compared with

New Version 8

changes.mady.by.user Shilpa

Saved on

Key

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

...

You can use this Snap to connect with Workday Query Language (WQL) endpoints. WQL is a query language used in the Workday system for retrieving and manipulating data. WQL endpoints refer to the specific API endpoints that allow enable you to execute WQL queries against the Workday system programmatically. These endpoints enable you to interact with the Workday system, fetch data, and perform various operations.

...

Snap Type

The WorkdayQL Snap is a Read-type Snap that reads data from the WQL endpoints.

Prerequisites

None.

Support for Ultra Pipelines

...

Limitations

To make WQL API calls, you need:

  • Access to the Workday Query Language security domain.

  • To create an API client or repurpose an existing one.

Support for Ultra Pipelines

Works in Ultra Pipelines. 

Limitations

When you provide valid data in searchString for /datasources/{ID}/dataSourceFilters in the OpenAPI path field, the Snap does not provide output.

Known Issues

None.

Snap Views

...

Info

  • Asterisk ( * ): Indicates a mandatory field.

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

  • Expression icon ((blue star) ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.

  • Add icon ( (blue star) ): Indicates that you can add fields in the field set.

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

  • Upload icon ((blue star) ): Indicates that you can upload files.

NameNone.Content-type snap 0 0 3.

Minimum value: 1

Default Value: 1
Example: 3

Select this checkbox to enable the Snap to pass the input data to the downstream Snap and display in the output document limit and offset page.If the limit field is blank, the default limit value is 20 and the Snap displays only one of records. Available options are pipeline pipeline pipeline

Field Name

Field Type

Field dependency

Description

Label*

Default Value: WorkdayQL
Example: Workday QL Snap

String

None

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.

OpenAPI Path*

Default Value:N/A
Example: /workersdata

String/Expression/Suggestion

None

Enter the path for the REST endpoint. Based on the service and version, the Snap downloads the open API specification and populates the list.

Operation*

Default Value: N/A
Example: get

String/Expression/Suggestion

None

Specify the operation to perform on the selected OpenAPI path or select from the suggestions list. The available options are:

  • GET: Reads and retrieves content and data.

  • POST: Creates a new resource with a new ID.

  • PUT: Updates and replaces the existing resources.

  • PATCH: Updates and modifies the resources. PATCH operation only modifies the content of the resources and does not entirely replace the resources.

  • DELETE: Entirely deletes the resourcesReads and retrieves content and data for large query.

Query

Default value: N/A
Example: Get

String

Appears when you select /data in the OpenAPI Path.

Specify an encoded query string to filter the records.

Limit

Default value: N/A
Example: 10

Integer

Appears only when you select /data in OpenAPI Path and GET in Operation.

Appears only when you select /data in OpenAPI Path and GET in Operation. Specify the number of rows to return from the query.

Offset

Default value: N/A
Example: 5

Integer

Appears only when you select /data in OpenAPI Path and GET in Operation.

Specify the offset for the limit clause.

Query Parameters

You can use this fieldset to define the name and value for query parameters on request.

Parameters

Default Value:  

N/A
Example: 

alias

String/Expression

Appears when you select /data in the OpenAPI Path.

Enabled when /datasource is selected in the OpenAPI Path. Specify the name of the query parameter for retrieving assets.

Field 2Values

Default Value: None. N/A
Example: application/jsonStringcds_FTPUI

String

Appears when you select /data in the OpenAPI Path.

Specify the value for the query parameter for retrieving assets.

Number of Retries Retries

Minimum value: 0

Default Value: 0
Example: 3 

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.

Retry Interval (seconds)

Minimum value:

1

Default Value:

Retry Interval (seconds)

1
Example:

3 

Integer

Enter the time interval in seconds between retry attempts

Pass through

 

Default Value: Deselected

Checkbox

.

Enable Pagination

 

Default Value: Selected

Checkbox

Select this checkbox to enable the Snap to return the response in multiple pages when the input document contains the

query parameters.

  • The maximum limit value of the page size is 100 - that is, the Snap fetches all records until the last page with 100 records on each

  • page

  • .

When you deselect this checkbox, the Snap limits the number of output documents to 100, with only one page of records.

Snap Execution

Default Value: Execute only
Example: Validate & Execute

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.

Troubleshooting

Error

Reason

Resolution

403 Error: Unauthorized user.

The permissions are insufficient.

Ensure that you assign the required permissions and retry.

Code Block
"statusCode":
500
"statusPhrase":
"Internal Server Error"
"protoVersion":
"HTTP/1.1"

Offset is greater than or equal to total row size. When the offset value provided in the Snap is greater than number of the existing records, then the Snap fails.

Provide an offset value lesser than the number of records.

Examples

Get Worker from allWorkers

This example pipeline demonstrates how to get a worker from the list of allWorkers by executing the SELECT query. In this pipeline, you can see that the output of the WorkdayQL Snap retrieves the worker records from the allWorkers object and writes the data to a JSON file. 

  1. Configure the WorkdayQL Snap with get Operation and SELECT worker from allWorkers query. On validation, the Snap retrieves and generates the worker record ID from the allWorkers object.

Snap Configuration

Output

Image Added

Image Added

Snap Pack History

Expand
titleClick here to expand...

Insert excerpt
Workday Snap Pack
Workday Snap Pack
nameWorkday_SPH
nopaneltrue

...