Utilization

The Utilization rule allows you to control how much work employees receive, either measured in FTE hours or in number of shifts. You can set minimum targets, ideal targets, and maximum limits for any combination of employees, shifts, and time periods.

Rule schema

object

Used to set targets and limits for the amount of hours or shifts worked by employees within given periods.

Show properties

string

required

Unique identifier for the rule.

array of string

Labels for the rule. Labels can be used to group rules together. For example, if multiple rules are related to the same shift type, they can all be labeled with the same label.

required

The importance of the rule. The higher the importance, the more it will be taking the rule into account. Under strict importance, the rule may never be violated.

object

Filters to determine the scope of the rule. Used to decide which employees and which shifts the rule should be applied to. Filters use logical OR filtering - an employee or shift is included as long as it is targeted by any of the filters.

Show filters – properties

object

Filters entities by id and label.

Show employees – properties

array of string

Entity ids to match.

array of string

Entity labels to match.

object

Show matchTypes – properties

string (enum: NONE | ANY | ALL)

Used to indicate how to apply the id filters. For example, if set to NONE, entities with the specified ids will be excluded. Default: “ANY”.

string (enum: NONE | ANY | ALL)

Used to indicate how to apply the label filters. For example, if set to ANY, entities that have any of the specified labels will be included. Default: “ANY”.

object

Filters entities by id and label.

Show shifts – properties

array of string

Entity ids to match.

array of string

Entity labels to match.

object

Show matchTypes – properties

string (enum: NONE | ANY | ALL)

Used to indicate how to apply the id filters. For example, if set to NONE, entities with the specified ids will be excluded. Default: “ANY”.

string (enum: NONE | ANY | ALL)

Used to indicate how to apply the label filters. For example, if set to ANY, entities that have any of the specified labels will be included. Default: “ANY”.

object

Defines filtering for specific work that the rule should be applied to. For example, it can be used to apply the rule only to work carried out in specific roles.

Show work – properties

object

Used to apply the rule only to work carried out in specific roles.

Show roles – properties

array of string

List of relevant role ids.

object

Used to apply the rule only to work carried out with specific workload categories.

Show workloads – properties

array of string

If specified, the shift must have at least one of the workload categories specified in this list.

object

required

Specifies the target utilization for the rule. Targets can be specified in number of FTE hours, or in number of shifts worked during the period.

Show targets – properties

number

The minimum number of hours that should be worked by employees on shifts that match the rule in each period. This is treated as a target - it is not guaranteed that the number of hours worked will be greater than this value.

number

The ideal number of hours that should be worked by employees on shifts that match the rule in each period. This is treated as a target - it is not guaranteed that the number of hours worked will be exactly this value.

number

The maximum number of hours that should be worked by employees on shifts that match the rule in each period. This is treated as a hard limit - the number of hours worked will never exceed this value.

integer

The minimum number of shifts that match the rule that an employee should work in each period. This is treated as a target - it is not guaranteed that the number of shifts worked will be greater than this value.

integer

The ideal number of shifts that match the rule that an employee should work in each period. This is treated as a target - it is not guaranteed that the number of shifts worked will be exactly this value.

integer

The maximum number of shifts that match the rule that an employee should work in each period. This is treated as a hard limit - the number of shifts worked will never exceed this value.

object

Additional options for how the rule should be applied.

Show options – properties

object

Settings to determine if and how bonus time rules affect the rule.

Show bonusTime – properties

boolean

Whether or not bonus hours should be included in the calculation of an employee’s total hours worked for the rule. Default: true.

number

If a threshold is provided, bonus hours will only be included in the calculation of an employee’s total hours worked if the average bonus hours per period exceed this threshold.

number

If a cap is provided, the average number of bonus hours per period will be capped at this value. The employee can be eligible for more bonus hours, but they will not be counted beyond this cap.

object

Specifies overlap thresholds that a shift must meet with the rule’s periods in order for it to be counted as relevant for the rule.

Show overlapSettings – properties

integer

The minimum number of hours that a shift must overlap with the rule in order to be counted as relevant for this rule.

integer

The minimum percentage of the shift that must overlap with the rule in order to be counted as relevant for this rule.

object

List of periods in the schedule. Periods can be defined explicitly or through a recurrent definition (for example, to generate weeks).

Show periods – properties

object

List of days in the schedule. Each day will become one period. By default, each period will last the entire day. If a startTime and/or endTime are specified, these will apply to each period.

Show days – properties

array of date (date)

List of dates in the schedule. Only allowed in CALENDAR payloads.

array of dayIndex

List of day indices in the schedule. Only allowed in RECURRING payloads.

array of dayOfWeek

List of days of the week. Will apply to all days in the schedule that match any of the specified weekdays.

string (time)

TIME ISO 8601 format hh:mm. Equivalent to the 24h format of a single day. Use 00:00 to represent midnight.

string (time)

TIME ISO 8601 format hh:mm. Equivalent to the 24h format of a single day. Use 00:00 to represent midnight.

array of object

List of custom period definitions. Each custom period definition defines one period in the schedule.

Show customDefinitions – item structure

object

Describes one day in the schedule.

Show startDay – properties

string (date)

Date specified in ISO8601 format (YYYY-MM-DD). Only available in CALENDAR schedules.

integer

Day index relative to the horizon start day (starts at 0). Only available in RECURRING schedules.

object

Describes one day in the schedule.

Show endDay – properties

string (date)

Date specified in ISO8601 format (YYYY-MM-DD). Only available in CALENDAR schedules.

integer

Day index relative to the horizon start day (starts at 0). Only available in RECURRING schedules.

string (time)

TIME ISO 8601 format hh:mm. Equivalent to the 24h format of a single day. Use 00:00 to represent midnight.

string (time)

TIME ISO 8601 format hh:mm. Equivalent to the 24h format of a single day. Use 00:00 to represent midnight.

boolean

If true, the startTime and endTime will be applied to each individual day in the period. If false, the startTime will apply to the first day and the endTime will apply to the last day. Default: false.

object

A recurrent definition to easily create a set of similar periods.

Show recurrentDefinition – properties

integer

required

The number of days in each period.

integer

The number of days between the start of each period. If not specified, this defaults to the value of daysPerPeriod, creating non-overlapping consecutive periods. Setting daysBetweenStarts to 1 will create a sliding window of periods.

object

Describes one day in the schedule.

Show startDay – properties

string (date)

Date specified in ISO8601 format (YYYY-MM-DD). Only available in CALENDAR schedules.

integer

Day index relative to the horizon start day (starts at 0). Only available in RECURRING schedules.

object

Describes one day in the schedule.

Show endDay – properties

string (date)

Date specified in ISO8601 format (YYYY-MM-DD). Only available in CALENDAR schedules.

integer

Day index relative to the horizon start day (starts at 0). Only available in RECURRING schedules.

string (time)

TIME ISO 8601 format hh:mm. Equivalent to the 24h format of a single day. Use 00:00 to represent midnight.

string (time)

TIME ISO 8601 format hh:mm. Equivalent to the 24h format of a single day. Use 00:00 to represent midnight.

boolean

array of string

Provide labels to re-use periods that were defined in the configuration.

How targets work

The rule supports three types of targets for both hours and shifts:

Minimum targets (minHours, minShifts): The solver will try to ensure employees work at least this amount. These are treated as soft targets and may not always be met if other rules conflict.
Ideal targets (idealHours, idealShifts): The solver will try to assign exactly this amount. This is useful when you want employees to work a specific number of hours or shifts.
Maximum limits (maxHours, maxShifts): These are hard limits that will never be exceeded. The solver will strictly enforce these bounds.

You don’t need to specify all targets - only include the ones relevant to your use case. For example, you can set only maxHours to cap the total hours, or only idealShifts to target a specific number of shifts.

Global utilization targets

Set utilization targets for the entire planning horizon. This is useful for ensuring employees receive a fair distribution of work across the entire schedule.

The rule below sets targets for employee-1 across the entire planning horizon:

The employee should work at least 80 hours (soft target)
The employee should ideally work exactly 120 hours
The employee may work no more than 160 hours (hard limit)

{
  "id": "euc-total-hours",
  "filters": {
    "employees": {
      "ids": ["employee-1"]
    }
  },
  "targets": {
    "minHours": 80,
    "idealHours": 120,
    "maxHours": 160
  }
}

Period-based utilization targets

All targets are applied to each period separately. By defining periods, you can create rules that apply to specific time windows, such as weekly or monthly targets.

The rule below sets a weekly target for all employees. Each employee should ideally work 40 hours per week, with a minimum of 32 hours and a maximum of 48 hours.

{
  "id": "euc-weekly-hours",
  "targets": {
    "minHours": 32,
    "idealHours": 40,
    "maxHours": 48
  },
  "periods": {
    "recurrentDefinition": {
      "daysPerPeriod": 7
    }
  }
}

Shift-based limits

You can limit the number of shifts of a specific type that employees can work. This is particularly useful for controlling undesirable shifts like night shifts or weekend work.

The rule below sets a strict upper bound of 2 night shifts per week for all employees. After an employee has worked 2 night shifts in a week, they cannot be assigned any more night shifts that week.

{
  "id": "euc-night-shifts-per-week",
  "filters": {
    "shifts": {
      "labels": ["night"]
    }
  },
  "targets": {
    "maxShifts": 2
  },
  "periods": {
    "recurrentDefinition": {
      "daysPerPeriod": 7
    }
  }
}

Minimum shift requirements

You can also set minimum shift requirements to ensure employees receive a certain amount of work.

The rule below ensures that each employee works at least 3 shifts per week, with an ideal target of 5 shifts. This helps prevent employees from being underutilized.

{
  "id": "euc-min-shifts-per-week",
  "targets": {
    "minShifts": 3,
    "idealShifts": 5
  },
  "periods": {
    "recurrentDefinition": {
      "daysPerPeriod": 7
    }
  }
}

Combining hours and shifts targets

You can combine both hours and shifts targets in a single rule to create more nuanced requirements.

The rule below ensures employees work between 3-5 shifts per week, with each shift ideally being around 8 hours. This creates a balanced schedule where employees get enough shifts but not too many.

{
  "id": "euc-balanced-weekly",
  "targets": {
    "minShifts": 3,
    "idealShifts": 4,
    "maxShifts": 5,
    "minHours": 24,
    "idealHours": 32,
    "maxHours": 40
  },
  "periods": {
    "recurrentDefinition": {
      "daysPerPeriod": 7
    }
  }
}

Setting limits on specific roles

You can set limits on the number of hours or shifts that employees can be assigned to specific roles.

The rule below limits employees to a maximum of 50 hours per week worked with role role-1, while aiming for them to work at least 35 hours.

{
  "id": "euc-role-1-max-50-hours",
  "filters": {
    "work": {
      "roles": {
        "ids": ["role-1"]
      }
    }
  },
  "targets": {
    "minHours": 35,
    "idealHours": 40,
    "maxHours": 50
  },
  "periods": {
    "recurrentDefinition": {
      "daysPerPeriod": 7
    }
  }
}

The rule below ensures that employees work at least 2 weekend shifts per month, helping to distribute weekend work fairly.

{
  "id": "euc-weekend-shifts",
  "filters": {
    "shifts": {
      "labels": ["weekend"]
    }
  },
  "targets": {
    "minShifts": 2,
    "idealShifts": 3
  },
  "periods": {
    "recurrentDefinition": {
      "daysPerPeriod": 30
    }
  }
}

Metrics

The following status metrics are available for tracking on Utilization rules:

Metric key	Description
`UTILIZATION.TOTAL_MINUTES`	Total worked minutes counted by Utilization rules.
`UTILIZATION.MINUTES_BELOW_MIN`	Total minutes by which work falls below configured minimum-hour targets.
`UTILIZATION.MINUTES_BELOW_IDEAL`	Total minutes by which work falls below configured ideal-hour targets.
`UTILIZATION.MINUTES_ABOVE_IDEAL`	Total minutes by which work exceeds configured ideal-hour targets.
`UTILIZATION.ASSIGNMENTS_BELOW_MIN`	Total assignments by which work falls below configured minimum-shift targets.
`UTILIZATION.ASSIGNMENTS_BELOW_IDEAL`	Total assignments by which work falls below configured ideal-shift targets.
`UTILIZATION.ASSIGNMENTS_ABOVE_IDEAL`	Total assignments by which work exceeds configured ideal-shift targets.

Getting started

Entities

Concepts

Reasoning

Status updates

Rule schema

How targets work

Global utilization targets

Period-based utilization targets

Shift-based limits

Minimum shift requirements

Combining hours and shifts targets

Setting limits on specific roles

Metrics