Pay Rule Conditions

Overview

Pay Rule Conditions are made up of a number of items.

The component is the type of circumstance that the rule will look for on the timesheet (eg, a date)

Attributes are the values a rule will use when looking for the component (eg, a specific day, Mon). Condition attributes are:

Range	How the component relates to the value. There are six range types. Less than Greater than Between Equal to Has Tag Doesn’t have Tag
Value	The date, tag, etc, that the component applies to. If you choose the range ‘Between’, you will need to enter two values.
Apply to	Apply the action of the rule to all units in a block, even when the range and value only match some of the units. If you don’t tick ‘Apply to whole shift’, the rule will only apply the action to the matching units.

Some components don’t have attributes because they are triggered by a complete block of units, rather than units within a block. They also apply to all units in a block when triggered.

Condition Components

The table below lists some of the more commonly used components in the Rules Engine.

Component	Description	Attributes
Day of the week	Trigger an action when units are recorded on a specific day of the week. This component looks for any units recorded on a specific day. This can include overnight blocks of units that start on one day and end on the second. To match a block of units that starts on a specific day regardless of when the block ends, use ‘Shift started on days of the week’.	Range ‘Equal to’ looks for units entered on the days in the Value field. Value Enter a day of the week in 3-letter format with the first letter capitalised and other letters lower case (eg Mon, Tue) You can enter more than one day, using a comma to separate each value, Do not use a space. The order of the days does not matter. Apply to whole shift Choose whether the rule applies only to the matching units, or to all units in the block.
Shift started on the day of the week	Trigger an action when the first unit in a block is recorded on a specific day.  The difference between this component and Day of the week is that this component only matches blocks of units that start on the days you enter in the Value field.	Range ‘Equal to’ looks for units entered on the days in the Value field Value Enter a day of the week in 3-letter format (eg Mon, Tue) You can enter more than one day, using a comma to separate each value, Do not use a space. The order of the days does not matter.
Week Started on Day	Must be used together with 'Total Week Rules' condition to interpret overtime on a weekly basis where the employee is on a fortnightly or monthly timesheet.  Used to define where the week starts. Should be set as the first condition, with Total Week Hours set after.  Please note that partial weeks are not supported for monthly timesheets.	Range Can only be set as 'equal to', with one of the valid values below. Values Mon, Tue, Wed, Thu, Fri, Sat, Sun A week is defined by the day set plus 6 days (eg if Week Started on Day = Monday, a week is Monday + 6 days)
Working Hours	Trigger an action when the units are recorded before, after or during a specific time of day.  This component only looks for blocks of units that start and end on the same day, and applies when any units match the range and value.  If you want a rule that looks for blocks of units that start on a specific weekday, regardless of when they end, use Shift started on day of the week	Range Less than looks for units entered before the time in the Value field Greater than looks for units entered after the time in the Value field Between looks for units entered between the two times in the Value fields Value 12-hour or 24-hour format time We recommend entering values using 24-hour time and the hh:mm:ss format.
Total shift hours	Trigger an action when the total hours in a single block are longer or shorter than a specific length of time, or falls between two lengths of time. This component is useful for interpreting timesheet with split shifts, to distinguish between hours worked in one shift vs. hours worked in one day	Range Less than looks for blocks with fewer units than the Value Greater than looks for blocks with more units than the Value Between looks for blocks with units between two lengths of time Value Length of time, in either hh:mm:ss format or decimal format
Total week hours	Must be used together with 'Week Started on Day' and used to interpret overtime on a weekly basis where the employee is on a fortnightly or monthly timesheet. This condition can be applied to Units on a Timesheet or Units in Pay Conditions. Should be set as a condition after any other rules, including 'Week started on day'.  Please note that partial weeks are not supported for monthly timesheets.	Range Less than looks for blocks with fewer units than the Value Greater than looks for blocks with more units than the Value Between looks for blocks with units between two lengths of time Value Numeric value, up to 4 decimal places.
Total day hours	Trigger an action when the total hours for a day are longer or shorter than a specific length of time, or fall between two lengths of time. This component counts all units where the first unit in a block is recorded on the same day, including units recorded after midnight on the next day. The component will not include hours from a block if the first unit was recorded on the previous day.	Range Less than looks for blocks with fewer units than the Value Less than or equal to looks for blocks with fewer or equal units to the Value Greater than looks for blocks with more units than the Value Greater than or equal to looks for blocks with equal or more units than the Value Equal to looks for blocks which match the Value exactly Between looks for blocks with units between two lengths of time Value Length of time, in either hh:mm:ss format or decimal format. This should be entered as total units, not reference to actual time on the clock.
Cumulative TS Hours	Trigger an action for all units on a timesheet within the Range. This component counts all hours in the timesheet including continuous shifts that started on the final day of the timesheet and ended on the first day of the next timesheet. The component will not include hours from a block if the first unit was recorded on the previous timesheet. You would use this component to find weekly overtime (eg Cumulative TS Hours between 40 and 42). You cannot use this component to find timesheets with less/more than a total number of hours in a week.	Range Less than looks for blocks with fewer units than the Value Greater than looks for blocks with more units than the Value Between looks for blocks within units between two lengths of time Value Length of time, in either hh:mm:ss format or decimal format. This should be entered as total units, not reference to actual time on the clock.
Tagged	Trigger an action when a block of units has (or does not have) a specific tag. You must have already created a rule that adds a tag to a block of units.	Range Has Tag Doesn’t have Tag Value Enter value of an existing tag (eg OT or Overtime)
Holiday Type	Trigger an action when units are recorded on a date that has been set as a Holiday in the associated Holiday Groups. You must have already set up Holidays to trigger this condition. The rule 'Working Hours on Holiday' can be used in conjunction so that if a shift spans multiple days and only part of the shift falls on a holiday, you can select whether only the hours on the actual holiday date are considered as hours worked on a holiday or whether the entire shift is counted.	Range Is Is not Value Select from Smart Tag list of Holidays
Assigned Pay Item	Trigger an action when units are assigned against a Pay Item. This condition will pick up any Pay Items that have been assigned on the timesheet, such as a meal allowance. It will also pick up any Pay Item that has been assigned by a previous Rule.	Range Is Is not Value Select ‘Any Pay Item’ or one or more individual Pay Items