D-TRO Beta - initial Data Specification release

department-for-transport-public / D-TRO

Digital Traffic Regulation Orders (D-TRO)

MIT License

3 stars 1 forks source link

D-TRO Beta - initial Data Specification release #1

Open stm-john-cooper opened 3 months ago

stm-john-cooper commented 3 months ago

New issue created to replicate the Issue #38 on the previous Private External repo. Content to follow shortly.

stm-john-cooper commented 3 months ago

As you may be aware, the D-TRO Beta project is currently underway with enhancements proposed to the data model, being conducted by Harrod Booth Consulting Ltd and PA Consulting, working alongside the DfT.

Following release of the service Alpha (previously the 3.1.1 version of the data model), we are pleased to share the initial release as part of the D-TRO Beta project for your input and feedback on, with the main updates around the data model proposed being the implementation of records management, live reporting of TTROs and enabling more effective location referencing.

This issue on the GitHub will be the repository for supporting documentation and artefacts required by those participating in validation and providing feedback during the D-TRO Beta phase; the same files can be found under the CODE menu item.

As part of the current release of the Data Model (version 3.2.0), we are providing the following:

Item	Description	Version	Locator
Data Model (XMI)	XMI extract of the D-TRO Data Model release 3.2.0	Release 3.2.0	https://github.com/Department-for-Transport-External/TRO-DD/blob/main/DTRO-v3.2.0.xmi
Data Model (QEA)	Enterprise Architect (QEA) file of the D-TRO Data Model release 3.2.0	Release 3.2.0	https://github.com/Department-for-Transport-External/TRO-DD/blob/main/DTRO-v3.2.0.qea
Data Model User Guide	Document detailing the content and structure of the D-TRO Data Model	1.0 (for Release 3.2.0)	https://github.com/Department-for-Transport-External/TRO-DD/blob/main/Beta-01-DFT-D-TRO-Data%20Model-User%20Guide-3.2.0_v1.0.pdf
JSON Schema	D-TRO JSON schema release 3.2.0	Release 3.2.0	https://github.com/Department-for-Transport-External/TRO-DD/blob/main/DTRO-v3.2.0.json
JSON Slim JSON sample	JSON sample D-TRO record	Release 3.2.0	https://github.com/Department-for-Transport-External/TRO-DD/blob/main/DTRO-v3.2.0-slim.json
Validation Rules	Document detailing the validation rules	Release 3.2.0	https://github.com/Department-for-Transport-External/TRO-DD/blob/main/Beta-01-DfT-D-TRO-Validation%20rules-v1.0.pdf

stm-john-cooper commented 3 months ago

New files released.

Data Model (XMI)	XMI extract of the D-TRO Data Model release 3.2.1	Release 3.2.1	https://github.com/Department-for-Transport-External/TRO-DD/blob/main/DTRO-v3.2.1.xml
Data Model (QEA)	Enterprise Architect (QEA) file of the D-TRO Data Model release 3.2.1	Release 3.2.1	https://github.com/Department-for-Transport-External/TRO-DD/blob/main/DTRO-v3.2.1.qea
Data Model User Guide	Document detailing the content and structure of the D-TRO Data Model	1.0 (for Release 3.2.1)	https://github.com/Department-for-Transport-External/TRO-DD/blob/main/Beta-01-DfT-D-TRO-Data%20Model-User%20Guide-3.2.1_v1.0.pdf
Interface Control Document (Consumers)	Document detailing the interface and APIs for Data Consumers, v2.0	Release 3.2.1	https://github.com/Department-for-Transport-External/TRO-DD/blob/main/Beta-01-DfT-D-TRO-ICD%20for%20Consumers_v2.0.pdf
Interface Control Document (Publishers)	Document detailing the interface and APIs for Data Publishers, v2.0	Release 3.2.1	https://github.com/Department-for-Transport-External/TRO-DD/blob/main/Beta-01-DfT-D-TRO-ICD%20for%20Publishers-TRA-DSP_v2.0.pdf

JHB9876 commented 2 months ago

Release: 3.2.2

The following documents and artefacts form part of this release. (v3.2.2)

Item	Description	Version	Locator
Data Model (QEA)	Enterprise Architect (QEA) file of the D-TRO Data Model release 3.2.2	Release 3.2.2	(https://github.com/department-for-transport-public/D-TRO/blob/main/DTRO-v3.2.2.qea)
Data Model (XMI)	XMI extract of the D-TRO Data Model release 3.2.2 – XMI 1.0	Release 3.2.2	(https://github.com/department-for-transport-public/D-TRO/blob/main/DTRO-v3.2.2_xmi1_0.xml)
Data Model (XMI)	XMI extract of the D-TRO Data Model release 3.2.2 – XMI 2.1	Release 3.2.2	https://github.com/department-for-transport-public/D-TRO/blob/main/DTRO-v3.2.2_xmi2_1.xml
Data Model User Guide	Document detailing the content and structure of the D-TRO Data Model	1.0 (for Release 3.2.2)	https://github.com/department-for-transport-public/D-TRO/blob/main/Beta-01-DfT-D-TRO-Data%20Model-User%20Guide-3.2.2_v1.0.pdf
Interface Control Document (Consumers)	Document detailing the interface and APIs for Data Consumers, v2.0	2.0 (for Release 3.2.1 & 3.2.2)	https://github.com/department-for-transport-public/D-TRO/blob/main/Beta-01-DfT-D-TRO-ICD%20for%20Consumers_v2.0.pdf
Interface Control Document (Publishers)	Document detailing the interface and APIs for Data Publishers, v2.0	2.0 (for Release 3.2.1 & 3.2.2)	https://github.com/department-for-transport-public/D-TRO/blob/main/Beta-01-DfT-D-TRO-ICD%20for%20Publishers-TRA-DSP_v2.0.pdf
Validation Rules	Document detailing the validation rules, v1.0	1.0 (for Release 3.2.0, 3.2.1, 3.2.2)	https://github.com/department-for-transport-public/D-TRO/blob/main/Beta-01-DfT-D-TRO-Validation%20rules-v1.0.pdf
JSON Schema	D-TRO JSON schema release 3.2.2	Release 3.2.2	https://github.com/department-for-transport-public/D-TRO/blob/main/DTRO-v3.2.2.json
JSON Sample files	Several JSON sample files, with filename “JSON-example-????-dtro-3.2.2” where ???? provides a brief description	Release 3.2.2	https://github.com/department-for-transport-public/D-TRO/blob/main/JSON-example-fullAmendment-dtro-3.2.2.json
			https://github.com/department-for-transport-public/D-TRO/blob/main/JSON-example-fullRevoke-dtro-3.2.2.json
			https://github.com/department-for-transport-public/D-TRO/blob/main/JSON-example-new-dtro-3.2.2.json
			https://github.com/department-for-transport-public/D-TRO/blob/main/JSON-example-partialAmendment-dtro-3.2.2.json
			https://github.com/department-for-transport-public/D-TRO/blob/main/JSON-example-partialRevoke-dtro-3.2.2.json

JHB9876 commented 2 months ago

On behalf of DfT:

The following lists changes in the D-TRO Data Model between v3.2.0 and v3.2.2.

Ref.	Nature of change	Tracker ID
1	Source.traAffected attribute data type changed to an array of int (integers)	1
2	ExternalReference class made optional. Relationship from PointGeometry [0..1] to ExternalReference [0..1]; Relationship from LinearGeometry [0..1] to ExternalReference [0..]; Relationship from Polygon [0..1] to ExternalReference [0..]; Three relationships from DirectedLinear [all 0..1] to ExternalReference all have lower bound multiplicity 0.	2
3	Classes LicenseCharacteristics and AgeOfDriver removed from Conditions package. Enum list licenseCharacteristicsType removed.	4
4	Two missing association added - association - "ChangeableTimePeriodEnd" [1] and "ChangeableTimePeriodSource" [0..1]; association - "ChangeableTimePeriodEnd" [1] and "ChangeableTimePeriodEntry" [0..*].	5
5	Typo correction attribute name -"legislationCrossReference"	6, 22
6	RegulationType enumeration entries with prefixed "other" have been replaced by "misc". Enumeration entry "other" added. Enumeration entries to support TTRO regulations added "miscRoadClosure", "miscLaneClosure", "miscContraflow", "miscFootwayClosure", "miscCycleLaneClosure", "miscTemporaryParkingRestriction", "miscSuspensionOfOneWay", "miscSuspensionOfParkingRestriction", "miscSuspensionOfWeightRestriction", "miscTemporarySpeedLimit", "miscRoadClosureCrossingPoint", "miscBaySuspension", "miscTemporaryParkingBay", "miscPROWClosure"	7
7	Adjust association to - Provision [1] to Regulation [1]	14
8	Provision.provisionIndex attribute has been removed.	15, 16
9	regulationType attribute only retained for GeneralRegulation class; removed from Regulation class.	18
10	schemeIdentifier and permitIdentifier typos corrected in PermitCondition class.	36
11	Authority.name attribute ID property removed, and typed as a string.	38
12	Consultation.pointOfContactEmail attribute renamed.	43
13	Add "other" enumeration entries to PayloadType, VehicleEquipmentType and VehicleUsageType and VehicleType, to support extension mechanism. VehicleType has been added to the TargetEnumeratedList Enum.	45
14	Add additional permissable Enum for 'nationalSpeedLimitMotorway' in SpeedLimitProfileType.	48
15	The Package name "Validity" and class name "OverallPeriod" have both been changed to "TimeValidity". The package "ValidityEnumerations has been renamed "TimeValidityEnumerations	50
16	Class name for all ENUM classes written in UpperCamelCase.	51
17	RateLine.description attribute data type changed to string

JHB9876 commented 1 month ago

On behalf of DfT:

Release: 3.2.3

Note of release

We are pleased to share the partial release of files relating to the data specification (version 3.2.3). The ICDs for the APIs are to be released next week, following completion of API-related updates.

This includes updates to the data model and the schema to address schema inconsistencies, mainly around geospatial referencing and encoding. The data model requires all spatial coordinates to be coded using WKT (Well Known Text), with OSGB36 National Grid as the default coordinate reference system to be used (SRID - 27700). Further details can be found in the User Guide, with sample files provided showing example references for each type of geometry.

The following documents and artefacts form part of this release. (v3.2.3)

Item	Description	Version	Locator
Data Model (QEA)	Enterprise Architect (QEA) file of the D-TRO Data Model release 3.2.3	Release 3.2.3	https://github.com/department-for-transport-public/D-TRO/blob/main/DTRO-v3.2.3.qea
Data Model (XMI)	XMI extract of the D-TRO Data Model release 3.2.3 – XMI 1.0	Release 3.2.3	https://github.com/department-for-transport-public/D-TRO/blob/main/DTRO-v3.2.3_xmi1_0.xml
Data Model (XMI)	XMI extract of the D-TRO Data Model release 3.2.3 – XMI 2.1	Release 3.2.3	https://github.com/department-for-transport-public/D-TRO/blob/main/DTRO-v3.2.3_xmi2_1.xml
Data Model User Guide	Document detailing the content and structure of the D-TRO Data Model	1.0 (for Release 3.2.3)	https://github.com/department-for-transport-public/D-TRO/blob/main/Beta-01-DfT-D-TRO-Data%20Model-User%20Guide-3.2.3_v1.0.pdf
Interface Control Document (Consumers)	Document detailing the interface and APIs for Data Consumers, v2.0	2.0 (for Release 3.2.3)	(to be released w. 7th Oct)
Interface Control Document (Publishers)	Document detailing the interface and APIs for Data Publishers, v2.0	2.0 (for Release 3.2.3)	(to be released w. 7th Oct)
Validation Rules	Document detailing the validation rules, v3.2.3	1.0 (for Release 3.2.3)	https://github.com/department-for-transport-public/D-TRO/blob/main/Beta-01-DfT-D-TRO-Validation%20rules-v3.2.3.pdf
JSON Schema	D-TRO JSON schema release 3.2.3	Release 3.2.3	https://github.com/department-for-transport-public/D-TRO/blob/main/DTRO-v3.2.3.json
JSON Sample files	Several JSON sample files, with filename “JSON-3.2.3-example-????-dtro” where ???? provides a brief description	Release 3.2.3	Example: https://github.com/department-for-transport-public/D-TRO/blob/main/JSON-3.2.3-example-directed-linear-dtro.json

JHB9876 commented 1 month ago

On behalf of DfT:

To validate the version 3.2.3 sample JSON files against the version 3.2.3 schema using an online validator please ensure you remove the initial lines and one set of curly brackets at the end of the sample JSON, from the sample files as shown below.

{ "schemaVersion": "3.2.3", "data": [data content] }

At present the sample files current point to non-existent TRAs. For testing purposes please modify these to TRA that do appear in the SWA code list (in currentTraOwner, traCreator, or traAffected).

The list of SWA codes is available at:

https://www.geoplace.co.uk/local-authority-resources/street-works-managers/view-swa-codes

Alternatively, email dtro-cso@dft.gov.uk to ask us what the relevant code is.

JHB9876 commented 1 month ago

On behalf of DfT:

We have also published two Interface Control Documents relating to Data Specification v3.2.3.

Item	Description	Version	Locator
Interface Control Document (Consumers)	Document detailing the interface and APIs for Data Consumers, v2.1	2.1 (for Release 3.2.3)	https://github.com/department-for-transport-public/D-TRO/blob/main/Beta-01-DfT-D-TRO-ICD%20for%20Consumers_v2.1.pdf
Interface Control Document (Publishers)	Document detailing the interface and APIs for Data Publishers, v2.1	2.1 (for Release 3.2.3)	https://github.com/department-for-transport-public/D-TRO/blob/main/Beta-01-DfT-D-TRO-ICD%20for%20Publishers-TRA-DSP_v2.1.pdf

stm-john-cooper commented 1 month ago

[like] John Cooper reacted to your message:

From: JHB9876 @.> Sent: Thursday, October 10, 2024 1:49:14 PM To: department-for-transport-public/D-TRO @.> Cc: John Cooper @.>; Author @.> Subject: Re: [department-for-transport-public/D-TRO] D-TRO Beta - initial Data Specification release (Issue #1)

On behalf to DfT: We have also published two Interface Control Documents relating to Data Specification v3. 2. 3. Item Description Version Locator Interface Control Document (Consumers) Document detailing the interface and APIs for Data Consumers,

On behalf to DfT:

We have also published two Interface Control Documents relating to Data Specification v3.2.3.

Item Description Version Locator Interface Control Document (Consumers) Document detailing the interface and APIs for Data Consumers, v2.1 2.1 (for Release 3.2.3) https://github.com/department-for-transport-public/D-TRO/blob/main/Beta-01-DfT-D-TRO-ICD%20for%20Consumers_v2.1.pdf https://urldefense.com/v3/__https://github.com/department-for-transport-public/D-TRO/blob/main/Beta-01-DfT-D-TRO-ICD*20for*20Consumers_v2.1.pdf__;JSU!!HEBAkwG3r5RD!_rzkblQJQGuDuitMEPAz7MY0VXle1rVPpLcmNnjCQTZhlNO7tfNaNr7axyqoTMtypa50ixVhw6rcK7gdZBigsE9LDb5NrGI$ Interface Control Document (Publishers) Document detailing the interface and APIs for Data Publishers, v2.1 2.1 (for Release 3.2.3) https://github.com/department-for-transport-public/D-TRO/blob/main/Beta-01-DfT-D-TRO-ICD%20for%20Publishers-TRA-DSP_v2.1.pdf https://urldefense.com/v3/__https://github.com/department-for-transport-public/D-TRO/blob/main/Beta-01-DfT-D-TRO-ICD*20for*20Publishers-TRA-DSP_v2.1.pdf__;JSU!!HEBAkwG3r5RD!_rzkblQJQGuDuitMEPAz7MY0VXle1rVPpLcmNnjCQTZhlNO7tfNaNr7axyqoTMtypa50ixVhw6rcK7gdZBigsE9LoqBfKkM$

— Reply to this email directly, view it on GitHubhttps://urldefense.com/v3/__https://github.com/department-for-transport-public/D-TRO/issues/1*issuecomment-2405150430__;Iw!!HEBAkwG3r5RD!_rzkblQJQGuDuitMEPAz7MY0VXle1rVPpLcmNnjCQTZhlNO7tfNaNr7axyqoTMtypa50ixVhw6rcK7gdZBigsE9LDn4h_RA$, or unsubscribehttps://urldefense.com/v3/__https://github.com/notifications/unsubscribe-auth/ARIV5RM7QOD65KV4SQKWLYLZ22AVVAVCNFSM6AAAAABLX5SVA6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIMBVGE2TANBTGA__;!!HEBAkwG3r5RD!_rzkblQJQGuDuitMEPAz7MY0VXle1rVPpLcmNnjCQTZhlNO7tfNaNr7axyqoTMtypa50ixVhw6rcK7gdZBigsE9LxIVDktM$. You are receiving this because you authored the thread.Message ID: @.***>

This email has originated from external sources and has been scanned by DfT’s email scanning service.

The information in this email may be confidential or otherwise protected by law. If you received it in error, please let us know by return e-mail and then delete it immediately, without printing or passing it on to anybody else. Incoming and outgoing e-mail messages are routinely monitored for compliance with our policy on the use of electronic communications and for other lawful purposes.

JHB9876 commented 1 month ago

On behalf of DfT:

Release: 3.2.4

In preparation for the launch of the D-TRO Private Beta service we have encouraged and welcome private beta participants to on-board with the service and undertake connection testing in the Integration Environment. This has raised a number of issues (mainly via GitHub) that we have sought to resolve with this data specification release.

The following documents and artefacts form part of this release.

Item	Description	Version	Locator
Data Model (QEA)	Enterprise Architect (QEA) file of the D-TRO Data Model release 3.2.4	Release 3.2.4	https://github.com/department-for-transport-public/D-TRO/blob/main/DTRO-v3.2.4.qea
Data Model (XMI)	XMI extract of the D-TRO Data Model release 3.2.4 – XMI 1.1	Release 3.2.4	https://github.com/department-for-transport-public/D-TRO/blob/main/DTRO-v3.2.4-v1.1.xml
Data Model (XMI)	XMI extract of the D-TRO Data Model release 3.2.4 – XMI 2.1	Release 3.2.4	https://github.com/department-for-transport-public/D-TRO/blob/main/DTRO-v3.2.4-v2.1.xml
Data Model User Guide	Document detailing the content and structure of the D-TRO Data Model	1.0 (for Release 3.2.4)	https://github.com/department-for-transport-public/D-TRO/blob/main/Beta-01-DfT-D-TRO-Data%20Model-User%20Guide-3.2.4_v1.0.pdf
Interface Control Document (Consumers)	Document detailing the interface and APIs for Data Consumers, v2.1	2.1 (for Release 3.2.4)	https://github.com/department-for-transport-public/D-TRO/blob/main/Beta-01-DfT-D-TRO-ICD%20for%20Consumers_v2.1.pdf
Interface Control Document (Publishers)	Document detailing the interface and APIs for Data Publishers, v2.1	2.1 (for Release 3.2.4)	https://github.com/department-for-transport-public/D-TRO/blob/main/Beta-01-DfT-D-TRO-ICD%20for%20Publishers-TRA-DSP_v2.1.pdf
Validation Rules	Document detailing the validation rules, v3.2.4	Release 3.2.4	https://github.com/department-for-transport-public/D-TRO/blob/main/Beta-01-DfT-D-TRO-Validation%20rules-v3.2.4.pdf
JSON Schema	D-TRO JSON schema release 3.2.4	Release 3.2.4	https://github.com/department-for-transport-public/D-TRO/blob/main/DTRO-v3.2.4.json
JSON Sample files	Several JSON sample files, with filename “JSON-3.2.4-example-????-dtro” where ???? provides a brief description	Release 3.2.4	Example: https://github.com/department-for-transport-public/D-TRO/blob/main/JSON-3.2.4-example-directed-linear-dtro.json

JHB9876 commented 3 weeks ago

On behalf of DfT:

Release: 3.2.4 - additional content

In response to comments raised by users we have:

Issued a new release of the ICD (Interface Control Documents) - these are version 2.2.
Issued new sample TRO files - showing our expectation of how various TROs and TTROs are coded.

We have removed earlier v3.2.4 sample files.

The following documents and artefacts form part of this release.

Item	Description	Version	Locator
Interface Control Document (Consumers)	Document detailing the interface and APIs for Data Consumers, v2.2	2.2 (for Release 3.2.4 onwards)	https://github.com/department-for-transport-public/D-TRO/blob/main/Beta-01-DfT-D-TRO-ICD%20for%20Consumers_v2.2.pdf
Interface Control Document (Publishers)	Document detailing the interface and APIs for Data Publishers, v2.2	2.2 (for Release 3.2.4 onwards)	https://github.com/department-for-transport-public/D-TRO/blob/main/Beta-01-DfT-D-TRO-ICD%20for%20Publishers-TRA-DSP_v2.2.pdf
JSON Sample files	Several JSON sample files, with filename “JSON-3.2.4-example-????-” where ???? provides a brief description	Release 3.2.4	Example: https://github.com/department-for-transport-public/D-TRO/blob/main/JSON-3.2.4-example-TTRO-HeightRestriction.json