Build Workday-Connected Web Apps with Axios and CData Connect Cloud



Use CData Connect Cloud to connect to live Workday data and build Workday-connected web apps with Axios.

Axios is a JavaScript library that allows developers to make HTTP requests to servers from a web browser or Node.js. When paired with CData Connect Cloud, you get access to live Workday data for your web apps. This article shows how to connect to Workday and build web apps in Axios with access to live Workday data.

About Workday Data Integration

CData provides the easiest way to access and integrate live data from Workday. Customers use CData connectivity to:

  • Access the tables and datasets you create in Prism Analytics Data Catalog, working with the native Workday data hub without compromising the fidelity of your Workday system.
  • Access Workday Reports-as-a-Service to surface data from departmental datasets not available from Prism and datasets larger than Prism allows.
  • Access base data objects with WQL, REST, or SOAP, getting more granular, detailed access but with the potential need for Workday admins or IT to help craft queries.

Users frequently integrate Workday with analytics tools such as Tableau, Power BI, and Excel, and leverage our tools to replicate Workday data to databases or data warehouses. Access is secured at the user level, based on the authenticated user's identity and role.

For more information on configuring Workday to work with CData, refer to our Knowledge Base articles: Comprehensive Workday Connectivity through Workday WQL and Reports-as-a-Service & Workday + CData: Connection & Integration Best Practices.


Getting Started


Connect to Workday from Axios

To work with Workday in Axios, we need to connect to Workday from Connect Cloud, provide user access to the connection, and create a Workspace for the Workday data.

Connect to Workday from Connect Cloud

CData Connect Cloud uses a straightforward, point-and-click interface to connect to data sources.

  1. Log into Connect Cloud, click Sources, and then click Add Connection
  2. Select "Workday" from the Add Connection panel
  3. Enter the necessary authentication properties to connect to Workday.

    To connect to Workday, users need to find the Tenant and BaseURL and then select their API type.

    Obtaining the BaseURL and Tenant

    To obtain the BaseURL and Tenant properties, log into Workday and search for "View API Clients." On this screen, you'll find the Workday REST API Endpoint, a URL that includes both the BaseURL and Tenant.

    The format of the REST API Endpoint is: https://domain.com/subdirectories/mycompany, where:

    • https://domain.com/subdirectories/ is the BaseURL.
    • mycompany (the portion of the url after the very last slash) is the Tenant.
    For example, in the REST API endpoint https://wd3-impl-services1.workday.com/ccx/api/v1/mycompany, the BaseURL is https://wd3-impl-services1.workday.com and the Tenant is mycompany.

    Using ConnectionType to Select the API

    The value you use for the ConnectionType property determines which Workday API you use. See our Community Article for more information on Workday connectivity options and best practices.

    APIConnectionType Value
    WQLWQL
    Reports as a ServiceReports
    RESTREST
    SOAPSOAP

    Authentication

    Your method of authentication depends on which API you are using.

    • WQL, Reports as a Service, REST: Use OAuth authentication.
    • SOAP: Use Basic or OAuth authentication.

    See the Help documentation for more information on configuring OAuth with Workday.

  4. Click Create & Test
  5. Navigate to the Permissions tab in the Add Workday Connection page and update the User-based permissions.

Add a Personal Access Token

When connecting to Connect Cloud through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect Cloud. It is best practice to create a separate PAT for each service to maintain granularity of access.

  1. Click on the Gear icon () at the top right of the Connect Cloud app to open the settings page.
  2. On the Settings page, go to the Access Tokens section and click Create PAT.
  3. Give the PAT a name and click Create.
  4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Configure Workday Endpoints for Axios

After connecting to Workday, create a workspace for your desired table(s).

  1. Navigate to the Workspaces page and click Add to create a new Workspace (or select an existing workspace).
  2. Click Add to add new assets to the Workspace.
  3. Select the Workday connection (e.g. Workday1) and click Next.
  4. Select the table(s) you wish to work with and click Confirm.
  5. Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}

With the connection, PAT, and Workspace configured, you are ready to connect to Workday data from Axios.

Connect to Workday Data in Axios Workflows

To establish a connection from Axios to CData Connect Cloud using the OData protocol, follow these steps.

  1. Create a project directory for your web app. For example: ~/connect_cloud/
  2. Open a terminal, navigate the the project directory and initialize a node project using the command:
    npm init -y
  3. Install the Axios dependency in the project using the following command:
    npm install axios
  4. In your project directory, create a file called server.js that contains the following code. Provide your CData Connect Cloud username (e.g. [email protected]) and PAT (the PAT you created in the prerequisites). You must also provide a query for your data, such as SELECT * FROM Workday1.SCHEMA.Workers.

    server.js code

          const axios = require('axios')
    
          const user = '[email protected]'
          const pat = '***********************************';
    
          //Your API endpoint
          const url = 'https://cloud.cdata.com/api/odata/{workspace_name}';
    
          //Your data to be sent in the POST request
          const data = {
          "query":"SELECT * FROM {workspace_name}.SCHEMA.Workers"
          };
    
          axios.post(url, data, {
          auth: {
          username: user,
          password: pat
          }
          })
          .then(response => {
          const rows = response.data.results[0].rows;
          const schema = response.data.results[0].schema;
    
          //Create an array of column names
          const columnNames = schema.map(col => col.columnName);
    
          //Loop through each row and log the column name with its value
          rows.forEach(row => {
          const rowObject = {};
          row.forEach((value, index) => {
          const columnName = columnNames[index];
          rowObject[columnName] = value;
          });
          console.log(rowObject);
          })
          })
          .catch(error => {
          console.error('Error:', error);
          });
        
  5. In the terminal, execute the following command to run the server:
    node server.js
    The query results will appear:
        { ID: 1, VALUE: -2 }
        { ID: 2, VALUE: 1 }
        { ID: 11, VALUE: null }
        { ID: 3, VALUE: 2 }
        { ID: 4, VALUE: 5 }
        ...

Simplified Access to Workday Data from Cloud Applications

At this point, you have a direct connection to live Workday data from Axios. For more information on gaining simplified access to data from more than 100 SaaS, Big Data, and NoSQL sources in cloud applications like Axios, refer to our Connect Cloud page.

Ready to get started?

Learn more about CData Connect Cloud or sign up for free trial access:

Free Trial