Workforce Ready Roster Export to Employee Schedules Task Type Field Desc.

The following is a description for each of the available properties when using WFR Roster Export to Employee Schedules task type; available as of version 6.6.
IMPORTANT
Workforce Ready Basic Scheduler limits two staffing records per day. This task does not support integrations where employees could potentially exceed the two records per day limit. This application supports multiple work code records for a single person per day. If a person returns more than two work code records for the same day the Task Manager will not send any staffing record information for that person to Workforce Ready. The Activity log will show an alert, noting the person and day in violation. Additionally, it is very important to correctly configure both applications to schedule and pay employees prior to the integration in all use cases. All employees must be mapped in both applications. WFR options are Account ID or Employee ID. Options for this application are: Employee ID, External ID, and Payroll ID. These fields are located in the person General tab. If you do not map an employee then time entries for that employee will be blank, and an error will be logged in the activity log. Careful consideration between WFR cost centers and staffing record data in this application is required to proceed without issues. All cost centers and people identifiers must be mapped before starting this task.
Field WFR Roster Export to Employee Schedules Task Field Descriptions
From* This required field indicates the starting date of the Roster build or the first day of the target period.
Through* This required field indicates the ending date of the Roster build or the last day of the target period.
 
Note:

The date can be defined as either a constant date, such as 3/25/2014 or as a Dynamic Date, such as TODAY-1day. A separate file will be sent for each day within a date range.

Payroll Information Only Select to export roster records for personnel who have a payroll ID defined in this application, and Roster work codes associated with a payroll code in Setup.
Include Request Records Select to include work code requests from the Roster for the target date or period.
Wait for Shift Start Select to send roster records until the target shift(s) selected in Shifts have started.
  • Positive values represent minutes AFTER the shift start; for example, type 60 to indicate 60 minutes AFTER the shift starts.
  • Negative values represent minutes BEFORE the shift start; for example, type -60 to indicate 60 minutes BEFORE the start of the shift.
  • A zero value indicates ‘at shift start time”.
  • If the property is left blank, the property is ignored; the task will not wait for the shift(s) start.
  Example: This setting must correlate with the selected shifts in the Shifts table and the schedule you create must be defined so that the task Run contains the desired shift or shifts. For instance, suppose that you have two shifts, Shift 1 starts at 7AM, and Shift 2 starts at 8AM. The task’s schedule is set to run at 6AM daily and 7AM...
  • “Wait for Shift Start” is set to -60 minutes. At 6AM the task will export records for Shift 1 because 7AM minus 1hour is 6AM. At 7AM the task will export records for both Shift 1 and Shift 2, Shift 1 has already started and Shift 2 meets the 7AM shift start because 8AM minus 1 hour is 7AM.
  • “Wait for Shift Start” is set to 60 minutes. At 6AM the task will export zero records, Shift 1 started at 7AM but Wait for Shift Start is set to plus one hour which is 8AM. At 7AM the task will export zero records because Shift 1 starts at 7AM but we said to wait one hour after the shift start which is 8AM.
Include All Shifts Select this setting to include all shift assignments on the Roster for the target date. Recommended setting.
  Example: Suppose that on the target date Shift A is running, and a person assigned to work Shift B is working a special assignment during Shift A’s run, causing a person on Shift B to display on Shift A’s roster day. If this check box is selected the task will export the record for the person assigned to a different shift other than the target shift. If the check box is cleared the task will ignore the record.
Export Working Only Select to only export work code records of type working and regular duty. If this check box is cleared, the task will return working, regular duty, andnon-working type work code records.
Shifts Select the Shifts to be included in the export for the target Roster date. If the check box is cleared the export will include all shifts for the target Roster date. For example, suppose that only Shift A and C were selected, the task runs on a date that Shift B is active, the task will not return Shift B data because Shift B was filtered out. Additionally, suppose that Include All Shifts was selected, this task will return any Shift A or Shift C personnel records working on a Shift B Roster day.
Regions Select the regions to include in the export. Clear all or select all check boxes to include all regions.
Institutions Select the institutions to include in the export. Clear all or select all to include all institutions.
Remove Scheduled Records This property allows you to excluded scheduled records (example RecordType=-1) from inclusion in the export file. Warning: A scheduled record may still appear in the export file if no other record representing that same person exists AND if Include removed records=True. These removed, scheduled records indicate that a scheduled person has been removed without an explanation (for example, a leave code).
Validation Only (No Export) Select this check box to validate and identify cost centers to be sent that do not exist in Workforce Ready (WFR). You must validate cost center mapping before the actual export API call is made to avoid failures.


For example, suppose that Cost Center 3 contains nine job titles in this application and in WFR. A tenth job title is added to this application, but not referenced in WFR. An exported record from this application using the tenth job title and Cost Center 3 reference value will cause an export failure in WFR.