# UKGPro

#### Overview

The Veza integration for the UKGPro workflow management platform connects to a single environment to discover employees, local users, and user roles. The integration provides visibility into user access to the UKGPro application and enables Veza to ingest HRIS employee data for Lifecycle Management.

#### Configuring UKGPro

Veza collects information from UKGPro by running a custom report to gather employee data and role information. Before configuring authentication credentials, create the Veza report using the steps and report definition below.

#### Prerequisites

1. Reporting and Analytics must be enabled for your UKG environment. If it is not already enabled, your UKG vendor must update the license configuration to support this functionality.
2. Download the `Veza_UKG_Report.xml` using the link below.

{% file src="/files/P4Zy3TZrnbNCpVcuwXiL" %}

**Creating the Report**

1. Log in as administrator, navigate to **Menu -> Administration** and select **Business Intelligence**
2. From **Explore Analytics** create a new blank report by clicking **New**, selecting **Report** and selecting the **Blank template** before clicking **OK**
3. From the toolbar click **Pages** then right-click **Report** then select **Open report from clipboard**
   1. Copy and paste the contents of the Veza report template into the box and click **Ok**
4. After report validation is completed save the report by selecting **Save as**. Save the report under **Team content** and optionally create a new **Veza** folder.
5. From **Home**, click the actions menu (three dots) for the newly created report and view **Properties**. Expand **Advanced** and note the **ID** for the report.

The following fields are included in the report:

| Name                                  | Key                                                                        |
| ------------------------------------- | -------------------------------------------------------------------------- |
| Employee Number                       | `[Business Layer].[Employee].[Employee Number]`                            |
| Job Title                             | `[Business Layer].[Employee].[Job Title]`                                  |
| Job Group                             | `[Business Layer].[Employee].[Job Group]`                                  |
| Supervisor Email                      | `[Business Layer].[Employee].[Supervisor Email]`                           |
| Middle Name                           | `[Business Layer].[Employee].[Middle Name]`                                |
| Prefix                                | `[Business Layer].[Employee].[Prefix]`                                     |
| Suffix                                | `[Business Layer].[Employee].[Suffix]`                                     |
| First Name                            | `[Business Layer].[Employee].[First Name]`                                 |
| Last Name                             | `[Business Layer].[Employee].[Last Name]`                                  |
| Preferred First Name                  | `[Business Layer].[Employee].[Preferred First Name]`                       |
| Email Address                         | `[Business Layer].[Employee].[Email Address]`                              |
| Alternate Email Address               | `[Business Layer].[Employee].[Alternate Email Address]`                    |
| Location Code                         | `[Business Layer].[Employee].[Location Code]`                              |
| Employee Number (Supervisor)          | `[Business Layer].[Supervisor Information].[Employee Number (Supervisor)]` |
| Org Level 1                           | `[Business Layer].[Employee Organization Levels].[Org Level 1]`            |
| Org Level 2                           | `[Business Layer].[Employee Organization Levels].[Org Level 2]`            |
| Org Level 3                           | `[Business Layer].[Employee Organization Levels].[Org Level 3]`            |
| Org Level 4                           | `[Business Layer].[Employee Organization Levels].[Org Level 4]`            |
| Company Code                          | `[Business Layer].[Employee].[Company Code]`                               |
| Location                              | `[Business Layer].[Employee Locations].[Location]`                         |
| Last Hire Date                        | `[Business Layer].[Employee].[Last Hire Date]`                             |
| EepPersonID                           | `[Business Layer].[Employee].[EepPersonID]`                                |
| Role                                  | `[Business Layer].[User Roles].[Role]`                                     |
| Employee Name (Last Suffix, First MI) | `[Business Layer].[Employee].[Employee Name (Last Suffix, First MI)]`      |
| Company                               | `[Business Layer].[Employee].[Company]`                                    |
| Employee Type                         | `[Business Layer].[Employee].[Employee Type]`                              |
| Cost Center (X)                       | `[Business Layer].[Employee Pro Rated Pay].[Cost Center (X)]`              |
| Employment Status                     | `[Business Layer].[Employee].[Employment Status]`                          |
| Last Logon                            | `[Business Layer].[Users].[Last Logon]`                                    |

{% hint style="warning" %}
**Report generation errors from missing fields:** If any of the fields listed above are not populated in your UKG environment, the Cognos report may fail to generate. To resolve this:

1. Remove the unpopulated field entries from `Veza_UKG_Report.xml` before importing the report template.
2. Generate a report with the modified XML.

The Veza integration requires the columns mapping to required custom provider properties to be present in the report (`Employee Number`, `First Name`, `Last Name`, `Employment Status`). Removing any of these columns will cause extraction to fail.
{% endhint %}

**Configuring Authentication**

1. Log in as administrator, navigate to **Menu -> System Configuration** then select **Web Services** under the security section.
2. Note the values displayed for **User API Key** and **Customer API Key**
3. Note the base URL displayed next to **Business Intelligence web service endpoint**.
4. Create a UKGPro Service Account Veza will use for discovery. Note the username and password. Assign the user the following permissions:
   1. **Employee Person > View**
   2. **Employee User Defined Fields > View**
5. The Service Account will require access to Business Intelligence (BI), your company's SaaS Focal Contact must submit an administrative case in the UKG Community Library to request this.

For additional information on creating and managing service accounts including information on requesting BI access see [Manage Service Accounts](https://library.ukg.com/a/179488) documentation.

#### Configuring UKGPro on the Veza Platform

Log in to Veza as an administrator to enable the UKGPro integration:

1. In Veza, open the **Integrations** page.
2. Click **Add New** and pick UKGPro as the type of integration to add
3. Enter the required information and **Save** the configuration
   1. **Service Url**
   2. **User Name**
   3. **Password**
   4. **Customer API Key**
   5. **User API Key**
   6. **Report ID**
   7. **IDP Types** - Optional list of Identity Provider types to link Employees to. For multiple values use `,` supported values:
      1. `okta`
      2. `azure_ad`
      3. `custom`
      4. `google_workspace`
      5. `one_login`
   8. **Timezone** - Optional configuration to process report date-times in the specified timezone. If not specified, default is UTC. Must be in IANA format:
      1. e.g. `America/Denver` will process employee hire and termination dates in Mountain Time (MST)

#### Enabling Lifecycle Management for UKGPro

UKGPro employees are ingested as `CustomHRISEmployee` entity types for use in [Lifecycle Management](/4yItIzMvkpAvMVFAamTf/features/lifecycle-management/integrations.md) policies.

#### Prerequisites

You will need administrative access in Veza to configure the integration and grant API scopes in UKGPro.

1. Ensure you have an existing UKGPro integration in Veza or add a new one for use with Lifecycle Management.
2. Verify the integration has completed at least one successful extraction

#### Configuration Steps

To enable the integration:

1. In Veza, go to the **Integrations** overview
2. Search for or create a **UKGPro** integration
3. Check the box to **Enable usage for Lifecycle Management**

Configure the extraction schedule to ensure your UKGPro data remains current:

1. Go to Veza **Administration > System Settings**
2. In **Pipeline > Extraction Interval**, set your preferred interval
3. Optionally, set a custom override for UKGPro in the Active Overrides section

To verify the health of the Lifecycle Management data source:

1. Open **Lifecycle Management** > **Integrations** (in the Products section of the navigation sidebar), or the main **Integrations** page (in the Featured section)
2. Search for the integration and click the name to view details
3. In the **Properties** panel, click the magnifying glass icon under **Lifecycle Management Enabled**


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.veza.com/4yItIzMvkpAvMVFAamTf/integrations/integrations/ukgpro.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.