Skip to content

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 Ceridian Dayforce HCM connector uses the following default correlation and object configurations.

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 Ceridian Dayforce HCM source, the default correlation mapping is:

Account Attribute Operation Identity Attribute
Business Email Equals Work Email
Employee Number Equals Employee Number
Display Name Equals Name

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
Employee XRefCode Account

Default Account Attributes

The Ceridian Dayforce HCM connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified.

Attribute Name Description
Employee XRefCode Reference code for the employee.
Technical Path: XRefCode
EmploymentStatusXRefCode Reference code for the employee's employment status. To aggregate the EmploymentStatusXRefCode attribute, you must add the customEmployee attribute to the source configuration using the SailPoint REST API. For example:
[
{
"op": "add",
"path": "/connectorAttributes/customEmployeeStatus",
"value": [
"Leave_Of_Absence",
"CROSS_BORDER",
"Leave_Of_Absence_Paid"
]
}
]

Note - For more information on SailPoint's REST APIs, refer to Best Practices: REST API Authentication and REST API - Update Source (Partial) in the SailPoint Developer Community.
Technical Path: EmploymentStatusXRefCode
Employee Number The account's employee number.
Technical Path: EmployeeNumber
Eligible For Rehire Indicates if the employee is eligible to be rehired; true or false.
Technical Path: EligibleForRehire
Common Name The employee's common name.
Technical Path: CommonName
Home Organization The employee's home organization.
Technical Path: HomeOrganization.LongName
Federated Id Unique identifier for the employee's SSO login information.
Technical Path: FederatedId
Hire Date Date that an employee was hired; may be a rehire date.
Technical Path: HireDate
New Hire Approved Indicates if a new hire has been approved for employment; true or false.
Technical Path: NewHireApproved
New Hire Approval Date Date that a new hire was approved.
Technical Path: NewHireApprovalDate
New Hire Approved By Indicates the source of the new hire's approval.
Technical Path: NewHireApprovedBy
Original Hire Date The employee's original start date.
Technical Path: OriginalHireDate
Start Date The employee's start date.
Technical Path: StartDate
Pre Start Date The date that the employee can access the Ceridian Dayforce application prior to their start date.
Technical Path: PreStartDate
Login ID The employee's login ID.
Technical Path: LoginId
Display Name The employee's display name.
Technical Path: DisplayName
First Name The employee's first name.
Technical Path: FirstName
Last Name The employee's last name.
Technical Path: LastName
Employee Termination Date The employee's termination date.
Technical Path: TerminationDate
Employment Status Lists the employee's employment status descriptions i.e. leave of absence, retired
Technical Path: EmploymentStatuses.Items[*].EmploymentStatus.XRefCode
Employment Type Designates if an employee is a contractor or a pensioner.
Technical Path: EmploymentTypes.Items[*].EmploymentType.XRefCode
Business Email The employee's business email address.
Technical Path: Contacts.Items[?(@.ContactInformationType.XRefCode =="BusinessEmail")].ElectronicAddress
Business Phone The employee's business phone number.
Technical Path: Contacts.Items[?(@.ContactInformationType.XRefCode =="BusinessPhone")].ContactNumber
Business Phone Country Code The country code for the employee's business phone number.
Technical Path: Contacts.Items[?(@.ContactInformationType.XRefCode =="BusinessPhone")].Country.XRefCode
Location The employee's location.
Technical Path: Locations.Items[?(@.IsPrimary ==true)].Location.ShortName
Position The employee's position. By default, WorkAssignments details of location are marked as primary.
Technical Path when Aggregate Primary Employment is unchecked: WorkAssignments.Items.[0].Position.ShortName
Technical Path when Aggregate Primary Employment is checked: WorkAssignments.Items.[?(@.IsPrimary ==true)].Position.ShortName
Work Location The employee's work location.
Technical Path: WorkAssignments.Items.[0].Location.ShortName
Department The employee's department name, i.e. Accounting, Customer Service
Technical Path: WorkAssignments.Items.[0].Position.Department.LongName
Job XRefCode The Job's reference code.
Technical Path: WorkAssignments.Items.[0].Position.Job.XRefCode
Job Name The employee's job name.
Technical Path: WorkAssignments.Items.[0].Position.Job.ShortName
JobRank The employee's job rank.
Technical Path: WorkAssignments.Items.[0].Position.Job.JobRank
Job EmployeeEEO The employee's EEO category descriptions; i.e. Professional, Technician
Technical Path: WorkAssignments.Items.[0].Position.Job.EmployeeEEO.ShortName
Job Classification The employee's information on Job classifications; i.e. Sales, Marketing
Technical Path: WorkAssignments.Items.[0].Position.Job.JobClassification.ShortName
Job FLSAStatus Long name for a FLSA status; i.e. Exempt, non-exempt
Technical Path: WorkAssignments.Items.[0].Position.Job.FLSAStatus.XRefCode
Manager XRefCode The employee reference code of the employee's manager.
Technical Path: EmployeeManagers.Items[*].ManagerXRefCode
Manager FirstName The employee's manager's first name.
Technical Path: EmployeeManagers.Items[*].ManagerFirstName
Manager LastName The employee's manager's last name.
Technical Path: EmployeeManagers.Items[*].ManagerLastName
Role XRefCode The employee's Role reference code.
Technical Path: Roles.Items[*].Role.XRefCode
Role Name The employee's Role name.
Technical Path: Roles.Items[*].Role.ShortName
Organization Unit Name The name of the employee's Organization Unit.
Technical Path: OrgUnitInfos.Items[?(@.OrgUnitDetail.IsPrimary ==true)].OrgUnitDetail.ShortName

Additional Customer Configurable Attributes

The following additional attributes are available for the Ceridian Dayforce HCM source:

Attribute Name Description
BirthDate The employee's birthdate.
Technical Path: BirthDate
BioExempt Indicates if the employee is exempt from biological breaks; true or false.
Technical Path: BioExempt
Gender Identifies the employee's gender.
Technical Path: Gender
MaritalStatus Information on the employee's marital status code. This attribute links an employee and a marital status description. Use with the Marital Status entity to get employee marital status detail.
Technical Path: MaritalStatuses.Items[0].MaritalStatus.XRefCode
Address The employee's street address.
Technical Path: Addresses.Items[0].Address1
City The employee's city.
Technical Path: Addresses.Items[0].City
State The employee's state.
Technical Path: Addresses.Items[0].State.XRefCode
PostalCode The employee's postal code.
Technical Path: Addresses.Items[0].PostalCode
Country The employee's country.
Technical Path: Addresses.Items[0].Country.XRefCode

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.