In this article in The Rules Series, we show how to configure the rules engine to use the Pay Item action.
How the Pay Item action works
Overview
The pay item action works by creating a Pay Item (or items) based on the matches returned by the condition. All pay items created are for the same type, but the quantity/number of pay items can be configured
Configuration options
Name | Description | Data Type | Example value |
|---|---|---|---|
Pay Type | This refers to a pay type in the system. A pay type indicates either a fixed amount (per quantity) | Lookup (pay types) | Ordinary hours |
per option | Indicates either the number of or quantity of pay items created. | One option | Hour |
Per Options
An example:
In this example, we’ll configure an allowance, and set the per options differently to demonstrate the different options.
Per Hour
Configuring per hour will create a single Pay Item for each match from the conditions. The quantity of the pay item will be the number of hours in the match. The pay item will also be populated with the start and end of the match.
Per Day
Configuring per day will create a single Pay Item. The quantity of the pay item will be the number of distinct calendar days for all matches in the collection.
When an employee works multiple shifts, or has multiple timesheets that would qualify for an allowance or pay item under the per day option, the allowance or payment is attached to the first timesheet only.
Per Week
Configuring per week will create a single Pay Item. The quantity of the pay item will be the number of distinct calendar weeks for all matches in the collection.
Per Timesheet
Configuring per timesheet will create a Pay Item per timesheet in the collection of matches.
Per Match
Configuring per match will create a single Pay Item. The quantity of the pay item will be the number of distinct matches in the collection.
Per Group
Configuring per group will create a single Pay Item for one of the timesheets in a group - this will be paid once to the first timesheet in the group.
Notes
This action changes the timesheets that match the conditions that relate to the action, but does not change the matches, or change pay items.
This action should be used in conjunction with other actions that follow it, to take advantage of the altered timesheets.
Instructions
Create a Pay Rule and Pay Rule Version. (see: How to: Create a new Global Pay Rule, and How to: Create a new Global Pay Rule Version for examples)
Navigate to edit the pay rule version, and expand the Rules
Configure your preferred conditions, then in the Then section, choose the Pay Item action
Configure the Pay Type that you want to have, and the per option.
Save your pay rule version.
In this article in The Rules Series, we show how to configure the rules engine to use the Pay Item action.
How the Pay Item action works
Overview
The pay item action works by creating a Pay Item (or items) based on the matches returned by the condition. All pay items created are for the same type, but the quantity/number of pay items can be configured
Configuration options
Name | Description | Data Type | Example value |
|---|---|---|---|
Pay Type | This refers to a pay type in the system. A pay type indicates either a fixed amount (per quantity) | Lookup (pay types) | Ordinary hours |
per option | Indicates either the number of or quantity of pay items created. | One option | Hour |
Per Options
An example:
In this example, we’ll configure an allowance, and set the per options differently to demonstrate the different options.
Per Hour
Configuring per hour will create a single Pay Item for each match from the conditions. The quantity of the pay item will be the number of hours in the match. The pay item will also be populated with the start and end of the match.
Per Day
Configuring per day will create a single Pay Item for each calendar day where there are one or more returned matches.
The quantity will be on (1) for each item, and there are no start and end times recorded for the pay item.
The start time of each match is used to determine the days that should record a payment. The payment is linked to the the timesheet that has the first match on that day.
When an employee works multiple shifts, or has multiple timesheets that would qualify for an allowance or pay item under the per day option, the allowance or payment is attached to the first timesheet only.
Per Day (using start of timesheet)
Configuring per day (using start of timesheet) will create a single Pay Item for each calendar day where there are one or more timesheets related to the returned matches.
The quantity will be on (1) for each item, and there are no start and end times recorded for the pay item.
The start time of the timesheet relating to each match is used to determine the days that should record a payment. The payment is linked to the timesheet that has the first match on that day.
For example, on a weekend where there is a single shift worked on the Saturday night, and rolling over until Sunday morning, the employee would be paid a single allowance on the timesheet, regardless of whether a match was recorded on Sunday morning.
Per Day (using start of group)
Configuring per day (using start of group) will create a single Pay Item for each calendar day where there are one or more groups related to the returned matches.
The quantity will be on (1) for each item, and there are no start and end times recorded for the pay item.
The start time of the group relating to each match is used to determine the days that should record a payment. The payment is linked to the first timesheet in the group.
For example, on a weekend where there are two timesheets, one worked on the Saturday night and the other on a Sunday morning that are linked to the same group, the employee would be paid a single allowance on the Saturday timesheet, even though timesheets were recorded on a Saturday and Sunday, because the start of the group was on a Saturday.
Per Week
Configuring per week will create a single Pay Item for the timesheet linked to the first match in the calendar week.
The quantity will be on (1) for each item, and there are no start and end times recorded for the pay item.
The start time of each match is used to determine the days that should record a payment. The payment is linked to the the timesheet that has the first match on each week.
Per Week (using start of timesheet)
Configuring per week (using start of timesheet) will create a single Pay Item for each calendar week where there are one or more timesheets related to the returned matches.
The quantity will be on (1) for each item, and there are no start and end times recorded for the pay item.
The start time of the timesheet relating to each match is used to determine the days that should record a payment. The payment is linked to the timesheet that has the first match in each calendar week.
For example, on a week where there is a single shift worked on the Wednesday night, and rolling over until Thursday morning, the employee would be paid a single allowance on the timesheet, regardless of whether a match was recorded on Thursday morning, or other timesheets were recorded later in the week.
For example, on a week where there is a single shift worked on the Sunday night, and rolling over until Monday morning, the employee would be paid a single allowance on the timesheet, regardless of whether a match was recorded on Monday morning. The employee is not paid an allowance for the Monday morning match, because the timesheet started on a Sunday, which is still part of the previous calendar week (assuming that the calendar week starts on a Monday in the company settings).
Per Week (using start of group)
Configuring per week (using start of group) will create a single Pay Item for each calendar week where there are one or more groups related to the returned matches.
The quantity will be on (1) for each item, and there are no start and end times recorded for the pay item.
The start time of the group relating to each match is used to determine the days that should record a payment. The payment is linked to the first timesheet in the group that has the first match in each calendar week.
For example, on a weekend where there are two timesheets, one worked on the Saturday night and the other on a Sunday morning that are linked to the same group, the employee would be paid a single allowance on the Saturday timesheet, even though timesheets were recorded on a Saturday and Sunday, because the start of the group was on a Saturday.
For example, on a week where there is a single group with timesheets on Sunday night, and Monday morning, the employee would be paid a single allowance for the group on the Sunday timesheet, regardless of whether a match was recorded on Monday morning. The employee is not paid an allowance for the Monday morning timesheet, because the group started on a Sunday, which is still part of the previous calendar week (assuming that the calendar week starts on a Monday in the company settings).
Per Timesheet
Configuring per timesheet will create a Pay Item per timesheet in the collection of matches.
Per Match
Configuring per match will create a single Pay Item. The quantity of the pay item will be the number of distinct matches in the collection.
Per Group
Configuring per group will create a single Pay Item for one of the timesheets in a group - this will be paid once to the first timesheet in the group.
Instructions
Create a Pay Rule and Pay Rule Version. (see: https://support.roubler.com/hc/en-us/articles/4408459205913-How-to-Create-a-new-Global-Pay-Rule , and https://support.roubler.com/hc/en-us/articles/4408459242009-How-to-Create-a-new-Global-Pay-Rule-Version for examples)
Navigate to edit the pay rule version, and expand the Rules
Configure your preferred conditions, then in the Then section, choose the Pay Item action
Configure the Pay Type that you want to have, and the per option.
Save your pay rule version.
Comments
0 comments
Please sign in to leave a comment.