Quick Reference

Menu map, the demo dataset and its codes, and the status vocabularies for PortCalls.

Group Models
Commercial ServiceContract · Voyage · VoyageParty
Fleet & Routes Vessel · VesselCertificate · Port · Terminal · Berth · Route
Cargo Commodity · CargoBooking · CargoConsignment · CargoTransportUnit · DangerousGoodsDeclaration · CargoDocument · CargoReadiness
Stowage & Handling StowagePlan · StowagePosition · CargoSecuringInspection · CargoHandlingEquipment
Port Calls PortCall · PortCallDeclaration · PortServiceRequest · BerthWindow · PortCallMilestone
Cargo Operations LoadingOperation · LoadingTally · StatementOfFacts
Voyage Execution VoyageLeg · VoyageReadiness · VoyagePosition · OperationalEvent · Delay
Performance & Records VoyagePerformance · Evidence · Notification
Administration Organisation · Person

The demo dataset — one voyage, end to end

The seed tells a single coherent story: voyage CP-2026-031, general-cargo ship Coastal Pioneer carrying 7,110 t of solar-farm project cargo from Brisbane (Fisherman Islands) to Gladstone (Auckland Point) for the Gladstone Solar Farm JV, in August 2026. 142 rows across all 38 models.

The exception that drives the story

Two transformer transport frames fail terminal acceptance at Brisbane (OperationalEvent "Transformer frames fail terminal acceptance"). Loading is suspended for those units (LoadingTally movement REJECTED), cargo readiness drops to READY_WITH_CONDITIONS, stowage plan SP-031-A is superseded by SP-031-B, and departure slips 6 hours (Delay, category CARGO, shipper responsible, demurrage applicable). The frames are reinforced and re-inspected, terminal acceptance is attached, plan B is approved, the securing inspection passes (CSI-031-02 PASS) and the master approves departure on a READY VoyageReadiness. The StatementOfFacts records the shipper delay.

Codes you will see

Code / number What it is
CP-2026-031 the voyage
ACS-COA-2026-07 the contract of affreightment
BNE-GLT the Brisbane→Gladstone route
ACS-PRJ-2201 the project-cargo booking (7,200 t booked, 7,110 t loaded)
ACS-GEN-2202 the containerised balance-of-plant booking
CN-2201-01/02/03 consignments: transformers · steel · cable drums
SRETX0001/0002 the two transformer flat-racks (CargoTransportUnit)
SREBOP0001 the container carrying its VGM
DG-2201-01 the transformer-oil DG declaration (UN3082, Class 9, marine pollutant)
SP-031-A / SP-031-B the superseded and in-use stowage plans
PC-2026-0311 / -0312 the Brisbane load call and Gladstone discharge call
OP-0311-L / OP-0312-D the load and discharge operations
SOF-0311 / -0312 the statements of facts
EV-00001…00005 evidence: load photo · manifest · frame-damage photo · signed SOF · discharge tally

The main organisations (of 15)

ACS Australian Coastal Services (operator) · SXH Southern Cross Ship Holdings (owner) · SRE Sunstate Renewables (charterer) · SRL Sunstate Renewables Logistics (shipper) · GSJ Gladstone Solar Farm JV (consignee) · HAS Harbour Agency Services (agent) · PBPL / GPC port authorities · FIT / GMCT terminal operators · CSC stevedore · QCP pilotage · RTS towage · MSP surveyor · AMSA regulator.

Status vocabularies

The important enumerations (UPPERCASE in the data). Free-text status / priority fields are not enumerated.

  • Voyage voyage_status: PROPOSED → PLANNED → CONFIRMED → READY → LOADING → DEPARTED → UNDERWAY → ARRIVED → DISCHARGING → COMPLETED (or CANCELLED).
  • PortCall port_call_status: PROPOSED → REQUESTED → CONFIRMED → APPROACHING → ARRIVED → ALONGSIDE → WORKING → COMPLETED → DEPARTED (or CANCELLED).
  • CargoBooking booking_status: ENQUIRY → PROVISIONAL → CONFIRMED → CARGO_READY → LOADED → DISCHARGED → COMPLETED (or CANCELLED).
  • CargoConsignment consignment_status: DECLARED → ACCEPTED → AT_TERMINAL → LOADED → DISCHARGED → RELEASED.
  • CargoReadiness / VoyageReadiness overall_result: READY · READY_WITH_CONDITIONS · NOT_READY.
  • DangerousGoodsDeclaration validation_status: DRAFT · VALID · WARNING · INVALID · ACCEPTED.
  • StowagePlan plan_status: DRAFT · CHECKED · APPROVED · IN_USE · SUPERSEDED.
  • CargoSecuringInspection result: PASS · PASS_WITH_CONDITIONS · FAIL.
  • LoadingOperation operation_status: PLANNED · READY · IN_PROGRESS · SUSPENDED · COMPLETED · CANCELLED.
  • Delay delay_status: OPEN → ASSESSED → AGREED / DISPUTED → CLOSED; and delay_category: WEATHER · BERTH_UNAVAILABLE · PILOTAGE · TOWAGE · CARGO · TERMINAL · VESSEL · DOCUMENTATION · REGULATORY · LABOUR · OTHER.
  • PortCallMilestone milestone_type: ETA_UPDATE · PILOT_ON_BOARD · FIRST_LINE · ALL_FAST · GANGWAY_DOWN · OPERATIONS_START · OPERATIONS_COMPLETE · DOCUMENTS_COMPLETE · LAST_LINE · DEPARTURE.
  • VoyagePerformance performance_status: PRELIMINARY · RECONCILED · APPROVED.

Rules of thumb (Phase 2 — holding, not enforced)

  • A container transport unit carries a VGM (method, verifier, timestamp) before it loads.
  • A stowage plan is APPROVED/IN_USE only with the DG-segregation, stack-weight and hull-strength checks done and a master approver.
  • A berth window fits the vessel — LOA and draft within the berth limits.
  • A failed securing inspection blocks departure and raises a high-priority notification; a corrective inspection follows.
  • A voyage reaches READY only on a VoyageReadiness with every stream true.
  • delay_hours, capacity_utilisation_percent, schedule_variance_hours and cargo_tonne_nm are derived — computed in the seed, not by a live engine.

Running it

python server/run.py portcall          # http://localhost:5043
python apps/portcall/scripts/seed_data.py   # (idempotent) load the demo voyage