Connectors → Workday
About Workday
Workday is a leading provider of enterprise cloud applications for finance and human resources, helping customers adapt and thrive in a changing world. Workday applications for financial management, human resources, planning, spend management, and analytics have been adopted by thousands of organizations around the world and across industries – from medium-sized businesses to more than 45 percent of the Fortune 500.
About the Workday Connector
The Workday connector uses the CData JDBC Driver which offers the most natural way to connect to Workday data from Java-based applications and developer technologies. The driver wraps the complexity of accessing Workday data in an easy-to-integrate driver that applications can use to access Workday as a traditional database.
The Workday connector supports the following Incorta specific functionality:
Feature | Supported |
---|---|
Chunking | ✔ |
Data Agent | |
Encryption at Ingest | |
Incremental Load | ✔ |
Multi-Source | |
OAuth | |
Performance Optimized | ✔ |
Remote | |
Single-Source | ✔ |
Spark Extraction | |
Webhook Callbacks | ✔ |
Deployment Steps
The Workday connector requires the following JAR file:
cdata.jdbc.workday.jar
The Workday connector requires the deployment of a JAR file to the Incorta Node hosts of the Analytics Service and the Loader Service. A systems administrator with root access to the host can deploy the JAR file. A CMC Administrator can restart the Incorta cluster.
The Workday connector requires a JAR file that Incorta tests and verifies. The JAR download is only available from Incorta Support and must be purchased from Incorta. The XML connector exposes various properties of the CDATA JDBC driver for Workday for an external data source. The CDATA JDBC driver for XML documentation is available at CData JDBC Driver for Workday.
Here the steps to copy the JAR file to standalone Incorta cluster:
- Secure copy the
cdata.jdbc.workday.jar
file to the host. Here is an example using scp:
INCORTA_NODE_HOST=100.101.102.103
cd ~/Downloads
scp -i ~/.ssh/host_pemkey.pem cdata.jdbc.workday.jar incorta@${INCORTA_NODE_HOST}:/tmp/
- Secure shell into the host
ssh -i ~/.ssh/host_pemkey.pem incorta@${INCORTA_NODE_HOST}
- Copy the
cdata.jdbc.workday.jar
to theIncortaNode/runtime/lib/
directory in bash shell
sudo su incorta
INCORTA_INSTALLATION_PATH=/home/incorta/IncortaAnalytics
cp /tmp/cdata.jdbc.workday.jar $INCORTA_INSTALLATION_PATH/IncortaNode/runtime/lib/cdata.jdbc.workday.jar
Restart the Analytics and Loader Services
Here are the steps to restart the Analytics and Loader Services in an Incorta Cluster from the Cluster Management Console (CMC).
- As the CMC Administrator, sign in to the CMC.
- In the Navigation bar, select Clusters.
- In the cluster list, select a Cluster name.
- Select the Details tab, if not already selected.
- In the footer, select Restart.
Steps to connect Workday and Incorta
To connect Workday and Incorta, here are the high level steps, tools, and procedures:
- Create an external data source
- Create a physical schema with the Schema Wizard
- or, Create a physical schema with the Schema Designer
- Load the physical schema
- Explore the physical schema
Create an external data source
Here are the steps to create a external data source with the Workday connector:
- Sign in to the Incorta Direct Data Platform™.
- In the Navigation bar, select Data.
- In the Action bar, select + New → Add Data Source.
- In the Choose a Data Source dialog, in Application, select Workday.
- In the New Data Source dialog, specify the applicable connector properties.
- To test, select Test Connection.
- Select Ok to save your changes.
Workday connector properties
Here are the properties for the Workday connector:
Property | Control | Description |
---|---|---|
Data Source Name | text box | Enter the name of the data source |
User | text box | The Workday user account used to authenticate |
Password | text box | The password to authenticate the user |
Tenant | text box | The tenant for the account |
Host | text box | To obtain the Host, log into Workday and search for View API Clients. In the listed values, find the Workday REST API Endpoint. For example:https://wd3-impl-services1.workday.com/ccx/api/v1/mycompany In this case, the Host would be: https://wd3-impl-services1.workday.com |
Use Connection Pooling | toggle | Enable this property to use connection pooling. For a description of the connection pooling properties, refer to the CData JDBC Driver for Workday. |
Show Advanced Options | toggle | Enable this property to use the advanced connection options. For example, you can specify the specific services such as Cash_Management and Compensation. For a description of the advanced options, refer to the CData JDBC Driver for Workday. |
Create a physical schema with the Schema Wizard
Here are the steps to create a Workday physical schema with the Schema Wizard:
- Sign in to the Incorta Direct Data Platform™.
- In the Navigation bar, select Schema.
- In the Action bar, select + New → Schema Wizard.
-
In (1) Choose a Source, specify the following:
- For Enter a name, enter the schema name.
- For Select a Datasource, select the Workday external data source.
- Optionally create a description.
- In the Schema Wizard footer, select Next.
- In (2) Manage Tables, in the Data Panel, first select the name of the Data Source, and then check the Select All checkbox.
- In the Schema Wizard footer, select Next.
- In (3) Finalize, in the Schema Wizard footer, select Create Schema.
Create a physical schema with the Schema Designer
Here are the steps to create a Workday physical schema using the Schema Designer:
- Sign in to the Incorta Direct Data Platform™.
- In the Navigation bar, select Schema.
- In the Action bar, select + New → Create Schema.
- In Name, specify the schema name, and select Save.
- In Start adding tables to your schema, select Workday.
- In the Data Source dialog, specify the Workday table data source properties.
- Select Add.
- In the Table Editor, in the Table Summary section, enter the table name.
- To save your changes, select Done in the Action bar.
Workday table data source properties
Property | Control | Description |
---|---|---|
Type | drop down list | The default is Workday |
Data Source | drop down list | Select the Workday external data source |
Incremental | toggle | Enable the incremental load configuration for the schema table |
Fetch Size | text box | Used for performance improvement, fetch size defines the number of records that will be retrieved from the database in each batch until all records are retrieved. The default is 5000. |
Incremental Extract Using | drop down list | Enable Incremental to configure this property. Select one of the following options:
|
Incremental Column | drop down list | Enable Incremental and select Maximum Value of a Column for Incremental Extract Using to configure this property. Select the column to be used for Maximum Value of a Column. The Loader will track and use the greatest value or most recent timestamp for each load operation. |
Query | text box | Enter the query to retrieve data from the Workday database |
Update Query | text box | Enable Incremental to configure this property. Enter the query to retrieve data updates from the Workday database. |
Incremental Field Type | drop down list | Enable Incremental to configure this property. Select the format of the incremental field:
|
Chunking Method | drop down list | Chunking methods allow for parallel extraction of large tables. The default is No Chunking. There are two chunking methods:
|
Chunk Size | text box | Select By Size of Chunking for Chunking Method to configure this property. Enter the number of records to extract in each chunk in relation to the Fetch Size. The default is three times the Fetch Size. |
Order Column | drop down list | Select a Chunking Method to configure this property. Select a column in the source table you want to order by before chunking. For a Chunking Method of By Size of Chunking, it is typically an ID column and must be numeric. For a Chunking Method of >By Timestamp, it is a timestamp column. |
Chunk Period | drop down list | Select the chunk period to use in dividing the chunks:
|
Number of Days | text box | Select Custom for Chunk Period to configure this property. Enter the chunking period in days. |
Upper Bound for Order Column | text box | Optional. Enter the maximum value for the order column. |
Lower Bound for Order Column | text box | Optional. Enter the minimum value for the order column. |
Callback | toggle | Enable this option to call back on the source data set |
Callback URL | text box | Enable Callback to configure this property. Specify the URL. |
View the physical schema diagram with the Schema Diagram Viewer
Here are the steps to view the physical schema diagram using the Schema Diagram Viewer :
- Sign in to the Incorta Direct Data Platform™.
- In the Navigation bar, select Schema.
- In the list of schemas, select the Workday schema.
- In the Schema Designer, in the Action bar, select Diagram.
Load the physical schema
Here are the steps to perform a Full Load of the Workday physical schema using the Schema Designer:
- Sign in to the Incorta Direct Data Platform™.
- In the Navigation bar, select Schema.
- In the list of schemas, select the Workday schema.
- In the Schema Designer, in the Action bar, select Load → Load Now → Full.
- To review the load status, in Last Load Status, select the date.
Explore the physical schema
With the full load of the Workday physical schema complete, you can use the Analyzer to explore the schema, create your first insight, and save the insight to a new dashboard. To open the Analyzer from the physical schema, follow these steps:
- In the Navigation bar, select Schema.
- In the Schema Manager, in the List view, select the Workday schema.
- In the Schema Designer, in the Action bar, select Explore Data.
Additional Considerations
Types of Incremental Loads
You can enable Incremental Load for a Workday data source. There are two types of incremental extracts:
Last Successful Extract Time
Fetch updates since the last time the tables were loaded. It is determined by the difference between the current time and the database timestamp.
Maximum Value of a Column
The column-based strategy depends on an extra column called Incremental Column in each table. The Workday connector supports both timestamp and numeric columns. A timestamp column is of the type date
or timestamp
. A numeric column is of the type int
or long
.
Changing the incremental load strategy requires a full load to ensure data integrity.
Incremental Load Example
In this example, the invoices
table must contain a column of the type Date or Timestamp in order to load the table incrementally with a last successful extract time strategy. In this case, the name of the date column is ModifiedDate
and the format of the column is Timestamp.
Here are the data source property values for this example:
- Incremental is enabled
- Query contains
SELECT * FROM invoices
- Update Query contains
SELECT * FROM invoices WHERE ModifiedDate > ?
- Incremental Field Type = Timestamp
?
is a variable in the update query that contains the last schema refresh date. When running an update query for an incremental load, the ?
character will be replaced with the last incremental reference to construct a valid query to the database. The ?
reference character is not valid in a standard query.