Roster Export Task Properties Field Desc.

The following is a description for each of the available properties when using Roster export task types. Not all fields are available as each export task type contains a variation of the fields below; only relevant fields enable for each task type. The fields in the table below can be used to reference Roster export task type fields.

Note:

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

Field	Roster Export 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.
Send Only Changes	Select to include only roster records that have changed since the last query. If unchecked, the task will include changed and non-changed roster records since the last query. Application Behavior: When Send Only Changes is checked (TRUE) the application will send all of the data for the day initially as the first run brings the initial set of records that will be utilized for change comparison in subsequent runs. If changes are found for this task type a file will be created. If no changes are found no file is created for that run.¹
Payroll Information Only	Select to export roster records for personnel who have a payroll ID defined in the application and roster work codes associated with a payroll code in Setup.
Include Removed Records	Select to include removed records from the Roster for the target date or period.
Include Request Records	Select to include work code requests from the Roster for the target date or period.
Use Institution Timezone	Applicable to Institution Focus (I/F) database environments: When I/F is turned off, this check box has no effect on the results. The time in the output is the default time for all records regardless of institution. When I/F is turned on, and Use Institution Timezone check box is selected, then the dates of the record are formatted in the record's institution's time zone. This means, if one export contains records from two institutions with two different time zones, the records display their institution's timezone.
(Re)Send Changed	Select to send unsent roster records or resend roster record changes since the last query 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 holds the desired shift. For example, suppose that you have two shifts, one starts at 7:00 AM, Shift 1 and the other shift starts at 8:00AM, Shift 2. Wait for Shift Start is set to -60. The task’s schedule is set to run at 6AM daily. The task will filter out the records for Shift 2 and export only the records for Shift 1.
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. If this check box is cleared, the task will return both working and non-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.
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	Used to redefine the application ‘working’ type work code abbreviation. The text typed in as the property value will be the text used for all working type work codes in the export instead of the actual work code abbreviation.
Non-Working Code Override	Used to redefine the application ‘non-working’ type work code abbreviation. The text typed in as the property value will be the text used for all non-working type work codes in the export instead of the actual work code abbreviation.
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.
Format*	Select either CSV or XML. This property is required. Note: CSV is not supported for Roster Export type task released in version 7.1.8+, and 7.2.1+.
Overwrite Existing File	Select to override an export file in the target export directory having the same name. If blank, this value is assumed False.
Transform File Using Templates (.ftl)	Used to transform files using templates (.ftl) for specific rosters such as ROS08, ROS04. Also, used in the Roster Export task type released in version 7.1.8, and 7.2.1 to point to a custom roster export template in ...integration\templates.
Generate according to change settings (unchecked sends entire Roster)	Used to export roster records including changed and/or full roster records for the target period - by task run. Default exports the full roster. Default is unchecked. Select to process and export roster differences. (Re)Send Changed must be checked to send unsent (or resend changed) roster(s) within the target period. Application Behavior: When process roster differences is initiated, the application will send all of the data for the day initially as the first run brings the initial set of records that will be utilized for change comparison in subsequent runs. If this setting is checked and changes are found for this task type a file will be created. If no changes are found a file may be created without records because no records were found. Additionally, if this property is not checked, and Send Only Changes and (Re)Send Changed are checked, then the file will contain only changed records, not the full roster. This property unlike Send Only Changes allows a user to send a file and switch between send differences or send full roster by task run. NOTE: This property is applicable to the "Roster Export" task only which is available as of application version 7.1.8+, and 7.2.1+.