Rulesets use the information captured in the docket to assign resources and rate types to the line items section of a docket.
Introducing Rulesets
A ruleset is a set of rules that will apply to a docket when it is created. Rulesets are linked to either Orders or Docket Templates and apply to dockets created from those.
Rulesets can include the following types of rules:
- Time Allocation - allocate shift time to one or more rate types according to the rule - (e.g. Normal Time / Overtime)
- Resource Definition - the rate type or resource is added to every docket (e.g. site allowance)
- Conditional - the rate type or resource is added only when certain conditions are met (e.g. meal allowance)
- Weekly Maximum - only applies when there are a maximum number of Normal Hours payable in a week.
Time Allocation Rules
Time Allocation rules are configured with Conditions and Definitions:
- Conditions - are the triggers for applying the rule
- Definitions - are the rules applied when the condition is met.
Note: the first Time Allocation Rule will have no conditions. It applies to any docket that doesn't trigger the conditions for any other rule.
Conditions
Conditions can include the following:
- Day of Week - Is either equal/not equal to a specific day or contains/does not contain a list of days
- Docket Times - Start Time, End Time, Break Time, Travel Time and duration meets certain conditions
- Custom Select Fields - Is either equal/not equal to or contains/does not contain specific values
- Custom Number fields - is equal to, greater than or less than a specific numeric value
- Custom Time fields - is equal to, before or after a specific time
- Custom Boolean fields - triggers based on a true / false of a box selected.
Definitions
Definitions can include the following time allocations:
- First - the first x hours is allocated to the resource type or resource selected. This is commonly used to say the first 8 hours is normal time.
- Time Before - Any time before a defined time is allocated to the resource type or resource selected. For example, any time before, say, 6am is payable at double time.
- Time After - Any time after a defined time is allocated to the resource type or resource selected. For example, any time after 6pm is payable at double time.
After the first allocation is set, the following options are available:
- Next - The next x hours are payable at the next rate level (e.g. the next 2 hours at time and a half)
- Up until - Available when time before rule is used, this allows up to, say, 8 hours to be allocated an normal before reverting again to elevated rates.
All Remaining Time - any time that is not captured in the above definitions will be allocated to this rate.
Resource Definition Rules
Resource Definition rules apply to all dockets on the ruleset. For example, site allowance might always be payable for the value of 1.
The definition statement can also contain basic mathematical operations (add, subtract, multiply, divide). So, for example, one could define the line item quantity to be the Gross Weight minus the Tare Weight.
Conditional Rules
Conditional rules are similar to resource definition rules, however, they only apply when certain conditions are met. For example, waiting time may only be paid when time onsite is over 30 mins, and the waiting time charge is waiting time minus 30.
Other common examples of conditional rules are meal allowance only applying after a defined shift duration, or breaks being paid during the weekend.
Weekly Maximum
This is a special case ruleset that applies to limit the number of normal hours worked in a week. Anything over the defined maximum is paid at the 'overflow' rate.