WorkdayQL
- Shilpa
- Kalpana Malladi
- Gouri Bhagchandani
- Subhajit Sengupta
In this article
Overview
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 data. WQL endpoints refer to the specific API endpoints that enable you to execute WQL queries against the Workday system programmatically.
Snap Type
The WorkdayQL Snap is a Read-type Snap that reads data from the WQL endpoints.
Prerequisites
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
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
Input | Document |
|
| The OpenAPI path, operation and query parameters of the endpoint. |
Output | Document |
|
| The data fetched from the WQL endpoint. |
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 when running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab:
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 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.
Upload icon ( ): Indicates that you can upload files.
Field Name | Field Type | Field dependency | Description | |
|---|---|---|---|---|
Label*
Default Value: WorkdayQL | 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 | 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 | String/Expression/Suggestion | None | Specify the operation to perform on the selected OpenAPI path or select from the suggestions list. The available options are:
| |
Query
Default value: N/A | String | Appears when you select /data in the OpenAPI Path. | Specify an encoded query string to filter the records.
| |
Limit Default value: N/A | Integer | 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 | 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 | String/Expression | Appears when you select /data in the OpenAPI Path. | Specify the name of the query parameter for retrieving assets. | |
Values Default Value: N/A | String | Appears when you select /data in the OpenAPI Path. | Specify the value for the query parameter for retrieving assets. | |
Number of Retries Minimum value: 0 Default Value: 0 | Integer | Specify 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: 1 | Integer | Specify the time interval in seconds between retry attempts. | ||
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. When you deselect this checkbox, the Snap limits the number of output documents to 100, with only one page of records. The maximum limit value of the page size is 100—the Snap fetches all records until the last page with 100 records on each page. | ||
Snap Execution Default Value: Execute only | Dropdown list | Select one of the following three modes in which the Snap executes:
| ||
Video
Watch the video to learn how to execute a query in the WorkdayQL Snap using the Workday REST OAuth2 Account.
Troubleshooting
Error | Reason | Resolution |
|---|---|---|
| The permissions are insufficient. | Ensure that you assign the required permissions and retry. |
"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.
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 |
|---|---|
|
|
Snap Pack History
Related Content
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.