Summary
UKG Pro employees can be transferred into iPaaS.com through scheduled polling or a manual sync. Each transfer captures the employee's name and email address, together with a child address record carrying the employee's home address. Only employees whose home-company employment status is Active or Leave are captured, so the iPaaS.com roster reflects the currently-employed population rather than every historical record.
ID Format
Manual Sync ID Format
Enter the UKG Pro employee identifier on the iPaaS.com Manual Sync page.
Format: the UKG Pro EmployeeId, exactly as UKG Pro stores it.
Example: DZOPMJ000050
The child address is captured with its parent, so there is no separate address identifier to enter — an address is refreshed by re-syncing its employee.
External ID Format
After a successful transfer, iPaaS.com saves the UKG Pro employee identifier as the external ID on a dedicated external-ID record. That record is the primary match for subsequent transfers, so re-transferring the same employee updates the existing iPaaS.com Employee rather than creating a duplicate.
The captured address is linked through the same parent employee identifier, because the UKG Pro home address has no independent identifier of its own.
Deleted Record Support
Outbound delete is not supported. The integration does not implement a delete operation for the employee entity, delete mappings are not included in the default templates, and removing or terminating an employee in UKG Pro does not propagate a delete to iPaaS.com.
An employee whose UKG Pro status moves outside the collection filter simply stops receiving updates; the existing iPaaS.com record remains in place.
Mapping Collection Status
Status: Enabled. The parent collection carries a filter that admits records rather than blocking them; the child collection has no filter.
Trigger Events: Scheduled poll of changed employees, and Manual Sync of an individual employee. This integration does not use webhooks or event-driven triggers, so there are no inbound event subscriptions to select.
Duplicate or Conflicting Mappings
No other mapping collection in this integration operates on the UKG Pro employee or its address, so there is no competing source of truth within the integration. Subscribers or their MiSP running a second integration that also writes iPaaS.com Employee records should decide which system is authoritative before enabling both.
Collision handling is not supported for this entity. Employees are matched solely by their external-ID link; duplicate detection and resolution options are not available on these collections.
Unmapped Field Overwrite Risk
iPaaS.com uses a full record replace when updating records. Fields that are not mapped are overwritten with empty values on every inbound transfer unless a mapping is added to preserve them.
Employee: PictureLink is not mapped.
Employee Address: Name and Address3 are not mapped.
To preserve a field that UKG Pro does not supply, split the combined Add/Update collection into separate Add and Update collections and add a Dynamic Formula mapping in the Update collection that carries the existing iPaaS.com value forward — for example, a formula of DestinationValue.PictureLink mapped to the iPaaS.com PictureLink field. This works for any field, including ones that originate in iPaaS.com and have no UKG Pro equivalent.
Supported Child Collections
Parent Collection: Add/Update UKG Pro Employee TO iPaaS.com
Add/Update UKG Pro Employee Address TO iPaaS.com: Captures the employee's home address into iPaaS.com as part of the parent employee transfer. It runs automatically with the parent capture, is never invoked standalone, and is linked through the parent employee identifier.
System Caveats
UKG Pro Caveats
Web service access must be enabled. The service account used by the integration needs access to the UKG Pro personnel and configuration web services so the integration can retrieve person, employment, compensation, and company records.
Employment status codes are UKG Pro values. The A and L codes the filter evaluates are UKG Pro employment status values. Subscribers or their MiSP changing the filter should use UKG Pro's own status codes.
Change detection is day-level. UKG Pro matches changed employees by date rather than by timestamp, so a poll retrieves everything changed on the relevant day. The integration narrows this to changes newer than the previous run, but a poll run more than once a day still examines a full day of records.
Rate limiting. When UKG Pro reports that too many requests have been made, the transfer stops and the affected employees are captured on a later run. No subscriber action is required, though a sustained pattern of rate limiting is worth raising with UKG.
Values transfer as stored. Country, region, postal code, and phone values are captured exactly as UKG Pro holds them, with no reformatting or translation applied.
A sparse address is still transferred. UKG Pro does not require an employee to have a complete address; employees with partial address data produce a correspondingly sparse iPaaS.com address rather than a failed transfer.
iPaaS.com Caveats
Email address is mandatory. iPaaS.com rejects an employee record whose email address is missing or empty. The transfer fails and the error appears in Dashboard / Integration Monitoring / Error Logs.
A name is mandatory. iPaaS.com requires at least a first name or a last name. Both are mapped by default, so the condition is met for any employee carrying either.
The child collection must be active for addresses to be captured alongside the employee.
A poll must be scheduled under Dashboard / Integration Monitoring / Events before any automatic capture occurs.
Integration-Specific Caveats
Home company determines eligibility. An employee may hold employment and compensation records across several UKG Pro companies. The integration selects the record flagged as the home company and evaluates the filter against its employment status. An employee whose home company cannot be determined does not satisfy the filter and is skipped.
Single address per employee. UKG Pro carries one home address inline on the employee record rather than as separate address records, so each employee produces exactly one iPaaS.com address. Work, mailing, and emergency-contact addresses are not captured.
No automatic dependency transfers. The transfer captures the employee and its address only. No other record type is created or transferred as a prerequisite.
Setup Requirements
UKG Pro Configuration
A service account with access to the personnel and configuration web services.
Employees intended for capture must carry an email address and an Active or Leave employment status on their home company.
iPaaS.com Configuration
Enter the service account credentials on the Subscription Settings page in the API Url, API Key, API Username, and API Password fields.
Schedule the poll under Dashboard / Integration Monitoring / Events so changed employees are captured on a recurring cadence. Until it is scheduled, employees are captured only by a Manual Sync.
Ensure both the parent and child mapping collections are active.
Authentication & Security
The integration authenticates to UKG Pro with the service account user name and password together with the customer API key. All three values are supplied through the subscription settings above. Using a dedicated service account rather than a named user account avoids password expiration and single-sign-on complications breaking the integration.
Integration Flow
A scheduled poll asks UKG Pro for employees changed since the previous run, or a subscriber initiates a Manual Sync for a single employee.
The employee's person record is retrieved from UKG Pro, providing name, email address, and the home address details used by the child collection.
The employee's employment records are retrieved and the home-company employment is identified.
The employee's compensation records are retrieved and the home-company compensation is identified. This supplies the employment status the collection filter evaluates.
The collection filter is applied. Employees whose home-company employment status is not Active or Leave are skipped and do not reach iPaaS.com.
The employee record is captured into iPaaS.com, and the child address is captured beneath it.
iPaaS.com saves the UKG Pro employee identifier as the external ID, so subsequent transfers update the existing record rather than creating a duplicate.
Mappings
Add/Update UKG Pro Employee TO iPaaS.com
iPaaS.com data type: Employee
Mapping Filter
HomeCompanyCompensation_EmplStatus == "A" || HomeCompanyCompensation_EmplStatus == "L"
Filter Description. The filter reads the employment status from the employee's home-company compensation record and admits only two values. An employee whose HomeCompanyCompensation_EmplStatus is "A" (Active) or "L" (Leave) passes the filter and is captured. Every other status — terminated, retired, or otherwise inactive — is skipped, and no record reaches iPaaS.com for that employee. Because the status is read from the home company record, an employee whose home company cannot be determined does not satisfy either branch and is also skipped. The filter produces no error message for a skipped employee; the record is simply not transferred. Note that the filter governs which employees are captured, not which are removed — an employee already in iPaaS.com whose status later changes stops receiving updates but is not deleted.
Description: Captures the UKG Pro employee's name and email address into the iPaaS.com Employee record.
Mapping Type | Source Field (UKG Pro) | Destination Field (iPaaS.com) | Description |
Field | FirstName | FirstName | Required unless LastName is populated. iPaaS.com rejects an employee record that arrives with neither a first name nor a last name. Both name fields are mapped by default, so the condition is met for any employee carrying either name. |
Field | LastName | LastName | Required unless FirstName is populated. The counterpart to FirstName. Leave both mapped so the condition is satisfied regardless of which name a given UKG Pro record populates. |
Field | EmailAddress | EmailAddress | Required. iPaaS.com rejects an employee record whose email address is missing or empty, and the rejection appears in the error log. Confirm email address is populated across the Active and Leave population before enabling the collection, or narrow the filter so employees without one are not selected. |
Add/Update UKG Pro Employee Address TO iPaaS.com
iPaaS.com data type: Employee Address
This child collection has no mapping filter; every address belonging to a captured employee is transferred with its parent. It runs as part of the parent employee capture and is never invoked standalone. Which employees produce an address is governed entirely by the parent collection's filter.
Description: Captures the employee's home address from the parent UKG Pro employee record into an iPaaS.com address. Every source reference reads from the parent record, because UKG Pro carries a single home address inline on the employee rather than as a separate address record. Dynamic formula field references use the UKG Pro field names exactly and are case-sensitive.
Mapping Type | Source Field (UKG Pro) | Destination Field (iPaaS.com) | Description |
Dynamic Formula |
| Address1 | Recommended. The primary street line of the captured address. iPaaS.com accepts an address record without it, so an employee with no street address on file still transfers. |
Dynamic Formula |
| Address2 | Optional. Apartment, suite, or unit detail, and empty for most employees. |
Dynamic Formula |
| City | Recommended. Part of a complete captured address, and relied on by any downstream process that groups or filters employees geographically. |
Dynamic Formula |
| Country | Optional. Stored exactly as UKG Pro supplies it and not translated. Subscribers or their MiSP whose downstream systems expect a specific country format should validate the values UKG Pro returns in a staging environment and add a Lookup Translation where a consistent format is required. |
Dynamic Formula |
| Region | Optional. The UKG Pro source field holds the state, which iPaaS.com stores in its more general Region field. No translation is applied. |
Dynamic Formula |
| PostalCode | Recommended. Part of a complete captured address. The value transfers exactly as UKG Pro holds it, including any extended format, with no padding or reformatting. |
Dynamic Formula |
| PhoneNumber | Optional. The home phone recorded against the employee's address, not a work or mobile number. The number transfers as UKG Pro holds it, with no reformatting. Subscribers or their MiSP who need a different number should remap this field to the appropriate UKG Pro source field. |
Error Handling
"Received a Too Many Requests response from UKG Pro. There is no indication when more requests might be accepted.": UKG Pro rejected a request because too many calls were made in a short period. The affected employees are captured on a later run. Resolution: no subscriber action is required. If the message recurs consistently, reduce the throttle values on the subscription settings so the integration paces its calls more conservatively, and raise the pattern with UKG if it persists.
Connection validation failure at transfer time: the integration validates its UKG Pro connection before each transfer, and surfaces the message UKG Pro returned. This most often means expired, changed, or insufficiently-permissioned service account credentials. Resolution: confirm the API Url, API Key, API Username, and API Password values on the Subscription Settings page, and confirm the service account still has access to the UKG Pro personnel and configuration web services. If the credentials are correct and the message persists, contact iPaaS.com Support at support@ipaas.com.
Employee rejected for a missing email address: iPaaS.com requires an email address on every employee record, so an employee without one fails to transfer. Resolution: populate the email address on the employee in UKG Pro, or narrow the mapping filter so employees without an email address are not selected for transfer.
Employee rejected for a missing name: iPaaS.com requires at least a first name or a last name. Resolution: populate at least one of the two on the employee in UKG Pro, and confirm both FirstName and LastName remain mapped on the collection.
Errors appear under Dashboard / Integration Monitoring / Error Logs.
Testing & Validation
Test Scenarios
Capture a new employee. Create an employee in UKG Pro with an Active status, a name, an email address, and a complete home address. Run a Manual Sync using the employee identifier and confirm an iPaaS.com Employee record is created with a child address.
Update an existing employee. Change the employee's last name and street address in UKG Pro, re-run the transfer, and confirm both changes propagate to the existing iPaaS.com record rather than creating a second one.
Verify required-field validation. Clear the email address on a test employee and attempt a transfer. Confirm the transfer fails and the error appears in the error log.
Verify the ID format. Run a Manual Sync using the documented employee identifier format and confirm the transfer succeeds.
Verify parent-child capture. Confirm that transferring an employee also produces exactly one iPaaS.com address, and that the address carries the street, city, region, postal code, country, and phone values from UKG Pro.
Verify filter behavior. Change a test employee's home-company employment status to a value other than Active or Leave, run the transfer, and confirm the employee is skipped. Confirm an employee already captured is not removed from iPaaS.com by this change.
Verify scheduled polling. With the poll scheduled, change an employee in UKG Pro and confirm the change is captured on the next poll without a manual sync.
Validation Checklist
Service account credentials are entered on the Subscription Settings page and the connection validates successfully.
The poll is scheduled under Dashboard / Integration Monitoring / Events.
Both the parent and child mapping collections are active.
Employees intended for capture carry an email address and at least one name in UKG Pro.
The mapping filter matches the subscriber's definition of which employees belong in iPaaS.com.
A decision has been made about the unmapped fields — PictureLink on the employee, Name and Address3 on the address — either accepting that they are cleared on every update, or adding mappings to preserve them.
Additional Notes
The following are not handled by these mapping collections:
Writing employees or addresses into UKG Pro. Both collections capture data out of UKG Pro into iPaaS.com; there is no outbound write path in this integration.
Deleting employees or addresses. Removal in UKG Pro is not propagated as a delete in iPaaS.com.
Compensation and employment detail as mapped data. Employment and compensation records are retrieved to determine the home company and employment status, but their fields are not mapped into iPaaS.com by the default template.
Address types other than the home address, including work, mailing, and emergency-contact addresses.
UKG Pro record types other than the employee and its home address.