Schema Reference
The application schema is used to configure the objects returned from a connector.
Note
-
The Account Schema tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as Entitlement or Multi-Valued. Refer to Managing Source Account Schemas for more information.
-
The schema attributes that are not present by default must be defined as strings if not specified.
The UKG Pro Core HCM SaaS connector uses the following default correlation and object configurations.
The source schema is used to configure objects returned from the connector. When a connector is called, the schema is supplied to the methods on the connector interface. This connector currently supports the following objects:
- Account - Objects used when building identities' link objects.
Note
SailPoint does not recommend changing the value of the Account ID. The connector aggregation logic is based on the provided default value of the Account ID. Refer to Account ID for more information.
Default Correlation Configuration
Before you aggregate accounts from this source, you can map account attributes with their corresponding identity attributes based on your requirements.
You can customize the correlation configuration. Refer to Assigning Source Accounts to Identities for more information.
When you first create the UKG Pro Core HCM SaaS source, the default correlation mapping is:
| Account Attribute | Operation | Identity Attribute |
|---|---|---|
| emailAddress | Equals | Work Email |
| employeeId | Equals | Employee Number |
Default Account Schema
Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location.
The set of account attributes each source stores and how they're organized is known as the account's schema. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to Managing Source Account Schemas for more information.
Default Account ID
SailPoint requires that certain attributes remain in your configuration. These attributes are referred to as account IDs.
Caution
Changing the attribute marked as the account ID after aggregating accounts can result in duplicate accounts being created. To avoid this, either reset the accounts on this source before editing the account ID attribute or edit the account ID attribute before aggregating accounts.
To resolve issues caused by changing account IDs, reconfigure them to their default values.
The following table lists the default account IDs for this connector:
| Account ID | Schema Object Type |
|---|---|
| employeeId | Account |
Default Account Attributes
The UKG Pro Core HCM SaaS connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified.
The attributes listed on this page make up the default account schema in the UKG Pro Core HCM SaaS connector.
Note
The UKG Pro Core HCM SaaS connector can aggregate additional attributes in addition to the ones in the default account schema. For more information, refer to Aggregate Additional Employee Schema Attributes.
| Attribute Name | Description |
|---|---|
| employeeId | The employee's ID |
| firstName | The employee's first name |
| lastName | The employee's last name |
| fullName | The UKG API doesn't provide the employee's full name by default. If you want to aggregate the employee's full name as a single attribute, add a new schema attribute named fullName. The connector code returns the employee's full name formatted based on other name attributes as follows: <lastName> <suffix>.,<firstName> <middleName(first letter)>. For example, consider an employee whose name attributes are as follows: lastName - Shrader, suffix - Sr., firstName - Scott, middleName - Michael. When you aggregate the fullName attribute, the connector returns the following: Schrader Sr., Scott M. |
| preferredName | The employee's preferred name |
| emailAddress | The employee's primary email address |
| countryCode | The employee's work location country code |
| languageCode | The employee's work location language code |
| employeeNumber | The employee's employee number |
| personId | Person ID of the person data associated with the employee |
| userIntegrationKey | The employee's user integration key |
| companyName | The employee's home company name |
| companyId | The employee's home Company ID |
| supervisorId | The employee's supervisor ID |
| salaryOrHourly | Indicates the salary pay category for an employee |
| fullTimeOrPartTime | Indicates the work category; full time or part time |
| isActive | Boolean attribute which indicates if the employee is active in the system |
| workLocationCode | The employee's work location code |
| jobCode | The employee's primary job code |
| projectCode | The employee's assigned project code |
| orgLevel1Code | The employee's organization Level1 Code |
| orgLevel2Code | The employee's organization Level2 Code |
| orgLevel3Code | The employee's organization Level3 Code |
| orgLevel4Code | The employee's organization Level4 Code |
| middleName | The employee's middle name |
| workPhone | The employee's work Phone Number |
| homePhone | The employee's home Phone Number |
| employeeAddress1 | The employee's work location address 1 |
| employeeAddress2 | The employee's work location address 2 |
| city | The employee's work location city |
| state | The employee's work location state |
| zipCode | The employee's work location zip code |
| terminationDate | The employee's termination date |
| hireDate | The employee's hire date |
| supervisorName | The employee's supervisor's name |
| suffix | The employee's name suffix |
| prefix | The employee's name prefix |
| alternateEmailAddress | An alternate email address for the employee |
| gender | The employee's gender |
| employeeStatus | The employee status in the system |
| employeeType | Indicates the employee's employment type |
| emplStatusStartDate | The effective date of the employee's last employee status |
| dateInJob | The effective date in the employee's last job |
| dateOfLastHire | Date on which the employee was hired |
| jobGroupCode | The employee's primary job group code |
| alternateJobTitle | An alternate job title for the employee |
Aggregate Platform Configuration Fields
The UKG Pro Core HCM SaaS connector can aggregate platform configuration fields related to various classes during full and delta aggregation. The connector can aggregate fields related to the following classes:
- Address
- Person
- Employee
- PhoneNumber
- Employment
- Location
- Job
- OrgLevel1
- OrgLevel2
- OrgLevel3
- OrgLevel4
- Contacts
To aggregate platform configuration fields related to a specific class, add the user-defined attribute name to the UKG Pro Core HCM schema, and associate it with its class.
The syntax is as follows:
For example, to aggregate an Essential attribute under the Employee class, you add the following to the schema:
Note
To get a list of the platform configuration field names related to a specific class in the UKG Pro Core HCM system, add platformConf.<ClassName>.allFields to the account schema. By adding this attribute to the account schema, the source returns a list of all non-null platform configuration attributes in that class and their associated keys during aggregation. Use this list as a guide to help you add the platform configuration attributes to the account schema.
Important
If the class name is omitted (for example, platformConf.<field_name>) the fields related to the Employment class will be aggregated. This is to support backward-compatibility with earlier released versions. SailPoint recommends that you always add the class name to the schema attribute name for better readability.
Aggregate User-Defined Fields
The UKG Pro Core HCM SaaS connector can aggregate user-defined employee fields during full and delta aggregation. The connector aggregates the user-defined fields into the account schema.
User-Defined Personnel Fields
To aggregate user-defined personnel fields, add the user-defined attributes to the UKG Pro Core HCM schema with personnelUDF. set as the prefix for each one. The syntax is as follows:
For example:
Note
To get a list of the user-defined personnel field names in the UKG Pro Core HCM system, add personnelUDF.allFields to the account schema. Adding this attribute to the account schema returns a list of all user-defined personnel attributes and their associated keys during aggregation. Use this list as a guide to help you add the user-defined personnel attributes to the account schema.
User-Defined Company Fields
To aggregate user-defined company fields, add the user-defined attributes to the UKG Pro Core HCM schema with companyUDF. set as the prefix for each one. The syntax is as follows:
For example:
Note
To get a list of the user-defined company field names in the UKG Pro Core HCM system, add companyUDF.allFields to the account schema. Adding this attribute to the account schema returns a list of all user-defined company attributes and their associated keys during aggregation. Use this list as a guide to help you add the user-defined company attributes to the account schema.
User-Defined International Attributes
To aggregate user-defined international fields, add the user-defined attributes to the UKG Pro Core HCM schema with internationalUDF. set as the prefix for each one. The syntax is as follows:
For example:
Note
To get a list of the user-defined international field names in the UKG Pro Core HCM system, add internationalUDF.allFields to the account schema. Adding this attribute to the account schema returns a list of all user-defined international attributes and their associated keys during aggregation. Use this list as a guide to help you add the user-defined international attributes to the account schema.
Aggregate Additional Employee Schema Attributes
Aggregate additional, predefined employee attributes from the UKG Pro Core HCM SaaS connector. After aggregation, these attributes are added to the default employee schema attributes in the connector's account schema. The additional attributes you can aggregate are related to an employee's primary job configuration, organizational level, and location. The connector can aggregate properly configured attributes from the UKG Pro Core HCM schema.
Primary Job Functions
To aggregate an employee's primary job related details, create a primary job function attribute in the UKG Pro Core HCM schema by adding the attribute name with job. as the prefix. The syntax is as follows:
The following primary job related functions are supported:
Note
The prefix and user-defined schema attribute name are case-sensitive.
| Serial Number | Job Detail | Corresponding User-Defined Schema Attribute | Type |
|---|---|---|---|
| 1 | jobCode | job.jobCode |
string |
| 2 | countryCode | job.countryCode |
string |
| 3 | title | job.title |
string |
| 4 | isActive | job.isActive |
Boolean |
| 5 | jobFamilyCode | job.jobFamilyCode |
string |
| 6 | longDescription | job.longDescription |
string |
| 7 | jobEEOCategory | job.jobEEOCategory |
string |
| 8 | jobGroup | job.jobGroup |
string |
| 9 | flsaTypeCode | job.flsaTypeCode |
string |
Organization Level
To aggregate an employee's organization level (½/¾) details, create an organization level attribute in the UKG Pro Core HCM schema by adding the attribute name with orgLevel<level>. as the prefix. Replace <level> with the employee's actual organizational level. The syntax is as follows:
For example:
The following organization level related attributes are supported:
Note
The prefix and user-defined schema attribute name are case-sensitive.
| Serial Number | Organization Level Detail | Corresponding User-Defined Schema Attribute | Type |
|---|---|---|---|
| 1 | budgetGroup | orgLevel<level>.budgetGroup |
string |
| 2 | code | orgLevel<level>.code |
string |
| 3 | currentYearBudgetFTE | orgLevel<level>.currentYearBudgetFTE |
string |
| 4 | currentYearBudgetSalary | orgLevel<level>.currentYearBudgetSalary |
string |
| 5 | description | orgLevel<level>.description |
string |
| 6 | glSegment | orgLevel<level>.glSegment |
string |
| 7 | isActive | orgLevel<level>.isActive |
Boolean |
| 8 | lastYearBudgetSalary | orgLevel<level>.lastYearBudgetSalary |
string |
| 9 | level | orgLevel<level>.level |
string |
| 10 | levelDescription | orgLevel<level>.levelDescription |
string |
| 11 | reportingCategory | orgLevel<level>.reportingCategory |
string |
Work Location
To aggregate an employee's work location details, create work location attributes in the UKG Pro Core HCM schema by adding the attribute name with workLocation. as the prefix. The syntax is as follows:
The following work location related attributes are supported:
Note
The prefix and user-defined schema attribute name are case-sensitive.
| Serial Number | Work Location Detail | Corresponding User-Defined Schema Attribute | Type |
|---|---|---|---|
| 1 | locationCode | workLocation.locationCode |
string |
| 2 | description | workLocation.description |
string |
| 3 | isActive | workLocation.isActive |
Boolean |
| 4 | addressLine1 | workLocation.addressLine1 |
string |
| 5 | addressLine2 | workLocation.addressLine2 |
string |
| 6 | city | workLocation.city |
string |
| 7 | state | workLocation.state |
string |
| 8 | zipOrPostalCode | workLocation.zipOrPostalCode |
string |
| 9 | countryCode | workLocation.countryCode |
string |
| 10 | locationGLSegment | workLocation.locationGLSegment |
string |
Employment
To aggregate an employee's employment details, create employment related attributes in the UKG Pro Core HCM schema by adding the attribute name with employmentDetails. as the prefix. The syntax is as follows:
The following employment related attributes are supported:
Note
The prefix and employment schema attribute name are case-sensitive.
| Serial Number | Employment Detail | Corresponding User-Defined Schema Attribute | Type |
|---|---|---|---|
| 1 | leaveReasonCode | employmentDetails.leaveReasonCode |
string |
| 2 | leaveReasonDescription | employmentDetails.leaveReasonDescription |
string |
| 3 | companyCode | employmentDetails.companyCode |
string |
| 4 | workPhoneExtension | employmentDetails.workPhoneExtension |
string |
| 5 | workPhoneCountry | employmentDetails.workPhoneCountry |
string |
| 6 | jobChangeReasonCode | employmentDetails.jobChangeReasonCode |
string |
| 7 | supervisorFirstName | employmentDetails.supervisorFirstName |
string |
| 8 | supervisorLastName | employmentDetails.supervisorLastName |
string |
| 9 | isMultipleJob | employmentDetails.isMultipleJob |
string |
| 10 | termReason | employmentDetails.termReason |
string |
| 11 | terminationReasonDescription | employmentDetails.terminationReasonDescription |
string |
Documentation Feedback
Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.