Workday Custom Reports
The Workday Custom Reports component uses the Workday RaaS (Reporting as a Service) API to retrieve and store data—such as employee, financial, and business-related data—from Workday, to be loaded into a table. You can then use transformation components to enrich and manage the data in permanent tables.
To extract data via Workday Web Services, use the Workday component instead.
Using this component may return structured data that requires flattening. For help with flattening such data, we recommend using the Extract Nested Data component.
Properties
Name = string
A human-readable name for the component.
Host = string
Your Workday host name. Read Workday authentication guide to learn how to acquire this credential.
Tenant = string
Your Workday Tenant ID. Read Workday authentication guide to learn how to acquire this credential.
Authentication Type = drop-down
Only currently supports username and password.
Username = string
Your Workday username.
Password = drop-down
Use the drop-down menu to select the corresponding secret definition that denotes your Workday password. Read Secret definitions to learn how to create a new secret definition.
API = drop-down
Select REST API or SOAP API.
- The REST API does not return object IDs unless explicitly included in the report by the report creator. Data is formatted in JSON.
- The SOAP API returns all object IDs with the objects as standard. Data is formatted in XML.
Data Format = drop-down
Select the format of the data. Currently, only JSON is available. Property only available when using the REST API.
Report Owner = drop-down
Select the Workday user who owns the report you want to extract data from. The default is All, meaning all reports created by all users will be available to the component.
Report Name = drop-down
Select the report you want to extract data from.
Destination = drop-down
- Cloud Storage: Load your data into your preferred cloud storage location.
- Snowflake: Load your data into your preferred cloud data warehouse. A cloud storage location will be used for temporary staging of the data.
Click either the Cloud Storage or Snowflake tab on this page for documentation applicable to that destination type.
Folder Path = string
The folder path of the written files.
File Prefix = string
A string of characters to include at the beginning of the written files. Often used for organizing database objects.
Storage = drop-down
A cloud storage location to load your data into for storage.
Choose either Amazon S3 or Azure Blob Storage.
Click either the Amazon S3 or Azure Blob Storage tab below for documentation applicable to that storage type.
AWS Bucket = drop-down
An AWS S3 bucket to load data into. The drop-down menu will include buckets tied to the cloud provider credentials that you have associated with your environment.
Storage Account = drop-down
Select a storage account linked to your desired blob container to be used for staging the data. For more information, read Storage account overview.
Container = drop-down
Select a Blob container to be used for staging the data. For more information, read Introduction to Azure Blob storage.
Warehouse = drop-down
The Snowflake warehouse used to run the queries. The special value, [Environment Default], will use the warehouse defined in the environment. Read Overview of Warehouses to learn more.
Database = drop-down
The Snowflake database. The special value, [Environment Default], will use the database defined in the environment. Read Databases, Tables and Views - Overview to learn more.
Schema = drop-down
The Snowflake schema. The special value, [Environment Default], will use the schema defined in the environment. Read Database, Schema, and Share DDL to learn more.
Table Name = string
The name of the table to be created.
Create Table Mode = drop-down
- Replace if exists: If the specified table name already exists, that table will be destroyed and replaced by the table created during this pipeline run.
- Truncate and insert: If the specified table name already exists, all rows within the table will be removed and new rows will be inserted per the next run of this pipeline.
- Fail if exists: If the specified table name already exists, this pipeline will fail to run.
Clean Staged files = boolean
- Yes: Staged files will be destroyed after data is loaded.
- No: Staged files are retained in the staging area after data is loaded.
Stage Platform = drop-down
Choose a data staging platform using the drop-down menu.
- S3: Stage your data on an AWS S3 bucket.
- Snowflake: Stage your data on a Snowflake internal stage.
Click one of the tabs below for documentation applicable to that staging platform.
AWS Bucket = drop-down
An AWS S3 bucket to stage data into. The drop-down menu will include buckets tied to the cloud provider credentials that you have associated with your environment.
Internal Stage Type = drop-down
A Snowflake internal stage type. Currently, only type User is supported.
Read Choosing an Internal Stage for Local Files to learn more about internal stage types and the usage of each.
Storage Account = drop-down
Select a storage account linked to your desired blob container to be used for staging the data. For more information, read Storage account overview.
Container = drop-down
Select a Blob container to be used for staging the data. For more information, read Introduction to Azure Blob storage.
| Snowflake | Databricks (preview) | Amazon Redshift (preview) |
|---|---|---|
| ✅ | ❌ | ❌ |