WQL APIs

When ConnectionType is set to WQL, the 本製品 models Workday data sources as views. You can get a complete list of these data sources using the Data Sources standard report in Workday. The 本製品 exposes each data source using its WQL Alias which is shown on the View Data Source page.

The 本製品 exposes two kinds of data sources: Prism data sources and Core data sources. All Prism data sources start with the prefix cds_.

1. Prism data sources provide access to published tables and dataset defined within Prism Analytics. These data sources are easy to consume because they do not require providing values for prompts. They are also the most performant because they are served from dedicated Prism services. However, they must be created explicitly within the Prism Data Catalog and are only updated when they are refreshed within Prism.
2. Core data sources provide access to built-in Workday data sources like Workers and Journals. Workday does not recommend using these sources directly, as they are both more difficult to query and slower than data sources from Prism. They use the same resources as the rest of your Workday tenant and complex queries (or queries returning many rows) can slow down your tenant for other users. The main behefit of these data sources is that they always contain live data instead of needing to be refreshed.

The 本製品 does not list all the data sources defined within Workday:

1. The 本製品 only exposes data sources that are accessible to the user you have authenticated as. For example, a user with only HR roles is able to view data sources containing employee records but not data sources about financial assets.
2. The 本製品 only supports one data source filter per data source. The 本製品 uses the unfiltered version of the data source when it is available, and picks the first filter when a filter is required. See WQLDataSourceFilters for more information.

You can use UseSplitTables to work around this limtiation by splitting each data source into multiple views with fewer columns.

Reports

When ConnectionType is set to Reports, the 本製品 also grants access to reports that are exposed using Reports as a Service (RaaS). These reports are exposed as views within the Reports schema. Accessing these reports requires extra connection setup beyond the basic settings for WQL access. See データアクセスのファインチューニング for details on what is required.

REST APIs

The data model included in the REST section is only available when ConnectionType is set to REST.

SOAP APIs

The data models listed in Service are only available in the SOAP API. ConnectionType must be set to SOAP in order to use them.

Prompts

Many WQL data sources, reports, REST endpoints, and SOAP services have prompts that affect what rows Workday reports. The 本製品 exposes these prompts as input columns that have the _Prompt suffix. Most prompts accept only a single value, but prompts that accept multiple values can be set with IN or equals:

SELECT * FROM [Account Balance Data]
WHERE Company_Prompt IN ('1234567890abcdef', 'f1234567890abcde')
AND Region_Prompt = 'ef1234567890abcd'
AND Include_Managers_Prompt = TRUE
AND Start_Date_Prompt = '2022-01-01'

Other filters may be included with prompts. These do not affect the way Workday generates the report, but the 本製品 removes non-matching rows from the response:

SELECT * FROM [Account Balance Data]

/* Prompts */
WHERE Company_Prompt IN ('1234567890abcdef', 'f1234567890abcde')
AND Region_Prompt = 'ef1234567890abcd'
AND Include_Managers_Prompt = TRUE
AND Start_Date_Prompt = '2022-01-01'

/* Other filters */
AND Department = 'Sales and Marketing'
AND Account_Type = 'LIABILITY'

Request References

In addition to _Prompt columns, the SOAP data model also includes columns with the _RequestRef suffix. Request references are parameters that normally correspond to a data field that stores an ID. These parameters increase read performance by allowing the 本製品 to request individual records, instead of requesting all records and filtering internally.

Normally the 本製品 matches a request reference to its data field. When this happens the 本製品 exposes only the data field and translates filters on the data field into request reference parameters. However, if the 本製品 cannot match a request reference to a data field, it instead adds a separate _RequestRef column. These columns are used exactly the same way as _Prompt columns within queries.

Aggregate Prompts

The SOAP data model includes endpoints with more complex prompts than other services. SOAP includes structured prompt values that the 本製品 typically flattens into individual prompts. These can be provided as simple values (like text and timestamps) which the 本製品 uses to build the XML for the SOAP request.

Sometimes this is not possible because the prompt contains complex repeated values that must appear together. For these cases the 本製品 supports aggregate prompts provided as XML. The XML must have a root element called Rows, which contains child elements that match the criteria field. The criteria field itself has a different structure depending upon the specific table and prompt you are using. Refer to the Workday SOAP documentation for full definitions of each criteria type.

For example, the Workers table in the Human Resources schema has a prompt called Eligibility_Criteria_Data_Prompt. Workday documents the Eligibility_Criteria_Data structure as having three values: a single field, an optional effective date, and an optional entry timestamp. The following query provides two of these eligibility criteria values:

SELECT * FROM Human_Resources.Workers WHERE Eligibility_Criteria_Data_Prompt = 
'<Row>
  <Eligibility_Criteria_Data>
    <Field_Reference Descriptor="field a">
      <ID type="WID">abc123</ID>
    </Field_Reference>
    <As_Of_Effective_Date>2024-05-28</As_Of_Effective_Date>
  </Eligibility_Criteria_Data>
  <Eligibility_Criteria_Data>
    <Field_Reference Descriptor="field b">
      <ID type="WID">def456</ID>
    </Field_Reference>
    <As_Of_Entry_DateTime>2024-05-28T14:27:42-05:00</As_Of_Entry_DateTime>
  </Eligibility_Criteria_Data>
</Row>'

Note the following differences between the XML you provide here and what Workday natively accepts:

• The 本製品 inserts namespace prefixes on all elements and attributes. Your aggregate must not include any namespaces.
• The 本製品 does not change the text content of elements or the values of attributes. Workday rejects requests that have incorrectly formatted data, so you must be careful to format values according to Workday requirements. In this example, providing the value "May 28 2024" in the As_Of_Effective_Date element would cause the request to fail.