Overview
The UKG Pro integration provides a ready-made function you can call when building mappings. It converts a UKG Pro company ID into its company code, so you do not have to write that lookup yourself in a formula.
Where you can use these functions
These functions are available anywhere you write a formula for the UKG Pro integration:
Dynamic Formula mappings: where a destination field's value is produced by a formula rather than mapped directly from a source field.
Mapping collection filters: where a formula decides whether a record should be processed.
Error filters: a mapping collection's error filter, which sits alongside its collection filter. When the error filter's formula resolves to true, the transfer raises an error that is held in the Error Logs for review and is not retried automatically.
Translation collections: where a translation entry uses a formula as its source value.
How to use them
Call a function by name and pass the values it needs in parentheses, for example:
ConvertCompanyIdToCompanyCode(SourceCompanyId).Each function's signature shows its name, the parameters it accepts (with their types), and the type of value it returns. Use it as the reference for exactly how to call the function.
Function names and formula syntax are case-sensitive, so type each name exactly as shown. Whether the values a function matches are treated as case-sensitive varies by function, and is called out in the relevant parameter's description.
This function is synchronous, so you call it directly (no
awaitis required).The function runs at sync time, against the data in your connected UKG Pro account and your iPaaS.com subscription.
The functions are grouped below by the area of the integration they support.
Companies
ConvertCompanyIdToCompanyCode
What it does: Looks up a UKG Pro company by its ID and returns that company's code.
Signature: string ConvertCompanyIdToCompanyCode(string companyId)
How to call it: ConvertCompanyIdToCompanyCode(companyId)
Parameter | Type | Required | Default | Description |
|
| Yes | N/A | The UKG Pro company ID to look up. It must match a company in the connected UKG Pro account. |
Returns: string. The UKG Pro company code for that company ID, or null if no matching company is found.
Example: "12345" returns the company code for the UKG Pro company with that ID.
When to use it: Use this when a mapping has a UKG Pro company ID but a field needs the company code instead.