Leveling Resources#
This guide shows how to remove resource overallocation from a plan. It covers what Project#level changes, how it picks the task that gives way, how to limit it to part of the plan, and how to read, preview and undo its result.
How leveling works#
A resource is overallocated when the tasks booked on it need more than its capacity at the same time. solve only reports this, as overallocations windows on the result. level fixes it by moving work later. It never changes assignments, resources or capacities. It changes two task fields:
levelingDelay, which delays the whole task.pauses, which splits a task: it stops working for a while and picks up again later.
Leveling looks at the plan in buckets: day buckets when config.durationUnit is DAY, hour buckets for HOUR and MINUTE. The load of a resource in a bucket is the sum of value over the assignments that book working time in that bucket. A task counts with its full value as soon as it works any time in the bucket. When the load is higher than the resource's capacity (default config.defaultResourceCapacity, which is 1.0), the bucket is overallocated. A run of overallocated buckets in a row is a window.
level works through the plan from left to right, in rounds:
- Find the earliest overallocated bucket.
- Collect the tasks that contribute to it, the contenders, and sort them by the selection order.
- Move the weakest contender just past the bucket, with a delay or a pause, until the load fits.
- Reschedule the project, so links and constraints push the successors along.
- Repeat until no overallocated bucket with a movable contender is left.
Some tasks never move. Leveling leaves them alone and calls them the fixed set:
- tasks with
autoScheduling = false - completed tasks (
progress == 1, whenconfig.useProgressis on) - tasks with an
MSOorMFOconstraint (whenconfig.applyConstraintsis on) - tasks with
priority == 1000 - summaries (their dates follow their children)
- tasks outside
LevelingScope.tasks, when you set it
If a proposed move doesn't stick, because a constraint or another hard rule pulls the task back, leveling reverts it and freezes the task for the rest of the run. Hard requirements always win. Whatever leveling can't resolve stays in overallocations, and each remaining window gets a reason.
A few rules hold for every run:
levelcommits. It runssolve(null, โฆ)first, writes the delays and pauses into the project and accepts the leveled dates as the new baseline. To show leveling as a proposal, run it on acopy(). See Previewing and clearing.- Leveling is forward-only. A project with
config.scheduleFromEnd = trueis refused with anInputExceptionat pathconfig.schedule_from_end. - A cyclic project isn't leveled.
levelreturns the initial solve's result, with its cycles, androunds = 0. - The output is deterministic. Every tie ends in input order, so the same data and options always give the same result.
- There's no round limit. A run ends when nothing is left to resolve. The call is synchronous and CPU-bound, so on large projects run it on a worker executor in a server.
- Known bug:
leveldoesn't return when an assignment requests more units than its resource can ever supply. Checkvalueagainstcapacitybefore you call it.
Leveling a project#
Call level with a new LevelingOptions after the project is solved. The examples on this page use the default calendar (Monday to Friday, 08:00-12:00 and 13:00-17:00) and start on Monday, August 10, 2026.
;
;
solve reports one window on dev1 over Monday and Tuesday, with a peak load of 2.0. level keeps A and moves B to Wednesday. Both tasks are equal, so the input-order tie-break decides: the later task moves.
overallocations is a list only when the project has assignments. Without any, it's null.
Leveling diffs its updates against the state the call started from, so you can apply them to the model you already hold. Next to the new dates, each Mutation carries the task's new levelingDelay and, when it changed, its complete pauses list. Fields that didn't change are null. A Mutation maps field-for-field onto a TaskUpdate.
Delays and pauses#
levelingDelay and pauses are elapsed time, in the task's duration unit: with day units, 1.0 is 24 hours of calendar time, weekends and nights included. duration and lag stay working time. Both round to whole minutes when they're used.
- A delay shifts the task's start from its driven position (the start that links and constraints give it). Draw it as the stretch
[start - delay, start)before the bar. - A
Pausestartsatafter the task start and lastslength. The leveler setsbytoPauseSource.LEVELINGon every pause it writes (Pause.leveling(at, length)builds the same value). Draw pauses as gaps in the bar. They need no calendar.
Which one leveling picks depends on the contender. A task that starts inside the overallocated bucket has no work before it, so it gets a whole-task delay. A task that's already running in that bucket can be paused: it keeps the work it has done and resumes after the contention. Delaying a running task would leave an idle gap behind it. Pausing it doesn't. Set allowSplits to false to get whole-task delays only.
;
;
With splits, A keeps its start and works Monday, pauses for two days (at = 1.0, length = 2.0), and finishes its second day on Thursday. B works in the pause, so the chain into C doesn't move. Without splits, A can't be paused and stays in place, so B is delayed whole and the link pushes C along. The update for A has startDate == null, because its start didn't change.
Every pause is treated as leveling's own: clearFirst clears all of them, and the leveler may extend any. A pause takes up no load, and a task without pauses never gets a pauses list in its update. The validation rules are on the Pause reference.
Leveling options#
LevelingOptions starts with every default set. Change fields with the fluent setters (withAllowSplits(false)) or assign them directly (options.allowSplits = false):
| Field | Default | What it changes |
|---|---|---|
scope |
null = whole project |
Which resources, tasks and dates leveling acts on. |
basis |
null = derived from config.durationUnit |
Bucket size, Basis.DAY or Basis.HOUR. |
order |
LevelingOrder.STANDARD |
Which contender moves first. See Selection order. |
withinSlackOnly |
false |
Never push a task past the project end of the plan leveling started from. |
clearFirst |
true |
Clear the existing delays and pauses on in-scope tasks before leveling. |
allowSplits |
true |
Allow pauses. With false, every new move is a whole-task delay. |
step |
LevelingStep.MINIMAL |
How far one move goes. |
The full list is on the LevelingOptions reference.
Leveling part of a plan#
LevelingScope limits a run in three ways, and you can combine them. Each field is null by default, which means no limit:
tasks: only these tasks may move. Everything else acts like a fixed task.resources: only contention on these resources triggers a move.from/to: only buckets that start in[from, to)trigger a move. The range limits where leveling looks for contention, not where tasks land: a moved task may end up pastto.
;
;
The second run leaves the Monday window alone and reports it with the reason out-of-scope. The result still has converged == true, because the run did everything it was asked to do. The reason tells you why the window is still there.
An unknown id in scope.tasks or scope.resources throws an InputException at path scope.tasks or scope.resources.
Staying within slack#
With withinSlackOnly = true, leveling never pushes a task further than its total slack. The slack is measured against the project end of the plan the run started from, so leveling can't make the project finish later. If a contender can't clear the bucket within its slack, leveling skips it and tries the next one. If no contender fits, the window stays with the reason slack-exhausted.
LevelingResult result ;
The slack leveling uses is internal. It ignores the existing delays and uses that fixed project end, so it can differ from analytics.slack in a solve result.
Fewer rounds with the skip step#
By default a move clears one bucket. Then leveling reschedules and re-selects at the next bucket, so the burden of a long window can switch between contenders bucket by bucket. LevelingStep.SKIP moves the task past the whole window in one move. That takes fewer rounds and reschedules less often. Use it for large projects where level is slow.
;
;
Here both steps give the same plan. That's not guaranteed: buckets the skip step jumps over never get a new selection, so on real plans the two can level differently. If a jump hits a constraint or doesn't fit the slack, leveling falls back to the one-bucket move for that task.
Selection order#
When several contenders share an overallocated bucket, the order decides which one stays and which moves first. Every order ends in the same tie-break: the task later in input order moves.
LevelingOrder |
Who moves first |
|---|---|
STANDARD (default) |
Checked in order: a successor before its predecessor, more total slack, later start, lower priority, no dated constraint. |
PRIORITY |
Lower priority first, then the STANDARD checks. |
ID |
The task later in input order. |
All three orders also apply the running rule. A task already working before the bucket stays, and the task that starts in the bucket moves, unless the running task can be paused instead. This keeps whole-task delays from leaving gaps in work that was already scheduled. Under PRIORITY, a higher priority beats the running rule: the lower-priority running task is paused, or delayed whole when splits are off.
priority is an int from 0 to 1000 on TaskData, 500 by default. At 1000 the task never moves.
The dependency check exists because delaying a predecessor would push its successor along and resolve nothing. In this plan B comes first in the input, but an SS link from A makes A its predecessor, so B moves:
;
;
To protect a task from leveling, set its priority to 1000 or its autoScheduling to false. With withPriority(1000) on B in the first example, A moves to Wednesday instead.
Reading the result#
level returns a LevelingResult:
schedule: aScheduleResult, the same shapesolvereturns. Itsupdatescarry the new dates, delays and pauses.baselineIdnames the new baseline. The project keeps this object as its baseline result, so treat it as read-only, ordeepClone()it before you change it.rounds: the number of rounds that proposed a move. Rounds that only skipped an unresolvable bucket don't count.
schedule.converged is the scheduler's convergence on the final plan, not a leveling flag. Leveling itself always runs until nothing is left to resolve.
schedule.overallocations lists the windows that remain. Every window from level has a reason. When a window has several immovable contenders, the first reason in this table wins:
reason |
Why the window remains |
|---|---|
pinned-constraint |
A contender was frozen because its move didn't stick, or it has an MSO / MFO constraint. |
fixed-task |
A contender has autoScheduling = false, or is a summary. |
completed |
A contender has progress == 1 under config.useProgress. |
priority-1000 |
A contender has priority == 1000. |
slack-exhausted |
Every candidate was capped by withinSlackOnly. |
out-of-scope |
The resource, the dates or every contender is outside scope. |
A reason is data, not an error. It tells the user what to change to resolve the window: unpin a task, loosen a constraint, widen the scope.
;
;
Leveling proposed a delay for B, the replan pulled B back to Monday, and leveling reverted the move. Nothing in the project changed. The window stays and reports pinned-constraint. With both tasks fixed and no constraint, the same window would report fixed-task.
The other window fields (from, to, capacity, peak, overload, tasks) are on the OverallocationWindow reference. For the load of each bucket, see Resource load.
level throws an InputException for an unknown scope id or a backward-scheduled project, and a ProjectException with code NEEDS_RESYNC after a rejected apply. Both leave the project as it was. See Error handling.
Previewing and clearing#
Because level commits, run it on a copy to show leveling as a proposal. Project#copy is cheap: the data is shared until one copy is edited.
static Project
The step-by-step version is in Preview leveling. To score leveling as part of an alternative change set, use evaluate with EvaluateOptions.level. See Evaluating alternatives.
There are two ways to remove leveling:
- To undo it, set
levelingDelayto 0.0 andpausesto an empty list on the task, thensolve. The original contention comes back. - To level again from scratch, call
levelagain.clearFirstis on by default, so the run first clears the delays and pauses of the in-scope tasks and levels from the clean plan. WithclearFirst = falsethe existing delays and pauses stay, and leveling adds to them. Use that to keep a deliberate gap the user set by hand.
;
;
The levelingDelay update moves B's stored start back by the same amount, so B returns to Monday and the window over Monday and Tuesday comes back. To clear every task, put one such update per task with a delay or pauses into the same change set. The full recipe is in Clear leveling.