Versions Compared

Old Version 5

changes.mady.by.user Shilpa

Saved on

compared with

New Version Current

changes.mady.by.user Kalpana Malladi

Saved on

Key

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

In this article

Table of Contents
minLevel1
maxLevel2
absoluteUrltrue

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

...

Support for Ultra Pipelines

Works in 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

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • Workday Read

  • Mapper

The OpenAPI path, operation and query parameters of the endpoint.

Output

Document

  • Min: 1

  • Max: 1

  • Workday Delete

  • Copy

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:

  • Stop Pipeline Execution: Stops the current Pipeline execution if the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining 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

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.

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

workers

data

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 resources

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

    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.

    Name

    Parameters

    Default Value:  

    None.

    N/A
    Example: 

    Content-type

    alias

    String/Expression

    Appears when you select /data in the OpenAPI Path.

    Specify the name of the query parameter for retrieving assets.

    Field 2

    Values

    Default Value:

     None.

     N/A
    Example: 

    application/json

    cds_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

    Specify the integer value to specify the number of attempts the

    snap

    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:

    3Select this checkbox to enable the Snap to pass the input data to the downstream Snap and display in the output document

    3 

    Pass through

     

    Default Value: Deselected

    Checkbox

    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

    limit and offset query parameters

    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 - that is, the

    100—the Snap fetches all records until the last page with 100 records on each

    page.

  • If the limit field is blank, the default limit value is 20 and the Snap displays only one page of records.

    • 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

    . Available options are

    :

    • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during

    pipeline

    • Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during

    pipeline

    • Pipeline runtime.

    • Execute only: Performs full execution of the Snap during

    pipeline

    • Pipeline execution without generating preview data.

    • Disabled: Disables the Snap and all Snaps that are downstream from it.

    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

    Account validation failed403 Error: Unauthorized user.

    The Pipeline ended before the batch could complete execution due to a connection error.

    Verify that the Refresh token field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open.

    ...

    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. 

    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

    ...

    Related Content