Create UKG Pro HCM-Connected Business Apps in AppSheet

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Connect to UKG Pro HCM Data via CData Connect AI in Google AppSheet and create custom business applications with real-time access to UKG Pro HCM data.

Google AppSheet is a no-code development platform for application software, enabling users to design mobile, tablet, and web applications. When combined with CData Connect AI, you gain immediate cloud-to-cloud access to UKG Pro HCM data for business applications. This article outlines the process of connecting to UKG Pro HCM using Connect AI and constructing a basic app from UKG Pro HCM data within AppSheet.

CData Connect AI offers a dedicated cloud-to-cloud interface for UKG Pro HCM, enabling the creation of reports directly from live UKG Pro HCM data within AppSheet, all without the need for data replication to a native database. When you design applications that interact with data, AppSheet formulates SQL queries to retrieve the required information. With its inherent optimized data processing capabilities, CData Connect AI efficiently channels all supported SQL operations, including filters and JOINs, directly to UKG Pro HCM. This leverages server-side processing to swiftly deliver the requested UKG Pro HCM data.

Configure UKG Pro HCM Connectivity for AppSheet

Connectivity to UKG Pro HCM from AppSheet is made possible through CData Connect AI. To work with UKG Pro HCM data from AppSheet, we start by creating and configuring a UKG Pro HCM connection.

  1. Log into Connect AI, click Sources, and then click Add Connection
  2. Adding a Connection
  3. Select "UKG Pro HCM" from the Add Connection panel
  4. Selecting a data source
  5. Enter the necessary authentication properties to connect to UKG Pro HCM.

    Start by setting the Profile connection property to the location of the UKGProHCM Profile on disk (e.g. C:\profiles\UKGProHCM.apip). Next, set the ProfileSettings connection property to the connection string for UKGProHCM (see below).

    UKGProHCM API Profile Settings

    UKG Pro HCM uses Basic authentication combined with a customer API key to authorize access to the API. To connect, you will need your UKG Pro HCM credentials and a customer API key issued by UKG.

    Set the following connection properties to authenticate:

    • AuthScheme: Set this to Basic.
    • User: Set this to your UKG Pro HCM username.
    • Password: Set this to your UKG Pro HCM password.
    • ProfileSettings: Set this to a semicolon-separated list containing:
      • Host: Your UKG Pro HCM tenant hostname (e.g., yourcompany.ultipro.com).
      • CustomerAPIKey: Your UKG customer API key. This is passed as the US-CUSTOMER-API-KEY request header on each API call.

    To obtain your customer API key, contact your UKG Pro HCM administrator or refer to the UKG Developer Portal at https://developer.ukg.com.

    Configuring a connection (Salesforce is shown)
  6. Click Save & Test
  7. Navigate to the Permissions tab in the Add UKG Pro HCM Connection page and update the User-based permissions. Updating permissions

Add a Personal Access Token

When connecting to Connect AI 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 AI. 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 AI 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. Creating a new PAT
  4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to UKG Pro HCM data from AppSheet.

Connect to UKG Pro HCM from AppSheet

The steps below outline connecting to CData Connect AI from AppSheet to create a new UKG Pro HCM data source.

  1. Log into AppSheet
  2. Click "My account" in the menu
  3. Click the Sources tab and add a new data source Creating a new data source
  4. Select Cloud Database and set the connection information
    • Type: Sql Server
    • Server: tds.cdata.com,14333
    • Database: the UKG Pro HCM connection, for example, API1
    • Username: a Connect AI user, for example, [email protected]
    • Password: the PAT for the above Connect AI user
    • SSL: Require SSL
    Connecting to Connect AI
  5. Click "Test Connection"
  6. Click "Authorize Access"

Create an App

Once you create the data source for UKG Pro HCM, you can start building apps on UKG Pro HCM data. Start by clicking "My apps" in the menu.

  1. Click to create a new app and select "Start with your own data"
  2. Name the app and select an appropriate category, based on your data
  3. Select the newly created data source
  4. Select the table or view with the data you want Selecting a table

At this point, you can configure the design of your app, selecting which columns from the selected table to display, use as labels, and more. Preview the app in the preview panel and then publish or share it when ready.

Configuring an app connected to Connect AI.

To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your cloud applications, try CData Connect AI today!

Ready to get started?

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

Free Trial