UKG Dimensions Shifts

UKG, is a technology company that offers a wide variety of business software solutions.  Their UKG Dimensions platform (now UKG Pro Workforce Management) is one of the leading shift management platforms with users spanning a wide range of sizes and industries.

 

Shifts can change on a weekly or even daily basis.  By leveraging Beekeeper's intuitive and mobile optimized Shift Schedules feature, we can put those real-time schedules in the hands of your employees with ease.

 

How does the integration work?

The UKG Dimensions Shifts integration sends shifts from UKG into Beekeeper.  All shifts are imported into a schedule in Beekeeper, based on the Hyperfind that you select.

Shifts are fetched for employees present in UKG Dimensions who also have Beekeeper accounts.  Employees are matched based on their Beekeeper "tenantuserid" (or "User-ID" in the dashboard) and UKG Dimensions "ID".  These two fields must have the same value.

 

Step 1: Install the UKG Dimensions Shifts App in the Beekeeper Marketplace

Navigate to your Beekeeper Dashboard, then Extensions > Marketplace > UKG Dimensions Shifts.  Click on the "Request" button, and contact your Beekeeper Customer Success Manager or the Beekeeper Support team to have the app installed.

Once the app has been installed, a UKG Dimensions Shifts Bot Account will automatically be created.  In a later step, you will need to use the API Access Token for this bot.  To obtain this token, navigate to Dashboard > Extensions > Bot Accounts.  Next to “UKG Dimensions Shifts”, move your mouse over “Hover and click to copy token”, and click to copy the token.

 

Step 2: Integration Installation and Configuration in UKG Dimensions

2.1 Boomi Integration Deployment Procedure

Submit a case to UKG Support to have the "Beekeeper Schedule Export" process folder copied into your Boomi account.  The "Beekeeper Schedule Export" needs to be copied with all of its component dependents.

 

Once that is complete, in UKG Dimensions, from the main menu, go to Administration > Application Setup > Integrations Setup > Design Integration Template.

 

2.1.1 Create Packaged Component

The Boomi platform will open in a new window.  In the Boomi platform's "Build" tab, search for "Beekeeeper Schedule Export".  Under "Processes", click on BeekeeperScheduleExport. Then, click Create Packaged Component.

 

Ensure all components are selected, then click Next: Add Details

 

Fill out the "Version for all" and "Package Notes for All" text fields if desired, and make a selection for the "Sharing" field.  Click Create Packaged Component.

 

2.1.2 Deploy

You will see a pop-up window saying "Packaged Components Successfully Created".  Click Deploy.

Select the Deployment Environment (example: beekeeper_nonprd_03), and include Deployment Notes.  Then, click Next: Select Versions.

 

Ensure all components are selected in the left toolbar, then click Next: Review.

 

Then, click Deploy.  You should see a pop-up window informing you that the deployment was successful.  Keep this tab open; you will need to access Boomi later.  Return to your UKG Dimensions environment.

 

2.2 UKG Dimensions Integration Installation

2.2.1 Create Integration

In Dimensions, from the main dropdown menu, go to Administration > Application Setup > Integrations Setup > Install Integrations.

 

Click Create.

 

Name the integration (1).  Select Yes for the "Execute Integration with System Account" field (2).  Select Integration Template for the "Skip Configuration" field (3).  Select Yes for the "Allow Minute Interval" field (4).  Click on BeekeeperScheduleExport under "Integration Template" (5), then click Assign (6).

 

2.2.2 Integration Parameters

After clicking Assign, a section called Integration Parameters will appear below.  You can choose to add the parameters now or at a later time.  To add at a later time, click Save.  You can access and edit the integration from Administration > Application Setup > Integrations Setup > Install Integrations, selecting the installed integration, and clicking on Edit.  Please note: all scheduled integrations should be stopped before editing integration parameters or integration configuration.

 

To proceed with adding parameters, click Create.

 

Use the table of required parameters below to name and select the corresponding "Template Parameter" and "Parameter Type".  Make sure "User Prompted" is checked "Yes".  Then, click Save.  Do this for each required parameter.

Required Parameters

Parameter Name	Description	Template Parameter	Parameter Type	Default Value	User Prompted
Date Range	Used for choosing Schedule Export Date Range (date selector)	DateRange	Time Period		Yes
Hyperfind	Choosing Hyperfind   This will appear as the Schedule Name in Beekeeper.	Hyperfind ID	HyperFind	Select the name of a Hyperfind that captures the employees you want to upload shifts in Beekeeper for. *You cannot use the default selection “All Home Locations”.	Yes
Offset (+ number of days)	Number of Days starting from Current date (has more priority than Date Range parameter)	Offset	Text		Yes
Re-Create Schedule	Re-creating Schedule (Deleting existing Schedule including related Shift data in Beekeeper and Create new one with corresponding Shift data)	Re-Create Schedule	Boolean	true   *It's recommended to keep as true, so as not to duplicate shifts.	Yes
Shift Title	Default Shift name for manually created Shifts.  Previously set Shift Labels will take precedence.   This will appear as the name of an individual shift in Beekeeper, ex. AM Shift.	ShiftTitle	Text	TestTitle	Yes
Suffix	Add a Start-End time suffix to Shift name	Suffix	Boolean	false	Yes

 

2.3 Configure Integration Extensions in Dell Boomi

Navigate back to your browser window with Boomi.  Go to Manage > Atom Management.

 

Click on the environment that you designated in step 2.1.2 in the left toolbar; then click on Environment Extensions (you may need to scroll down to find it).

 

In the "Connection" dropdown menu, select BeekeeperScheduleExport-BeekeeperAPIConnection.  Unselect "Use connection component value", and type in the base Beekeeper API URL (for example, https://yourcompany.us.beekeeper.io/api/2)

 

Then, in the "Connection" dropdown menu, select BeekeeperScheduleExport_APIGatewayServer.  Unselect "Use connection component value", and type in the base UKG Dimensions API URL (for example, https://beekeeper.cfn.mykronos.com/api).  If you are unsure of your UKG Dimensions API Url, please reach out to UKG Global Support.

 

Click on Process Properties.  In the "Process Property" dropdown, select BeekeeperScheduleExport_Auth.  Unselect "Use Default".  Enter the API Access Token from the Beekeeper UKG Dimensions Shifts Bot Account in your Beekeeper Dashboard (from step 1).

Click OK. 

 

Step 3: Launching the Integration

3.1 Verify User Ids

Before running the integration, verify that users in Beekeeper have their UKG ID as their Beekeeper User-ID.  This is to ensure that the integration can find and map users between UKG Dimensions and Beekeeper.  See screenshots at the top of this article.

 

3.2 Run the Integration for the First Time

Go to the Home page of your UKG Dimensions environment.  Navigate to Main Menu > Maintenance > Integrations.  Click Run an Integration, click on the desired integration, then click Select.

 

Fill out the required parameters: Offset (+ number of days) and Hyperfind.  In the Hyperfind field, you cannot use the default selection "All Home Locations".  Edit the other fields if needed.  Then click Run Integration.

 

3.3 Schedule the Integration

You can schedule the integration to run at a certain time or make it recurring.  Navigate to Home > Main Menu > Maintenance > Integrations.  Select Schedule Processes.

 

Then select Schedule an Integration.  Choose the desired integration, then click Select.

 

Fill out or edit fields as needed, like in the previous step, step 3.2.  Under "Schedule", make the desired selections.  See an example here:

 

Select One-time Scheduled Run to run the integration once at a certain date and time.  Select Recurring Scheduled Run, then Recurrence, and select your desired frequency (hour, day, week, or month) in the "Repeats" dropdown to run the integration on a recurring basis.  When finished, click Schedule Integration Request.

 

Step 4: Analyzing Integration Runs

After an integration run has been executed, you can view the integration result and details in UKG Dimensions.  Navigate to Home > Main Menu > Maintenance > Integrations.  Under "Completed", click the desired integration run.  Scroll down to "Run Summary" to view details.  If the run was unsuccessful, you can see information about the error in "Message Details".

 

In Beekeeper, you will see a schedule (Dashboard > Toolbox > Shift Schedules) with the name of the Hyperfind and the latest upload date.  The schedule may say "No members", but shifts have been imported for the users captured in the Hyperfind.  You can click on this schedule to see the past successful imports.

 

You can also verify that shifts have been imported by asking individuals to check their shifts in Beekeeper.  See the "Viewing a Shift Schedule in the app" section of our Help Center article.