Total Hours by Work Code Group

Definition: Returns total hours based on work code Group number or numbers in a period. Total Hours by Work Code Group may be zero.

Return value: Values of type Number

Source: Person Shift Assignment (Unchecked roster records), the Staffing Table (Checked roster records)

From: This field is required. It defines the start of the time frame in which to count work code occurrences. Enter a Date & Time value here.

Through: This field is required. It defines the end of the time frame in which to count work code occurrences. Enter a Date & Time value here.

Sorting: If this base rule is used for sorting in a List Target or a List, then people with a Work Code Group Hours equal to a zero return value are preferred (sorted to the top) over other candidates in an ascending sort; otherwise they are pushed to the bottom of the list in a descending sort.

* Denotes a required field

Arguments Value
Group Number(s)
  • <NULL>- Count all work codes.(Default value)
  • <INTEGER> - targets the specific work code group
  • 0- targets the work code from the list target used in the list strategy to fill the vacancy
*For day(s) of week
  • ALL - targets all days of the week (Default value)
  • SUNDAY, MONDAY, TUESDAY, WEDNESDAY,THURSDAY, FRIDAY, SATURDAY -- targets the corresponding day of the week. For example, select Sunday to count occurrences on Sundays, and so on.
*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
Respect Shift Break Hours
  • *FALSE- does not factor shift break hours.
  • TRUE - will factor shift break hours supplied by the target Shift of the staffing record. DEFAULT value.
*From and Through Target This area works with the Group Number(s) field; and used to further define which work codes within the associated Group to return based on the From & Through period provided.
  • CALENDAR - from and through fields target the start and end DATETIME of the staffing record. DEFAULT value. EXAMPLE: Suppose the shift is configured to start -23:00, 4, this means the shift started at 11PM yesterday and crosses midnight; however, this shift configuration shows the shift on the Roster today. Configuration Note: Using the CALENDAR option with the following configuration, FROM ##/##/#### THROUGH ##/##/####, means Fill By Rules will return work codes that show on the roster and have the same roster calendar date as the roster target date.
  • EXACT DATE TIME - from and through fields target the date and time of the staffing record exactly as indicated by the From and Through parameters. Only staffing hours inside the time period parameters are included. EXAMPLE: FROM:SUNDAY(-1)@01:00:00 and THROUGH: SUNDAY(1)@01:00:00; means a staffing record that ends at 2AM the previous Sunday would allocate 1 hour in the period because the period starts at 1AM. Additionally, a staffing record starting the next Sunday at 10PM and ending at 5AM would allocate 3 hours in the period because the period ends at 1AM.
  • COUNT STARTS IN PERIOD- from and through fields include the full set of staffing hours IF the start time falls inside the from and through period. EXAMPLE: Suppose the count starts in a monthly period. FROM: ##/01/####@00:00:00 and THROUGH: ##/../####@23:59:59; this means a staffing record totaling 4 hours, starting July 31st at 11PM and ending on August 1st at 3AM will allocate that entire staffing set of work code hours towards the July monthly period because the FROM hours of the staffing record started in the target period.
  • COUNT ENDS IN PERIOD- from and through fields include the full set of staffing hours IF the staffing hours end inside the time period. EXAMPLE: Suppose the count starts weekly... FROM:SUNDAY(-1)@00:00:00 and THROUGH: SUNDAY(1)@00:00:00; this means a staffing record totaling 4 hours starting the previous Saturday at 11PM and crossing midnight into the Sunday in period will allocate the full record of 4 hours towards the target weekly period because the record ended in the period. Conversely, a staffing record starting on Saturday at 11PM and crossing midnight into the next period’s Sunday will not be included in the target weekly period because the hours did not end in the period which is Sunday at midnight.