Integrate Live UKG Pro HCM Data into Custom Business Apps Built in Power Apps
Power Apps is a service for building and using custom business apps that connect to your data and work across the web and mobile — without the time and expense of custom software development. When paired with CData Connect AI, you get instant, cloud-to-cloud access to UKG Pro HCM data from the apps you build using Power Apps. This article shows how to connect to Connect AI from Power Apps and build an app based on live UKG Pro HCM data.
CData Connect AI provides a pure SQL, cloud-to-cloud interface for UKG Pro HCM, allowing you to easily integrate with live UKG Pro HCM data in Power Apps — without replicating the data. CData Connect AI looks exactly like a SQL Server database to Power Apps and uses optimized data processing out of the box to push all supported SQL operations (filters, JOINs, etc) directly to UKG Pro HCM, leveraging server-side processing to quickly return UKG Pro HCM data.
Configure UKG Pro HCM Connectivity for Power Apps
Connectivity to UKG Pro HCM from Power Apps is made possible through CData Connect AI. To work with UKG Pro HCM data from Power Apps, we start by creating and configuring a UKG Pro HCM connection.
- Log into Connect AI, click Sources, and then click Add Connection
- Select "UKG Pro HCM" from the Add Connection panel
-
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.
- Click Save & Test
-
Navigate to the Permissions tab in the Add UKG Pro HCM Connection page and update the User-based 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.
- Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
- On the Settings page, go to the Access Tokens section and click Create PAT.
-
Give the PAT a name and click Create.
- 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 Power Apps.
Connecting to CData Connect AI
To use Connect AI to integrate UKG Pro HCM data into your Power Apps, you need a new SQL Server connection:
- Log in to Power Apps
- Click Dataverse -> Connections -> New connection
- Select SQL Server
- In the connection wizard:
- Choose to connect directly
- Set SQL server name to tds.cdata.com,14333
- Set SQL database name to the name of the UKG Pro HCM connection (e.g. API1)
- Set Username to a Connect AI user (e.g. [email protected])
- Set Password to the PAT for the above user
- Click Create
Building a Data-Centric App for UKG Pro HCM Data
With the connection to Connect AI configured, you are ready to integrate live UKG Pro HCM data into the apps you build in Power Apps.
- Log in to Power Apps
- Click Create and select "SQL"
- Select the SQL Server connection you created
- Search for or choose a table to work with
- Click Connect
- Customize the newly created app just like you would any other, including changing the layout and setting the fields exposed in BrowseScreen, DetailScreen, and EditScreen
At this point, you have an app with read access to live UKG Pro HCM data that you can save and publish for use within your organization.
SQL Access to UKG Pro HCM Data from Cloud Applications
Now you have a direct connection to live UKG Pro HCM data from Microsoft Power Apps. You can create more connections and apps to drive business — all without replicating UKG Pro HCM data.
To get real-time data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your cloud applications, sign up for a free trial of CData Connect AI.