Rental phases
Create phases and manage labels, colours, default order, visibility, and archive controls.
Open Admin → Preferences → Rental phases. Requires admin access and the settings.view and settings.manage permissions.
Choose Create Phase (shortcut N), enter a Label, check the suggested snake_case Key and pick a Colour, then select Create Phase. New definitions are appended to the default order. Keys are permanent after creation.
The list shows each phase in its default order with its colour, key and behaviour: On new rentals or Optional, Holds stock when it blocks availability, the timing role it drives, and how many rentals use it. Use the up and down arrows to change the default order. Rental schedules retain their own sequence. Text on colour samples automatically uses a foreground with readable contrast.
Fresh installations include preparation, loading, delivery, installation, event, breakdown, collection, unloading and turnaround. Preparation, delivery, event, collection and turnaround are shown by default. All nine begin with blocking switched off.
Use Archive in a row's actions menu to prevent new selection while keeping attached rental dates readable. Restore makes the definition selectable again. Archiving retains its operational role and blocking setting.
The edit form groups Name and colour, On new rentals and Scheduling effects, and explains what holding stock and each timing role do. Roles are optional, with one definition per role: outbound loading, delivery, event or collection; the role list shows which phase holds each role now. The displayed rental schedule count includes rows across warehouses.
Preview and apply operational changes
- Choose Edit and change Holds stock or Drives timing for. Presentation-only edits can be saved directly with Save Phase.
- On a phase used by rentals the form asks you to Check Impact first. Review the number of rentals whose stock demand will be rebuilt and the booked assignments that keep their dates. Counts include affected rentals across warehouses.
- Select Apply to N Rentals to apply the previewed proposal. The definition change and equipment-demand rebuild run atomically. Availability, operational-board and scheduling caches are refreshed after commit.
A used definition requires a current preview before its blocking or role changes can be saved. Editing the proposal, changing an affected rental schedule, or changing the definition can invalidate that preview. Any further edit clears the preview. If the save asks for a current impact preview, select Check Impact again, review the counts, then apply. A failed rebuild rolls back the definition and demand changes together. Apply locks the affected rentals and definition, then checks that the affected rental set still matches. A changed set refuses the save and asks for another impact preview; no partial change is applied.
Blocking extends inherited equipment demand only in operational mode, and only for complete intervals with end after start. Charge mode uses its independent charge window. Visibility changes display defaults; hiding a blocking phase does not stop it reserving equipment. See rental windows and roles.
Archive and restore
Definitions are archived rather than deleted. An archived definition retains its unique role and blocking setting, so attached schedules keep their operational meaning. To assign that role to another definition, first clear it through the preview/apply flow when required. Restore makes the definition available for new selections. Archiving does not erase rental phases or issued document snapshots.
API administration
The phase-definitions API can create definitions and read, edit, archive and restore them by key. Used operational changes use POST /api/v1/phase_definitions/{key}/impact followed by PATCH with the returned impact_token. All API operations require settings.manage and the matching phase-definitions:read or phase-definitions:write token ability.
The list supports shared timestamp filters such as filter[updated_at][gte] for incremental reads. Hidden and archived definitions remain in the list; use filter[archived][eq] to select active or archived definitions.