Finally, you can schedule when this integration runs.
You can create a friendly name for your integration that you can view on the Background Jobs screen in System Admin > Background Jobs. To create a friendly name for your integration, you must select At a specific time from the Trigger drop-down list. In the Schedule Parameters section, click the Auto-generate Friendly Schedule Name switch. The Friendly Schedule Name field is prepopulated with an integration name that adheres to the following structure: <ShortName> - <Reference Code> (IntStudio). If needed, you can delete the contents of the Friendly Schedule Name field and enter your own unique integration name.
By default, the Trigger drop-down list is set to No Schedule. If left in this state, you can run the integration on an ad hoc basis, but it will never generate without user action. If you want the integration to run on a regular basis, select At a specific time, expand Schedule Parameters, and configure the schedule using the same options that are available when scheduling background jobs in System Admin > Background Jobs.
For example, to schedule the integration to run every weekday in Integration Studio, set the Frequency field to Weekly, set the Recurrence field to Every 1 Week, and select each weekday in the Day(s) of Week field.
You can also choose to run your integration on custom dates. To configure your integration to run on custom dates, you must select Custom from the Frequency drop-down list in the Schedule Parameters section that is shown when you select At a specific time from the Trigger drop-down list. Click Edit Dates and then create your custom dates in the Edit Custom Schedule screen that opens.
Important: A maximum of 100 custom dates can be scheduled and all dates are shown in the your preferred time zone.
In addition, you can configure your integration to run based on pay calendar dates. First, you must select Dayforce Calendar from the Frequency drop-down list and then configure the Pay Group, Calendar date type, Days Offset and Time of Day fields. Click View Dates in the Schedule Parameters section to view and update the scheduled pay calendar dates.
Important: After pay calendars are edited or regenerated, you must manually update the integration schedule by opening and saving the integration. If you don’t update the integration, it won’t run even when additional pay calendars have been generated.
Prevent Scheduled Integrations from Running When the Data Gate is Closed
You can prevent a scheduled integration from running when the reference pay group's data gate is closed. This ensures that data is not processed during payroll data gate closure windows, helping you avoid integration failures or data inconsistencies.
When you select At a specific time in the Trigger drop-down list, the following fields are shown in the Job Parameters section:
| Field | Description |
|---|---|
|
Stop Execution when Data Gate is Closed |
Enable this switch to prevent the integration from running or transmitting data when the scheduled date falls within the data gate closure window. |
| Reference Pay Group | Select the pay group whose data gate open and close dates are evaluated to determine whether the integration is allowed to run as scheduled. This field is only shown when you enable the Stop Execution when Data Gate is Closed switch. |
The Integration Log screen shows messages specific to data gate activity. You can easily identify issues with pay group and pay calendar configurations without interrupting scheduled integrations when data gates are missing.
Note: The data gate check applies only to scheduled integrations. It doesn’t apply to integrations that are run manually (ad hoc) or integrations that can’t be scheduled (for example, inbound integrations).
When you save the integration, you can go to the Integration Studio landing page to view the status of the background job, view background job details such as job logs, and run the integration manually. Running the integration manually doesn’t impact the schedule configuration.
The information that you see in Integration Studio on the background job status and background job details is also available in System Admin > Background Jobs > Scheduled Jobs and Job Logs, respectively.
Important: You can configure Dayforce to send you a notification when an integration completes with errors or when an integration does not complete successfully. To receive notifications regarding the status of an integration, you must subscribe to the Integration Studio - Integration Errors notification in the Subscriptions tab in System Admin > System Notifications and you must also set your notification preferences in the Channels tab.
Note: To ensure optimal performance of your integrations, avoid scheduling integrations less than an hour apart, and use delta options whenever possible.
For more information about background jobs and job logs, see Background Jobs Configuration in the Dayforce Implementation Guide.