Note: This is a premium feature or service. This article only applies to your community if your Firstup contract includes this premium functionality. Please contact your Customer Success Manager with any questions about feature availability for your community.

The UKG Application provides users with Human Resources management software and services, such as paid time off requests, scheduling, timecards, etc. 

Users have instant access to UKG tasks or information directly from Firstup via their web or mobile experience. For example, users can submit time off requests directly from the member experience screen without the need to access the UKG app. 

User Experience

User Access

There are two ways users can access UKG integration directly from the web or mobile experience:

• From the using assistant command center. Click the lightbulb in the bottom corner, then the icon.
• Directly from Shortcuts at the top of the member experience. The app's title is configurable and may be named differently in your community:
  
  
  
  

Clicking the application opens the UKG side panel directly in the member experience. The list of available commands will differ depending on the user's role:

User Login

When you access the UKG panel for the first time, selecting any available commands will prompt you to log in. Use your UKG credentials to log in and begin:

Once logged in, you are automatically taken to the command you initially selected. The authenticated session length may vary depending on your configuration but will expire and require you to log back in. 

Available Time Off Commands 

My Accrual Balances

View your accrued time off summary, including all types of time off. Examples: sick, accrued comp time, STD leave, LV-ADA leave, vacation, workers comp, floating holiday, overtime, personal, and custom. The available time-off types depend on your UKG configuration. 

My Time Off Requests

View your time off requests, their duration and their current status.

Request Time Off

Request time off directly from your web or mobile experience. You can select the dates, the type of time off, the duration, and deduct time off request from leave type (leave types depend on your UKG configuration). 

Approve Time Off Requests

As a manager, approve or deny time off requests.

Available Work Shift Commands 

My Schedule

View your shift patterns within a given time period. A calendar shows booked shifts. Each shift shows a start time, end time, duration, shift title, and shift detail. You can change the schedule period to display the previous schedule period, the current schedule period, the next schedule period, the next plus 1 schedule period, and the next plus 2 schedule period.

My Timecards

View your timecards by a selected time schedule, i.e. current pay period. 

Punch In/Out

Punch in and out of shifts or schedules directly from Firstup. 

Install and Configure UKG Integration

To complete these instructions, you must have access to UKG (administrator level), an active community with Firstup, and a contract with Firstup for this premium feature. 

To establish the connection between Firstup and your UKG instance:

1. Log in to the member experience.
2. Log in to your UKG Experience.
3. You also need your UKG Client ID and Client Secret. Contact UKG support if you do not have this.

Create App Key in UKG Experience

Set up your App Key with your Client ID and Client Secret in UKG Experience:

1. Go to Administration > Application Setup.
2. Then select Common Setup > My Apps.
3. On the My Apps page:
   
   
   1. Select + App.
      
      
   2. Enter a unique app name e.g. Firstup Integration. 
   3. Select one or more products.
   4. Select Save.
      
      
      
      
4. Select the created app from the app list. 
5. Select Details.
6. Copy the App Key from the Appkey Details panel:
   
   

Allow Firstup URLs in UKG Experience

1. Go to Administration > Application Setup.
2. Select System Configuration > System Settings.
3. Select the Global Values tab.
   
   
   
   
4. In the Global Values tab, locate global.oAuth.authCode.redirection.uris and append the Firstup callback URLs separated by a comma. The callback URLs are:
   • US customers: https://eva.socialchorus.com/api/v/integrations/ukg_dimensions/callback
   • EU customers: https://eva.onfirstup.eu/api/v1/integrations/ukg_dimensions/callback
5. Select Save.

Enable endpoint accessibility in UKG Experience

The integration utilizes the following endpoint to retrieve authenticated user information. This endpoint may be disabled by default:

• /api/v1/commons/persons/current_user_info

Function Access Profiles control the API access, and need to be set to allowed:

1. Go to Administration > Application Setup.
2. Select Access Profiles > Function Access Profiles.
3. Select a specific profile. 
   
   
   
   
4. Expand APIs > REST API and locate Current User Information API.
5. Select Allowed from the drop-down and select Save & Return.
6. Repeat steps 3 to 5 for all of the other Function Access Profiles that use the UKG integration.
7. Once you have completed these steps, supply Firstup with the following:
   • Base URL
   • App Key
   • Client ID
   • Client Secret
8. Support will finalize the integration setup on the Firstup side.