01 — Quick Reference

Group Models
Cartage Jobs CartageJob · CartageJobEquipment · CartageDispatch · CartageMilestone · CartageProofOfDelivery · CartageException
Contractor Rates & Costs CartageContractorRate · CartageContractorCost
Audit & Network CartageAudit · CartageExternalSnapshot
Reference Copies CartageContractor · CartageDeliveryLocation · CartagePort · CartageCustomer

Every model (14) — one line each

Model It records Key foreign keys
CartagePort Local copy of a port —
CartageCustomer Local copy of a customer —
CartageContractor A road haulage contractor —
CartageDeliveryLocation A customer-side pickup or delivery location in a port CartagePort
CartageContractorRate The contractor purchase rate: contractor, port, location, direction, equipment, basis, validity CartageContractor, CartagePort, CartageDeliveryLocation
CartageJob One cartage job for a consignment: route, contractor, payer, release and customer-price links, status CartageCustomer, CartagePort, CartageDeliveryLocation, CartageContractor
CartageJobEquipment A container or cargo unit carried by the job CartageJob
CartageDispatch The contractor's vehicle and driver for a job CartageJob, CartageContractor
CartageMilestone A transport milestone, or a yard gate observation (evidence) confirmed by tracking CartageJob
CartageProofOfDelivery Who received what, where, in what condition, with evidence; verified independently CartageJob
CartageContractorCost The contractor's invoiced cost: estimate, actual, tax, supplier invoice line, approval, exact reversal CartageJob, CartageContractorRate
CartageException A shortage, damage, gate mismatch, POD mismatch, tracking rejection or duplicate cost CartageJob
CartageAudit Who did what to a job, POD or cost CartageJob
CartageExternalSnapshot A versioned copy of what another application published —

Vocabularies

  • CartageJob.status: DRAFT · ASSIGNED · DISPATCHED · PICKED_UP · DELIVERED · CLOSED · CANCELLED
  • CartageJob.direction: PICKUP (customer to port) · DELIVERY (port to customer)
  • CartageJob.payer_type: CARRIER · AGENT · CUSTOMER
  • CartageContractorRate.basis: TRIP · CONTAINER · RT · FLAT — status: DRAFT · APPROVED · RETIRED
  • CartageContractor.status: ACTIVE · SUSPENDED · INACTIVE
  • CartageDispatch.status: RESERVED · DISPATCHED · COMPLETED · CANCELLED
  • CartageMilestone.milestone_type: DISPATCHED · ARRIVED_PICKUP · PICKED_UP · IN_TRANSIT · ARRIVED_DELIVERY · DELIVERED · GATE_OUT_OBSERVED · GATE_IN_OBSERVED — status: RECORDED · OBSERVED · CONFIRMED · REJECTED · RECONCILED
  • CartageProofOfDelivery.status: RECORDED · VERIFIED · REJECTED
  • CartageContractorCost.status: DRAFT · APPROVED · REVERSED
  • CartageException.exception_type: SHORTAGE · DAMAGE · GATE_MISMATCH · TRACKING_REJECTED · POD_MISMATCH · DUPLICATE_COST — control_code: CARTAGE_DELIVERY_EXCEPTION · DUPLICATE_COST

Messages (shipping_cargo_voyage)

Direction Event
publishes cartage.job_changed · cartage.pod_verified · cartage.cost_approved · cartage.exception_raised · cartage.exception_resolved
consumes voyage.snapshot · voyage.portcall_snapshot · voyage.cargo_call_mapped · manifest.effective_cargo · accounts.appointment_changed · release.authority_changed · portcost.cost_approved · yard.gate_recorded · tracking.movement_accepted · tracking.movement_rejected · assurance.action_requested

Run, seed, regenerate

python server/run.py coast_09_cartage                    # http://localhost:5162
python -m codegen.cli all coast_09_cartage               # regenerate models, controllers and JSON after a schema change
python -m codegen.cli seed coast_09_cartage --reset      # reload the sample data
python scripts/build_diagram_viewer.py coast_09_cartage  # rebuild the interactive diagram