Onboarding - Setup Instructions
Follow the steps below to set up the onboarding integration between Firstbase and UKG Pro.
Note: Please contact your account manager to turn on integrations in Firstbase if you don't yet have access to UKG Pro via the Firstbase Integration Hub.
1. Configure your UKG Service Account Permissions and Access
To use the UKG Pro integration, you will need a service account with UKG Pro that includes their onboarding solution.
When selecting or creating your service account, please make sure it has the following "View" permissions:
- Employee Person
- Employee Address
- Employee Contacts
- Employee Job
- Employee Person Details
- Personnel Integration
- Company Configuration Integration
- Employee Export
- Once done, save the user name and email for the service account you generated. You'll need them to connect your account via Firstbase's Integration Hub.
2. Connect your UKG Pro Account via Firstbase's Integration Hub
The current connection between UKG Pro & Firstbase is done via basic authentication. Connecting via OAuth is not yet supported.
In order to establish your connection you must:
- Visit the Firstbase Integration Hub and click on UKG Pro.
- You'll need the following details to connect your account.
- Connection Name - You can use "Firstbase UKG Connection"
- User Name - the user name for the service account created in the previous step.
- Password - the password for the service account created in the previous step.
-
API URL - You can find this this under System Configuration - Web Services. e.g. service.ultipro.com
-
Customer API Key - Navigate to Service Account Administration page under the System Configuration tab to find your Customer API Key.
-
Connect your Account - Add details above to connect with your UKG Pro Account
3. Edit your UKG Pro - Firstbase Employment type settings (optional)
If you only want to create certain types of employees in Firstbase, we provide the option to include/exclude only certain employees based on UKG Pro's "fullTimeOrPartTimeCode" variable.
To do this, you must follow these steps:
- Configure your employment type settings within yourUKG Pro workflow in Firstbase to exclude/include only the right employment types.
- In this case, UKG Pro's fullTimeOrPartTimeCode vairable returns an F (for full time) or a P (for part time employees).
- If you wish to include, exclude either of these groups, add F or P in the exclusion logic.
4. Edit your UKG Pro - Firstbase package assignments (optional).
In this step, you’ll assign each department to a package.
5. Start your Integration!
- You are all set. You can start your integration now!
- Test it out by creating a user in UKG Pro and see it created in Firstbase.