Arrange Break Rule
Note: With the 5.0.5.1 release, an enhanced version of this rule, the Assign Breaks Rule, was
introduced. We recommend that you review the enhanced rule before configuring the Arrange
Break Rule. See Assign Breaks Rule.
Class Name
com.workbrain.app.ta.quickrules.ArrangeBreakRule
Note: The Arrange Break Rule is not in the Quick Rule Template.
Overview
This rule is used when employees do not have scheduled breaks, but instead punch in/out for breaks. The rule currently supports only one break segment. The rule attempts to assign the given break parameters to the first UAT (un-allocated time) record after a non-UAT record occurs in the work details (for example, the rule would not be applied to a day where the first record is UAT).
Parameters
| Parameter | Description |
|---|---|
| Break Assign Time Code | Time code to which the UAT code will change to for a given number of Break Assign Minutes. |
| Break Assign Minutes | Number of minutes to apply the Break Assign Time Code. |
| Arrive Early Time Code | Time code that is used to mark the "arrive early" time segment. If a time code is not specified, the field will default to UAT. |
| Arrive Late Time Code | Time code that is used to mark the "arrive late" time segment. If a time code is not specified, the field will default to UAT. |
| Extra Arrive Early Time Code | Allows for the detection of when the employee is "extra" early for a break. When the employee is more than Extra Arrive Early Minutes minutes early, the application will insert this code instead of Arrive Early Time Code. |
| Extra Arrive Early Minutes | See the preceding parameter. When this value is set to a negative number, the value represents a percentage of the scheduled shift. For example, a value of -25 indicates that if the employee was early for a duration that is greater than or equal to 25% of the paid time on their shift, then the employee receives a different time code. |
| Extra Arrive Late Time Code | Allows for the detection of when the employee is "extra" late for break. When the employee is more than Extra Arrive Late Minutes minutes late, the application will insert this code instead of Arrive Late Time Code. |
| Extra Arrive Late Minutes | See the preceding parameter. When this value is set to a negative number, the value represents a percentage of the scheduled shift. For example, a value of -25 indicates that if the employee was late for a duration that is greater than or equal to 25% of the paid time on their shift, then the employee receives a different time code. |
Example
Work details before:
| Start | End | TimeCode |
|---|---|---|
| 10:00 | 12:00 | WRK |
| 12:00 | 12:40 | UAT |
| 12:40 | 18:30 | WRK |
Parameters that are used in this example are:
- Break Assign Time Code = BRK
- Break Assign Minutes = 30
- Arrive Early Time Code = ARRE
- Arrive Late Time Code = ARRL
Work details after:
| Start | End | TimeCode |
|---|---|---|
| 10:00 | 12:00 | WRK |
| 12:00 | 12:30 | BRK |
| 12:30 | 12:40 | ARRL |
| 12:40 | 18:30 | WRK |