SIGNALS Documentation
API Reference

Rental Diary

An overlap timeline of quotes and orders across a configurable planning window, with lane-packed job cards coloured by workflow status and Delivery / In-Use / Collection phase bands.

Overview

The Rental Diary is a visual overlap timeline of all active quotes and orders plotted across a date window, so you can see at a glance when jobs run, how they overlap, and which customer is taking delivery or returning equipment. It is a planning and coordination view — it does not itself create or modify jobs; those are managed on the Rentals pages.

Route: /rental-diary

The rental diary lives under the Rental Planning section of the main navigation and is gated on the rentals.access permission.

The Timeline

Jobs are packed into horizontal lanes by the EventLaneAllocator — concurrent jobs that genuinely overlap sit side-by-side rather than hiding each other. The grid is a horizontal day-column layout that fills its panel edge-to-edge.

Each job appears as a card spanning its hire window. The card background colour reflects the rental's current workflow status (driven by RentalStatus via the shared RentalPresentation service):

Colour Status
Grey Enquiry / Unconfirmed
Amber Quote / Provisional
Violet Quote / Reserved
Blue Order / Active, Dispatched, or On Hire
Green Order / Returned, Checked, or Complete
Red Lost, Dead, or Cancelled

A colour key / legend below the filter bar identifies each status swatch plus the Delivery / In-Use / Collection phase bands and Customer Collecting / Returning badges.

Job cards

Each card shows:

  • Number — title as the headline
  • Date/time range for the hire window
  • Venue address when set on the rental
  • Status line with per-status colour and label
  • Rental tags when present
  • Customer Collecting and Customer Returning badges when those flags are set

The whole card links to the rental detail page.

Phase bands

Where a rental carries rental lifecycle dates, a status row beneath the card body is subdivided into up to three phase bands snapped to day columns:

  • Delivery — the delivery window (deliver_starts_at to deliver_ends_at).
  • In Use — the show/event window (show_starts_at to show_ends_at), or the full hire span when no show dates are set.
  • Collection — the collection window (collect_starts_at to collect_ends_at).

Phase band colours are shared with the Equipment Availability booking grids via RentalPresentation.

Heatmap and weekends

A per-day job-count row above the lanes uses colour intensity to show load (more jobs = deeper tint). Weekend columns are shaded to help read multi-week windows at a glance.

Filters & Controls

The sticky filter bar exposes the following controls; all settings are reflected in the URL so a rental diary link re-opens exactly as shared:

Control Effect
Warehouses Multi-warehouse tag-input filter (empty = all in-default-query warehouses). Uses PlanningWarehouseFilter.
Start date The first day of the planning window. Signals datepicker; defaults to today.
Previous / Today / Next Shift the window backwards or forwards by one full period.
Zoom Window width: 1 Week (7 days), 2 Weeks (14 days), or 1 Month (30 days).
Presets Next 30 days, This Month, or Next Month (overrides zoom when active).
Orders / Quotes Toggle switches to include or exclude order-state and quotation-state jobs. Both on by default.
Search Free-text filter across job title, rental number, and account name.

The default view is 1 Month with both orders and quotes included.

Layout chrome

  • Sticky control bar — page header and filter panel stay pinned while scrolling the grid.
  • Sticky day headers — day labels and the job-count heatmap row remain visible above the lane area.
  • Loading skeleton — a deferred grid skeleton paints on first load before jobs are fetched (wire:init).

Counts

Three badge counters above the rental diary show the total Jobs, Orders, and Quotes visible in the current window after filters are applied.

  • Rentals — create and manage the jobs shown on the rental diary.
  • Equipment Availability — see equipment stock across the same window and drill into per-catalogue item bookings.