Integrate UKG Pro HCM Data into Power Automate Desktop using CData Connect
CData Connect enables you to access live UKG Pro HCM data in workflow automation tools like Power Automate. This article shows how to integrate UKG Pro HCM data into a simple workflow, saving UKG Pro HCM data into a CSV file.
CData Connect provides a live interface for UKG Pro HCM, allowing you to integrate with live UKG Pro HCM data in Power Automate — without replicating the data. Connect 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 Automate
Connectivity to UKG Pro HCM from Power Automate is made possible through CData Connect AI. To work with UKG Pro HCM data from Power Automate, 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 Automate Desktop.
Integrate UKG Pro HCM Data into Power Automate Workflows
After configuring CData Connect with UKG Pro HCM, you are ready to integrate UKG Pro HCM data into your Power Automate workflows. Open Microsoft Power Automate, add a new flow, and name the flow.
In the flow editor, you can add the options to connect to UKG Pro HCM, query UKG Pro HCM using SQL, and write the query results to a CSV document.
Add an Open SQL Connection Action
Add an "Open SQL connection" action (Action -> Database) and click the option to build the Connection string. In the Data Link Properties wizard:
- On the Provider tab: select Microsoft OLE DB Driver for SQL Server
- On the Connection tab:
- Select or enter a server name: set to tds.cdata.com,14333
- Enter information to lag onto the server: select "Use a specific username and password"
- Set User name to your CData Connect AI user name (e.g. [email protected])
- Set Password to your PAT
- Select the database: use the database configured above (e.g. API1)
- Click "Test Connection" to ensure the connection is configured properly
- Click "OK"
After building the connection string in the Data Link Properties wizard, save the action.
Add an Execute SQL Statement Action
Add an "Execute SQL statement" action (Action -> Database) and configure the properties.
- Get connection by: SQL connection variable
- SQL connection: %SQLConnection% (the variable from the "Open SQL connection" action above)
- SQL statement: SELECT * FROM UserDetails
After configuring the properties, save the action.
Add a Write to CSV File Action
Add a "Write to CSV file" action (Action -> File) and configure the properties.
- Variable to write to: %QueryResult% (the variable from the "Execute SQL statement" action above)
- File path: set to a file on disk
- Configure Advanced settings as needed.
After configuring the properties, save the action.
Add a Close SQL Connection Action
Add a "Close SQL connection" action (Action -> Database) and configure the properties.
- SQL Connection: %SQLConnection% (the variable from the "Open SQL connection" action above)
After configuring the properties, save the action.
Save & Run the Flow
Once you have configured all the options for the flow, click the disk icon to save the flow. Click the play icon to run the flow.
Now you have a workflow to save UKG Pro HCM data into a CSV file.
With CData Connect AI, you get live connectivity to UKG Pro HCM data within your Microsoft Power Automate workflows.
SQL Access to UKG Pro HCM Data from Cloud Applications
Now you have a direct connection to live UKG Pro HCM data from Power Automate tasks. You can create more connections and workflows to drive business — all without replicating UKG Pro HCM data.
To get SQL 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.
Related Power Automate Articles
This article explains how to use CData Connect AI with Power Automate Desktop. Check out our other articles for more ways to work with Power Automate (Desktop & Online):