Transfer Data for Integrations

Add or change interface session details from the Session Details page.

1. From the Manage Interfaces page, select Add or select an interface link in the Interface Description column. The Session Details page appears.
2. If you add a new interface session, complete the following tasks from the Session Details page:
   • Select a template option from the Template drop-down list.
   • Enter an interface session code up to 10 characters. Special characters such as a hyphen are permitted; spaces are not permitted.
   • Enter a description for the interface session.

   Important

   If you are using the UKG Pro Carrier Network (UCN), templates available for your UCN exports appear in the Template drop-down list. You can select any of the UCN templates to create an interface session for UCN exports.

3. If you change an interface session, only the description can be modified from the Session Details page. The Template and Code field values cannot be modified in an existing interface session.
   
4. Select Next.

Add or change interface session configuration information on the Setup page.

1. From the Session Details page, select Next. The Setup page appears.
2. Select the component companies that are included use the interface session.
   
3. Select the criteria used for this interface session from the Selection Criteria drop-down list. Selection Criteria includes organization levels 1 through 4, pay groups, locations, job codes, and projects as defined for your organization. You can also accept the default value of None.
   
4. In the Date Range section, enter a date range in the From and To fields.
5. In the Sequences Included section, when your criteria is by pay group select to use all sequences, a single sequence, or a sequence range to ensure that the regular and supplemental payrolls for the selected pay groups are accurately included in the export. If your criteria is not pay group, accept the default of All Sequences.
   

   Note

   Sequence numbers available are 1 through 9. Regular payrolls are assigned a sequence of 1. Supplemental payrolls, including adjustment payrolls, are assigned a sequence number from 2-9 as they are created.

6. Select Next.

Add or change scheduling information for each interface session from the Scheduling Information page.

1. From the Setup page, select Next. The Scheduling Information page appears.
2. Select the schedule frequency from the Schedule Type drop-down list. The Scheduling Information page updates with fields associated to the selected schedule type.
   • None - allows this interface session to be run as on-demand only as often as is desired from the Manage Interface page.
   • One-Time - allows this interface session to be scheduled to be run once. When the interface has run once as scheduled, on-demand access only is available unless the one-time schedule is modified. The Delivery Options section is not available. E-mail notifications to UKG Pro users are available for success and/or failure notifications.
   • Recurring - allows this interface session to be scheduled on a recurring basis. The Delivery Options section is available for delivery either via File Transfer or File Delivery (requires UKG Pro Data Exchange Services - UDES to be configured). E-mail notifications to UKG Pro users are available for success and/or failure notifications.

   
3. Enter a description for the schedule.
4. Select the data to export value from the Data To Export drop-down list and then, check the Include Run Day box, if applicable, in your Data To Export Value.
5. In the Schedule Frequency section, select the frequency for the interface session to run. The schedule frequency fields update based on the frequency selected. The day of month or month of the year may be required based on schedules for monthly or yearly frequencies.
6. Enter a start date.
7. Enter a time based. All times are based on Eastern Standard Time (EST) regardless of your organization's time zone.
8. Check the End Date box, if an end date is desired for this interface session.
   Note

   Be cautious when selecting an End Date value. Changing schedule type, schedule description, or any of the Schedule Frequency values creates a new schedule for the interface session with a new start date unless otherwise specified.

9. In the Delivery Options section, check the File Transfer box, and then select a recipient from the Recipient drop-down list. The recipient receives the scheduled export on the File Transfers page (Reporting > File Transfers).
10. Check the File Delivery box to automatically send the scheduled export via File Delivery. The export will be added to the Default Delivery Path defined in the session. Contact your support team to configure file delivery. This requires credentials information to deliver the export to a vendor.
11. In the E-Mail Notification section, select an e-mail notification option. All options, except the None option require you to select a user for e-mail notifications from the Notify User drop-down list. Users must have an e-mail in UKG Pro to receive e-mail notifications.
12. Select Next.

Review the information entered on the Summary page.

1. From the Summary page, review the information.
2. Select Back to return to the applicable page and make necessary changes.
3. Select Next to return to the Summary page.
4. Select Save.
5. View the new or changed interface session from the Manage Interfaces page.

Run interface session exports from the Run page.

1. From the Manage Interfaces page, select the Run icon for an interface session.
2. From the Run page, select the component companies to be used in the session export.
3. Select selection criteria from the Selection Criteria drop-down list.
4. Enter a date range.
5. Select to use all sequences, a single sequence, or a sequence range.
6. Select Run.