UKG Pro WFM Reporting and Star Schemas in OBIEE
The CData ODBC Driver for UKG Pro WFM is a standard database driver that can integrate real-time access to UKG Pro WFM data into your data warehouse or directly into your reporting tool. This article shows how to bypass the data warehouse and import operational UKG Pro WFM data into Oracle Business Intelligence Enterprise Edition (OBIEE).
See the knowledge base for ODBC integrations with ETL tools like Informatica PowerCenter. For an ETL solution into Oracle Warehouse Builder, use the driver with the Oracle ODBC Gateway to Access UKG Pro WFM Data as a Remote Oracle Database.
Connect to UKG Pro WFM as an ODBC Data Source
If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.
Start by setting the Profile connection property to the location of the UKGProWFM Profile on disk (e.g. C:\profiles\UKGProWFM.apip). Next, set the ProfileSettings connection property to the connection string for UKGProWFM (see below).
UKGProWFM API Profile Settings
UKG Pro Workforce Management uses OAuth 2.0 with the Resource Owner Password Credentials grant (grant_type=password) to authorize access to the API. Unlike most OAuth-based profiles, this does not use a browser redirect/authorization-code step: the driver exchanges your UKG Pro WFM username, password, client ID, and client secret directly for an access token.
Set the following connection properties to authenticate:
- AuthScheme: Set this to OAuthPassword.
- Host: Set this to the hostname of your UKG Pro Workforce Management datacenter/tenant (for example, yourcompany.mykronos.com). Do not include the protocol (https://) or a trailing slash.
- OAuthClientId: Set this to the client ID issued for your UKG Pro Workforce Management OAuth application.
- OAuthClientSecret: Set this to the client secret issued for your UKG Pro Workforce Management OAuth application.
- User: Set this to your UKG Pro Workforce Management username.
- Password: Set this to your UKG Pro Workforce Management password.
Access tokens are obtained from https://{Host}/api/authentication/access_token. Refresh tokens issued by UKG Pro Workforce Management expire after 7 days; if a refresh attempt fails because the refresh token itself has expired, the driver must re-authenticate with your User/Password credentials to obtain a new access token.
When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.
Import UKG Pro WFM Metadata
Follow the steps below to use the OBIEE Client Tools to import UKG Pro WFM metadata into an OBIEE repository. You can then integrate UKG Pro WFM data into your business models.
Open the Administration Tool and click File -> New Repository.
- In the Connection Type menu, select ODBC 3.5 and select the CData DSN.
- Select the metadata types you want to import under the Relational Sources option and then select UKG Pro WFM tables.