WFC03 Task Properties

The following is a description for each of the available properties when using Roster and Time and Labor 11 (TnL11) export task types. Not all fields are available, each export task type contains a variation of the fields below; only relevant fields enable for each task type.

NOTE: Suggested properties are selected by default for each export task - except for Replicated Records, please review this field description carefully to determine whether the default behavior in application version 2x will meet your criteria in application version 5 and subsequent versions, or whether changing this setting to False may be the desired outcome.

The asterisk (*) next to the field name in the table below denotes a required field.

Field	WFC03 Descriptions
From*	The first day of the target period.
Through*	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.
Extra Days Beyond Period*	This required field returns all the blueprint records for the original date range in the From and Through parameters plus the extra day buffer on either side of the range. No blueprint records beyond the extended buffer will ever be searched, even if a record has a calendar or start date which references an adjacent record, otherwise the system could get stuck in an endless loop returning records that point to a previous day ad infinitum.
Send Only Changes	Select to include only blueprint records that have changed since the last query. If unchecked, the task will include changed and non-changed blueprint records since the last query. In an application version prior to 6.6, if Send Changes Only is selected, then only changed staffing records are sent. This does not include adjoining staffing records with the same blueprint date within the extra days period. As of application version 6.6, Send Changes Only sends changed staffing records along with adjoining staffing records that have the same blueprint date, and within the extra days parameters. Note: Technical observation, it is possible to have adjoining records that appear to fall within the extra days parameter but actually have different start dates that fall beyond the extra days period. When in doubt verify the start date of the staffing record.
Payroll Information Only	Select to export blueprint records for personnel who have a payroll ID defined in this application, and blueprint work codes associated with a payroll code in Setup.
Include Removed Records	Select to include removed records from the blueprint for the target date, or period.
Include Request Records	Select to include work code requests from the blueprint for the target date, or period.
Use User’s Home Institution Time Zone	Select to use the user’s home institution time zone this means any record outside the home institution time zone will be converted to match the user’s home institution time zone. Clear this check box to use the target institution’s time zone, this means all records are set to match the target institution’s time zone.
(Re)Send Changed	Select to send unsent blueprint records or resend blueprint record changes since the last query for the target date, or period.
Wait for Shift Start	Select to send blueprint records until the target shift 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 -60to 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 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 1 hour 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 blueprint 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 blueprint calendar date. 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, and non-working type work code records.
Shifts	Select the Shifts to be included in the export for the target blueprint calendar date. If the check box is cleared the export will include all shifts for the target blueprint calendar 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 blueprint calendar date.
Region	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.
Working Code Override	Redefines the ‘working’ type work code abbreviation. The text typed in as the property value replaces the abbreviation for all working type work codes in the export.
Non-Working Code Override	Redefines a ‘non-working’ type work code abbreviation. The text typed in as the property value replaces the abbreviation for all non-working type work codes in the export.
Remove Scheduled Records	Exclude scheduled records (example) RecordType=-1from inclusion in the export file. However, 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, such as a leave code.
File Name Prefix	The prefix used with the file name default format. If not defined only the default format of ‘yyyy-mm-dd’ will be used.
Export Format*	Either CSV or XML. This property is required.
Overwrite Existing File	Overrides an export file in the target export directory having the same name.
Append Execution Date and time to Filename Prefix	References the file by date and time; pertinent when running this task several times the same day.
Include CSV Headers	Includes column headers in the CSV file.
Include Replicated Records	Replicated records are typically non-working work code records that are bound to a different location on the calendar date than a user's shift assignment position. This is by design to show supervisors when user’s are not working their shift assignment due to an exception, like Sick. Replicated records scenario: The user’ shift assignment is Position A (pin A), the user is moved to Position B (checked record, pin B), then the user is given an exception code (Sick code added, checked record, pin B, source record pin A), the exception code (Sick) is replicated back to their original position (pin A), the Sick code shows instead of the shift assignment record so the person shows a sick code in position A and position B which results in the user’s record being replicated to numerous places on a calendar date. (Excludes exception codes using Pin to inserted location work code setup properties logic). Version 5 and subsequent versions of the application appropriately implements the inclusion of replicated records as follows: TRUE - returns source and replicated records. FALSE - returns source records and excludes replicated records. Application version 2 implements the inclusion of replicated records as follows: TRUE - replicated records are not included. Returns the source record that is being replicated. FALSE - replicated records as well as the source record that is being replicated are all excluded.