Skip to content

Add BSP vocabulary and clickable overview diagram pipeline

Steve CAPELL requested to merge bsp-vocabulary-overview into main

Summary

Adds two pieces of conceptual documentation to the vocabulary and retires the superseded overview pipeline.

Transport movement model (methodology/transport-movement-model.md)

A design note that models how a transport movement (ocean voyage, road trip, rail journey, flight) decomposes into calls, legs, events and consignments — reconciling the UN/CEFACT MMT-RDM with DCSA (ocean) and IATA ONE Record (air). It is presented as three focused class views (movement/carrier, cargo structure, events) plus a full canonical appendix diagram, and is exported to PNG and PDF for printing. All claims are grounded in the local CCL extract (raw/Reference_BIEs.csv), with a source crosswalk and an explicit CCL-divergence analysis. Key modelling decisions captured: the carrier-issued identifier lives on the movement (with a distinct leg carrier for interline/VSA/feeder cases); a first-class TransportLeg mediates the many-to-many between house and master consignments (no recursive tree); one event class per entity lifecycle; and cargo events attach to a TransportPackage or TransportEquipment, anchored to a Location.

UNSCRO overview + clickable diagram (vocabulary/unscro.md)

An introduction to the UN Supply Chain Reference Ontology as a navigation framework that organises the supply-chain vocabularies into seven domains (Production, Conformity, Trade, Transport, Regulatory, Identity, Finance), defining each entity and its relationships to its neighbours. The page embeds an interactive diagram: hovering a box shows its definition and clicking opens the term in the UN/CEFACT vocabulary (in a new tab).

The diagram is built as a master + annotation pair so the StarUML export is never hand-edited: unscro.svg is the master (with unscro.mdj as its source model), unscro-links.json maps each box label to a vocabulary URL and hover definition, and scripts/annotate-unscro.mjs overlays a clickable link and tooltip on every matched class box to produce unscro.annotated.svg and a standalone preview page. It currently links 26 of 51 boxes to vocabulary.uncefact.org (BSP) and /untp (UNTP); the remainder are intentionally left unlinked until matching terms are confirmed. Re-run with npm run annotate:unscro after any StarUML re-export.

Cleanup

Removes the earlier hand-curated bsp-overview PlantUML/master-SVG artifacts and their now-dead scripts (gen-master-svg.mjs, build-overview.mjs), which UNSCRO supersedes, and updates package.json accordingly.

Follow-ups (not in this MR)

Map the remaining ~25 diagram entities to vocabulary terms; fix a few typos in the StarUML source (Regultion, Finance Agrement, corssing, trasnported); and elaborate the provisional Finance domain.

Note: the raw/BRS_BuyShipPay_v1.0.md conversion produced this session (source for the BSP definitions) sits under the git-ignored raw/ folder, so it isn't part of the MR — mention it only if you want it tracked elsewhere.

Merge request reports

Loading