Common Configurations

This topic covers some common configurations in Integration Studio.

Return Contact Information from Contacts Array

The Employee Bulk API includes the Contacts array which, by default, includes all phone and email addresses stored in the Contact Information section of the People record. To return a single item from the Contacts array, you need a unique identifier to map the appropriate record.

Home Phone

Screenshot of the Home Phone field in the mapping step.

When the field is mapped to Contacts > Items > ContactNumber, you can configure a Choose Record filter on the ContactInformationType XRefCode.

Screenshot of the Choose Record for Home Phone dialog box.

Business Email

Screenshot of the Business Email field in the mapping step.

Similar to the choose record configuration for the HomePhone field, you can limit the specific Electronic Address returned by using the ContactInformationType XRefCode.

Screenshot of the Choose Record for Business Email dialog box.

Important: The Pick from list sorted newest to oldest and Pick from list sorted oldest to newest operators will not identify a unique record if the field being sorted is not unique. For example, if an employee has two business email addresses that are added at the same time, the Choose Record configuration sorts all email addresses by last modified date and then picks the first. In this example, both email addresses meet the specified criteria so the integration would fail because multiple elements matched in the array.

Return Contact Information from Emergency Contacts Array

The Employee Bulk API also includes the EmergencyContacts array which, by default, includes the name for each emergency contact stored in the Emergency Contacts section of the People record. Nested within the EmergencyContacts array is another Contacts array, which includes the phone numbers and email addresses for each emergency contact.

To return a specific phone number for a specific emergency contact, you need two unique identifiers:

A unique identifier to select the appropriate contact record.
A unique identifier to select the appropriate emergency contact

Screenshot of the Primary Emergency Contacts Home Phone field in the mapping step.

For example, the Choose Record filter configured below returns the HomePhone Number of the Primary Emergency Contact in the Primary_EC_HomePhone field. First, you must limit the items in the Contacts array by the ContactInformationType XRefCode:

Screenshot of the Choose Record for Primary Emergency Contacts Home Phone dialog box.

Then, click Next to limit the items in the EmergencyContacts array by the IsPrimary field:

Screenshot of the Choose Record for Primary Emergency Contacts Home Phone dialog box for the IsPrimary field.

Return Address Information from Emergency Contacts Array

Dayforce employees can have multiple emergency contacts and each emergency contact could have multiple addresses. So, two layers of Choose Record filters are required to return address information for a primary emergency contract, even if each emergency contact only has a single address.

Screenshot of the Emergency Contacts Postal Code field in the mapping step.

First, you must configure a Choose Record filter to confirm that the address record exists:

Screenshot of the Choose Record for Primary Emergency Contacts Postal Code dialog box.

Then, click Next to limit the items in the EmergencyContacts array by the IsPrimary field:

Screenshot of the Choose Record for Primary Emergency Contacts Postal Code dialog box for the IsPrimary field.