Consecutive Threshold Day By Work Code

Definition: Returns a number of consecutive days with a minimum hours per day threshold for each person. This rule evaluates a range of days and can be used to prevent fatigue before or after the target vacancy, but not limited to fatigue as this rule which counts days and work code hours can also be used to sort by consecutive days; for example, as a tie breaker sort by least number of consecutive days. Also - see Consecutive Threshold Day By Work Code Type which allows you to limit by Type such as Working, Nonworking rather than specifying each work code by gray number.

Return value: Values of type Number.

Source: Roster records both Checked and Unchecked.

From: This field is required. It defines the start of the time frame in which to look for the targeted records.

Through: This field is required. It defines the end of the time frame in which to look for the targeted records.

Sorting: Number sorting, ascending.

*An asterisk in the table below denotes a required field.

Arguments	Value (**Indicates Default)
*Threshold Hours	A number that is expressed in hours. If the sum of the hours on a day is greater than or equal to this number, then the day is counted. For example, suppose a person is fatigued if they work 4 consecutive days with a minimum of 16 hours each day. Then threshold hours is 16.
Work Code Gray Numbers	The gray number of the work code or work codes to consider for each person. <Null> - Count All Work Codes. <Integer> - targets work codes specified by their gray number 0 - Not supported
*Requires exceptions	This Argument exists to mitigate the (performance) expense of this base rule, if the situation permits. TRUE - indicates that ONLY the candidates still Qualified and Available in the list AND that have an Exception (checked Roster record) in the period (defined by From and Through) should be tested. This value minimizes the number of people being tested under the assumption that only the second (or greater) Exception in any period could cause someone to be fatigued. FALSE** - indicates that EVERYONE still Qualified and Available in the list should be tested. This value assumes that the first Exception in any period could cause someone to be fatigued.
Respect Shift Break Hours	Enables with WORKINGHOURSSUM and NONWORKINGHOURSSUM mode. FALSE- does not factor shift break hours. TRUE** - will factor shift break hours supplied by the target Shift of the staffing record.
*Attributes	This option looks at the attributes on the staffing record, this means a checked record. The plus + sign denotes with the following attributes. The minus - sign denotes without the following attributes. Multiple values are valid. Options are: IGNORE +ALL -ALL (Default value) +REQUEST -REQUEST +CHARGE -CHARGE +NOIMPACT -NOIMPACT +HIDDEN -HIDDEN +STILL AVAILABLE -STILLAVAILABLE For example, +Request considers in the count unapproved work codes listed by Gray Number.
*Proposed Too	YES - include this assignment’s working hours in the total (the assignment that they are about to get) **NO - do not include this assignment’s hours in the total
*From	Enables if the selected base rule requires a Dynamic Date. Using a Dynamic Date, this field defines the first date of a date range from which the Rule is to begin considering the Base Rule parameters. For example, suppose a person is fatigued if they work 4 consecutive days with a minimum of 16 hours each day. Example: Threshold hours is 16, From is TARGET-4days, and Through is TARGET+4days.
*Through	Enables if the selected base rule requires a Dynamic Date. Using a Dynamic Date, this field defines the end date of the date range from which the Rule is to consider through when considering the Base Rule parameters. For example, suppose a person is fatigued if they work 4 consecutive days with a minimum of 16 hours each day. Example: Threshold hours is 16, From is TARGET-4days, and Through is TARGET+4days.
Where	Used to indicate the number of consecutive days where the rule returns TRUE (trigger). For example, suppose a person is fatigued if they work 4 consecutive days with a minimum of 16 hours each day. Example: Threshold hours is 16, From is TARGET-4days, and Through is TARGET+4days, and Where is >=4 which indicates 4 consecutive days would be a violation at 4 or greater than 4. Note: This base rule seeks to return the highest number of consecutive days where x targeted hours are met for each person, WHERE is used to set your limit.
Unique Identifier	The application Internal ID.

Important: Review Base Rule Field Descriptions for additional field informations, such as Where, Pass Text, Build Moment.