For the complete documentation index, see llms.txt. This page is also available as Markdown.

Custom Metrics

What custom metrics are, how they change payroll but not the Employee Overview's daily hours, what they can measure, the public holiday metrics, and how to export them

A custom metric is a value AllWage works out for each employee from their time and attendance data, using rules set up for your business. For example, a metric can count hours worked on Sundays only, or hours on one activity on public holidays. Custom metrics are used in two places:

Who sets up custom metrics

Custom metrics are managed on Manage > Custom metrics. Users whose permissions include Custom metrics with write access can add, edit, duplicate and delete them; Owners and administrators have this by default. Other users with read access can view them.

AllWage support can also build a metric for you or change an existing one. Contact support and describe what the metric must count, on which days, and which pay run template should use it.

A profile can have up to 250 custom metrics and aggregations combined. Beyond that, AllWage shows "Maximum of 250 combined custom metrics and aggregations reached".

You can't delete a custom metric that is still in use:

  • "Cannot delete custom metric '…' — it is linked to … pay run template(s): …". Remove the metric from the pay run templates named in the message first. See Link a metric or quantity.

  • "Cannot delete custom metric '…' — referenced by … custom aggregation(s): …". Change or delete the custom aggregations named in the message first.

Custom metrics don't change the Employee Overview's daily hours

A custom metric is calculated from the clocks and records on the Employee Overview. It never changes them. So when a pay run template uses a custom metric, the payslip can show a different number from the daily hours on the report, and both are correct.

Example: a business deducts a 1-hour break from weekend shifts with a custom metric, and its weekend earning template is linked to that metric. An employee clocks 9.5 hours on a Saturday. The Employee Overview shows 9.5 hours for the day. The payslip pays 8.5 hours, because the template reads the metric, which subtracts the break.

If payroll and the report don't agree, check which metrics the employee's earning templates link to on Payroll > Settings > Pay run templates. To see the metric's own totals next to the report, click Manage metrics on the Employee Overview and choose Select by tags or Custom view.

What a custom metric can measure

A metric adds up one or more measurements, only on the days that match its conditions.

Measurements include:

  • hours from the timeline, such as total hours, normal hours, overtime or night shift hours;

  • leave hours by leave type;

  • an activity's hours, shown as "[activity] (Duration)", or the units captured against it, shown as "[activity] (Total)";

  • all activities in a category together, shown as "[category] [Category] (Duration)" for hours and "[category] [Category] (Total)" for units;

  • harvest quantities by produce or variant.

Conditions limit the days that count, for example:

  • Day of the week, such as Sunday;

  • Public holiday: whether the day is a public holiday;

  • Optional day: whether the day is an optional day on the employee's clock template. Days that aren't optional are the required working days.

  • Absent, Present and leave conditions.

A metric can also have a formula, for example to subtract a break.

Example: Sunday and public holiday hours per activity. A business pays pruning differently on Sundays and on public holidays. It uses two metrics, each measuring "Pruning (Duration)":

Metric
Conditions
Counts

Pruning Sunday hours

Day of the week is Sunday, and Public holiday is false

Pruning hours on Sundays that aren't public holidays

Pruning public holiday hours

Public holiday is true

Pruning hours on public holidays, whichever day they fall on

Each metric is linked to its own earning template, with its own rate. Because a Sunday public holiday only matches the second metric, no hours are paid twice.

Public holiday metrics

AllWage's standard (System) metrics include a set for public holidays. You choose them in the same lists as custom metrics, for example under Export Metrics on the Employee Overview. "Required days" are days that aren't optional on the employee's clock template.

Metric
What it gives

Public Holiday Clocked Total

All hours clocked on public holidays that fall on required days

Public Holiday Clocked Normal

The normal hours (up to the budget hours) of those

Public Holiday Clocked Overtime

The overtime hours (above the budget hours) of those

Public Holiday Optional Hours

Hours worked on public holidays that fall on optional days

Public Holiday Budget Hours

The budget hours of public holidays on required days, whether or not the employee worked: the hours for the employee's ordinary pay for the day

Public Holiday Worked

1 for each public holiday the employee worked

Public Holiday Required Day

1 for each public holiday on a required day, whether or not the employee worked

For all hours worked on public holidays, add Public Holiday Clocked Total and Public Holiday Optional Hours together. For how to pay public holidays with these metrics, see Public Holidays.

Export custom metric values

Use Export Metrics on the Employee Overview report. Choose the metrics, then Summary for one total per employee for the period, or Daily for a value per employee per day.

To find metrics quickly there, filter them by tag. Tags are labels added to a metric under Link tags (Optional) when it is set up. Use them to group the metrics you export together, such as all the metrics for one pay run.

Last updated

Was this helpful?