UC:Use cases: Difference between revisions
[checked revision] | [checked revision] |
Tag: Reverted |
(→List of inactive use cases: +Legend) |
||
(16 intermediate revisions by 3 users not shown) | |||
Line 7: | Line 7: | ||
==What is a use case?== | ==What is a use case?== | ||
<div id="t*"></div>A use case can be defined as ''a single task, performed by the end user of a system, that has some useful outcome''[ | <div id="t*"></div>A use case can be defined as ''a single task, performed by the end user of a system, that has some useful outcome''<ref>[https://www.researchgate.net/publication/235701034_OO_design_process_Use_cases_an_introduction_Designing_the_dynamic_runtime_behavior_of_a_program OO design process: Use cases, an introduction: Designing the dynamic (runtime) behavior of a program]</ref><ref>{{external|https://www.engr.sjsu.edu/fayad/current.courses/cmpe202-Fall2009/docs/lecture2/CmpE202-Use-Cases-3.pdf|archive=https://web.archive.org/web/20210412214029/https://www.engr.sjsu.edu/fayad/current.courses/cmpe202-Fall2009/docs/lecture2/CmpE202-Use-Cases-3.pdf}}</ref>. It is described as a list of steps (actions or events) to achieve this outcome. | ||
A use case in terms of {{rml}} is an application of data exchange between at least two IT systems in the railway domain, where {{rml}} can be used as a format and language for the data to be exchanged. The aim of the use case description is to formulate requirements on the technical implementation of the data exchange. | A use case in terms of {{rml}} is an application of data exchange between at least two IT systems in the railway domain, where {{rml}} can be used as a format and language for the data to be exchanged. The aim of the use case description is to formulate requirements on the technical implementation of the data exchange. | ||
Line 19: | Line 19: | ||
===List of active use cases=== | ===List of active use cases=== | ||
[[wiki3:Template:UC:Use cases/table|View/edit list on the separate source page]] | <!-- [[wiki3:Template:UC:Use cases/table|View/edit list on the separate source page]] --> | ||
{{UC:Use cases/table}} | {{raw:wiki3:UC:Use cases/table}} | ||
===List of inactive use cases=== | ===List of inactive use cases=== | ||
Line 26: | Line 26: | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
! style="width:5%"|<div style="writing-mode: tb-rl;">Directing Subschema</div> !! <div style="writing-mode: tb-rl;">Involved Subschemas</div> !! <div style="writing-mode: tb-rl;">Implemented in {{rml}} version<br />(lowest)</div> !! <div style="writing-mode: tb-rl;">Implemented in {{rml}} version<br />(highest)</div> !! <div style="writing-mode: tb-rl;">Priority</div> !! style="width:15%"|Description (EN) !! style="width:15%"|Description (DE) !! <div style="writing-mode: tb-rl;">Abbreviation</div> !! style="width:15%"|Reported by !! Status<br><span style="font-size: | ! style="width:5%"|<div style="writing-mode: tb-rl;">Directing Subschema</div> !! <div style="writing-mode: tb-rl;">Involved Subschemas</div> !! <div style="writing-mode: tb-rl;">Implemented in {{rml}} version<br />(lowest)</div> !! <div style="writing-mode: tb-rl;">Implemented in {{rml}} version<br />(highest)</div> !! <div style="writing-mode: tb-rl;">Priority</div> !! style="width:15%"|Description (EN) !! style="width:15%"|Description (DE) !! <div style="writing-mode: tb-rl;">Abbreviation</div> !! style="width:15%"|Reported by !! Status<br><span style="font-size:80%">[[UC:Use_cases#How_to_interpret_the_status|How to interpret the status]]</span> !! Reason<br><span style="font-size:80%">Why is this UC on hold?</span> | ||
|- | |- | ||
|TT | |TT | ||
Line 87: | Line 87: | ||
|postponed | |postponed | ||
|Currently no demand | |Currently no demand | ||
|- | |||
|colspan=11|{{anchor|legend|Legend:}}<br> | |||
<font color="red">Red: Writer known; reviewed</font color><br> | |||
<font color="green">Green: Writer known; not reviewed</font color><br> | |||
Priority: "X" means that work is finished, "1" is the highest priority.<br> | |||
Status: [[UC:Use_cases#How_to_interpret_the_status|How to interpret the status]] | |||
|} | |} | ||
Line 92: | Line 98: | ||
<div style="writing-mode: tb-rl;"></div> | <div style="writing-mode: tb-rl;"></div> | ||
{|class="wikitable" | {|class="wikitable" | ||
!rowspan=2| ! | <!--|- style="vertical-align:top;"--> | ||
|rowspan=2 colspan=2| | |||
!rowspan=2|Status!!rowspan=2|Description!!colspan=5|Participation | |||
|- | |- | ||
!<div class="rotated">{{rml}} community</div>!!<div class="rotated">reporting party</div>!!<div class="rotated">{{rml}} scheme coordinator</div>!!<div class="rotated">{{rml}} governance board</div>!!<div class="rotated">{{rml}} scheme development group</div> | |||
|- | |- | ||
|rowspan=3|<div class="rotated">'''pre development'''</div> | !rowspan=7|<div class="rotated" style="font-size:100%">Phase</div> | ||
| | !rowspan=3|<div class="rotated">'''pre development'''</div> | ||
|''outlined'' | |||
|The use case has been outlined, a rough idea has been discussed but there is no document, nor draft of one yet. Usually no article about this use case is available in the wiki yet, however, sometimes some basic ideas will have been published | |||
|style="text-align:center;"|× | |style="text-align:center;"|× | ||
| | | | ||
Line 105: | Line 115: | ||
|- | |- | ||
|''draft'' | |''draft'' | ||
| | |A member of the community has submitted a draft of the use case description. This draft is available in the wiki and can be found above. | ||
| | | | ||
|style="text-align:center;"|☒ | |style="text-align:center;"|☒ | ||
Line 113: | Line 123: | ||
|- | |- | ||
|''consolidated'' | |''consolidated'' | ||
|the | |The submitted draft of the use case description has been reviewed by another community member and the schema coordinator has accepted it. | ||
|style="text-align:center;"|× | |style="text-align:center;"|× | ||
|style="text-align:center;"|× | |style="text-align:center;"|× | ||
Line 120: | Line 130: | ||
|style="text-align:center;"|× | |style="text-align:center;"|× | ||
|- | |- | ||
!rowspan=3|<div class="rotated">'''development'''</div> | |||
|the | |''in progress'' | ||
|The work for integrating the use case requirements into the {{rml}} schema has begun. A working group is discussing the use case and developing possible additions to the schema. Interested parties are invited to join the working group. | |||
|style="text-align:center;"|× | |style="text-align:center;"|× | ||
| | | | ||
Line 128: | Line 139: | ||
|style="text-align:center;"|× | |style="text-align:center;"|× | ||
|- | |- | ||
|'' | |''implemented'' | ||
| | |The requirements of this use case have been implemented into the {{rml}} schema. The implementation work of the working group is done. However, not all documents have been finished (PDF documentation of the use case). | ||
| | | | ||
| | | | ||
Line 136: | Line 147: | ||
|style="text-align:center;"|× | |style="text-align:center;"|× | ||
|- | |- | ||
|'' | |''released'' | ||
| | |The previously implemented use case has been fully documented and is thus released. | ||
| | | | ||
| | | | ||
Line 144: | Line 155: | ||
| | | | ||
|- | |- | ||
! | |||
|''postponed'' | |''postponed'' | ||
| | |If an unfinished use case is not being updated for several months and no members of the community have expressed interest in following up with it, the use case will be listed as postponed. | ||
| | | | ||
| | | | ||
Line 153: | Line 164: | ||
| | | | ||
|- | |- | ||
!colspan=" | !colspan="9"|×=participates — ☒=is responsible | ||
|} | |} | ||
Line 160: | Line 171: | ||
==References== | ==References== | ||
< | <references /> | ||
{{interwiki}} | {{interwiki}} |
Latest revision as of 16:00, 25 September 2024
| ||||||||
| ||||||||
railML® 2 Wiki – RailTopoModel® Wiki |
Use cases
In this page you learn what is a use case and find a list of railML® use cases.
While the emphasis of the railML®-wiki lies in documenting single elements in a bottom-up approach, we also try to help users to capture the concepts of railML® via examples and use cases in a top down approach.
What is a use case?
A use case can be defined as a single task, performed by the end user of a system, that has some useful outcome[1][2]. It is described as a list of steps (actions or events) to achieve this outcome.
A use case in terms of railML® is an application of data exchange between at least two IT systems in the railway domain, where railML® can be used as a format and language for the data to be exchanged. The aim of the use case description is to formulate requirements on the technical implementation of the data exchange.
What distinguishes a use case from an example is, that examples will typically consist of pieces of railML®-code, whereas use cases will typically be formulated in natural language or Unified Modelling Language (UML). Examples are solutions to use cases.
railML® Use Cases
By category
CO Use Cases – IL Use Cases – IS Use Cases – RS Use Cases – TT Use Cases
List of active use cases
View/edit list on the separate source page
Legend (↓) | ||||||||||
Directing Subschema |
Involved Subschemas |
Implemented in railML® version (lowest) |
Implemented in railML® version (highest) |
Priority |
Description (EN) | Description (DE) | Abbreviation | Reported by | Status how to interpret the status |
Edited |
---|---|---|---|---|---|---|---|---|---|---|
IL | IS | 3.1 | 3.2 | X | Interlocking module engineering data (former: Interlocking engineering) |
Stellwerksprojektierung | IMED | writer: Thales Germany, reviewer: ETCS subgroup of Interlocking working group |
implemented | June 26th 2024 by User:RailML Orga Ontology |
IS | – | 3.1 | 3.2 | X | Network statement of an infrastructure manager | Schienennetzbenutzungsbedingungen eines Infrastrukturbetreibers | NEST | writer: Správa železnic (former: SŽDC) / ProRail / Bane NOR, reviewer: NEST working group |
implemented | April 12th 2024 by User:RailML Orga Ontology |
IS | RS | 3.1 | 3.2 | X | RINF Reporting | RINF Meldung | RINR | writer: SNCF Réseau | merged into NEST | March 13th 2023 by User:RailML Coord Documentation |
IL | IS | 3.1 | 3.2 | X | Routes for timetable simulation (former: Capacity operational simulation) |
Fahrstrassen für Fahrplan simulieren (ehemals: Leistungsfähigkeit Simulation) |
RSIM | writer: Jernbanedirektoratet / Bane NOR (former: Jernbanedirektoratet Capacity Dpt), reviewer: ETCS subgroup of Interlocking working group |
implemented | December 07th 2023 by User:RailML Orga Ontology |
IS | IL | 3.1 | 3.2 | X | Schematic Track Plan | Schematische Gleisplandarstellung | SCTP | writer: Jernbanedirektoratet / Bane NOR, reviewer: SCTP working group |
implemented | February 13th 2023 by User:RailML Orga Ontology |
TT | IL, IS, RS | 3.2 | 3.2 | X | Integrated Traffic Management System | Integriertes Verkehrsmanagement | ITMS | writer: Thales Germany; reviewer: TT developer working group |
implemented | September 23rd 2024 by User:RailML Coord Documentation |
IS | IL | 3.2 | 3.2 | X | ETCS track net | ETCS Streckenatlas | ETCS | writer: Thales Germany, reviewer: ETCS subgroup of Interlocking working group |
implemented | June 12th 2023 by User:RailML Coord Infrastructure |
ETCS track net: Input for Detailed Design of ETCS Trackside | ETCS Streckenatlas: Übergabe der allgemeingültigen Streckendateninformationen (vom Netzbetreiber an den Lieferanten) | ETCS-a | writer: Thales Germany, reviewer: ETCS subgroup of Interlocking working group |
implemented | June 12th 2023 by User:RailML Coord Infrastructure | |||||
ETCS track net: Output of Detailed Design of ETCS Trackside | ETCS Streckenatlas: Übergabe der Ergebnisdaten der Projektierung (vom Lieferanten an den Netzbetreiber) | ETCS-b | writer: Thales Germany, reviewer: ETCS subgroup of Interlocking working group |
implemented | June 12th 2023 by User:RailML Coord Infrastructure | |||||
ETCS track net: Alignment on Topology and Properties of Trackside Equipment Before ETCS Balise Placement | ETCS Streckenatlas: Aktualisierung der Streckendaten vor Balisengruppenplatzierung | ETCS-c | writer: Thales Germany, reviewer: ETCS subgroup of Interlocking working group |
implemented | June 12th 2023 by User:RailML Coord Infrastructure | |||||
TT | IS, RS | 3.2 | 3.2 | X | Passenger information at stations | Fahrgastinformation am Bahnhof | PISY | writer: PSI Transcom (20. 05. 15); reviewer: init |
implemented | June 04th 2024 by User:RailML Coord Timetable |
TT | IS, RS, IL | 3.3 | 1 | Run Time Calculation Input Data | Eingangsdaten für die Fahrzeitrechnung | RTCI | writer: Jernbanedirektoratet / Bane NOR, reviewer: TT developer working group |
consolidated | March 25th 2024 by User:RailML Coord Timetable | |
Run Time Calculation Input Data – Infrastructure properties | Eingangsdaten für die Fahrzeitrechnung - Infrastruktur Eigenschaften | RTCI-a | writer: Jernbanedirektoratet, reviewer: TT developer working group |
draft | ||||||
Run Time Calculation Input Data – Rolling stock properties | Eingangsdaten für die Fahrzeitrechnung - Fahrzeug Eigenschaften | RTCI-b | writer: Jernbanedirektoratet, reviewer: TT developer working group |
draft | ||||||
Run Time Calculation Input Data – Timetable properties | Eingangsdaten für die Fahrzeitrechnung - Fahrplan Eigenschaften | RTCI-c | writer: Jernbanedirektoratet, reviewer: TT developer working group |
draft | ||||||
TT | IS, RS | 3.3 | 1 | Long Term Circulation Planning | Langfristige Umlaufplanung | LTCP | writer: IVU & TT developer working group, reviewer: TT developer working group |
draft | December 04th 2023 by User:RailML Coord Documentation | |
IS | TT | 3.3 | 1 | Posession Management | Daten für Betra und Gleissperrungen | POMA | writer: Siemens Mobility Germany (10. 01. 22); reviewer: HaCon Ingenieurgesellschaft |
draft | June 3rd 2024 by User:RailML Coord Timetable | |
IS | – | 2 | Track Geometry | Gleisgeometrie | TRGE | writer: ÖBB Infrastruktur | review | April 15th 2024 by User:RailML Coord Documentation | ||
IS | TT, RS | 2 | Driver Advisory System (DAS) | Fahrerassistenzsystem | DASY | writer: Siemens Mobility Germany? | draft | March 13th 2023 by User:RailML Coord Documentation | ||
IS | – | 2 | Railway Infrastructure Recording | Erfassung der Schieneninfrastruktur | ISRC | writer: Bahnkonzept | draft | March 13th 2023 by User:RailML Coord Documentation | ||
TT | IS, IL, RS | Passenger information inside the train | Fahrgastinformation im Zug | PISV | writer: Interautomation (17. 01. 17); reviewer: PSI Transcom and iRFP |
draft | June 04th 2024 by User:RailML Coord Timetable | |||
TT | IS, RS | A timetable for a competition (call for proposals) | Ausschreibungsfahrplan | writer: iRFP (21. 05. 15); reviewer: IVU Traffic Technologies (22. 09. 16) |
consolidated | March 13th 2023 by User:RailML Coord Documentation | ||||
TT | IS, RS, CO | Adopt vehicle working scheduling to timetable changes | Umlauf an Jahresfahrplan anpassen | writer: IVU Traffic Technologies (21. 05. 15); reviewer: HaCon Ingenieurgesellschaft |
consolidated | June 27th 2022 by User:RailML Coord Documentation | ||||
TT | RS, IS | Duty planning and staff shifts | Dienstplanung und Personalschichten | SHFT | writer: ÖBB Personenverkehr; reviewer: init |
consolidated | July 18th 2022 by User:RailML Coord Documentation | |||
TT | IS, RS | Exchange of formation data | Austausch von Wagenreihungen/ Behängungsdaten | writer: iRFP (21. 05. 15); reviewer: IVU Traffic Technologies (22. 09. 16) |
consolidated | March 13th 2023 by User:RailML Coord Documentation | ||||
TT | IS, IL, RS | Long Term Strategic Timetabling | Langfrist-Fahrplanerstellung | LTST | writer: SMA+Partner (22. 12. 16); reviewer: HaCon Ingenieurgesellschaft (28. 6. 22) |
consolidated | July 18th 2022 by User:RailML Coord Timetable | |||
TT | IS, RS | Timetable Information | Fahrplanauskunft | TINF | writer: HaCon Ingenieurgesellschaft (13. 03. 15); reviewer: IVU Traffic Technologies |
consolidated, under revision | March 13th 2023 by User:RailML Coord Documentation | |||
IS | TT, IL, RS | 3 | Asset status representation | Darstellung des Infrastrukturzustands | ASSR | writer: DLR for IN2Rail project | draft | September 27th 2023 by User:RailML Orga Ontology | ||
IS | IL | CAD for railway signaling | CAD für Zugsignalisierung | CASP | writer: Railcomplete AS | draft | December 07th 2023 by User:RailML Orga Ontology | |||
IS | IL, TT, RS | 3 | Capacity Planning | Kapazitätsplanung | CAPL | writer: Bane NOR (erstwhile: JBV) | draft | September 14th 2024 by User:RailML Orga Ontology | ||
IS | IL | 3 | Capture schematic visualisation information of track assets | Erstellung schematischer Visualisierungs-Informationen von Schienenanlagen | draft | March 13th 2023 by User:RailML Coord Documentation | ||||
IS | IL, RS, TT | Exchange of Logical Train Positions | writer: Siemens Mobility Switzerland; |
draft | July 18th 2022 by User:RailML Coord Documentation | |||||
IS | IL | 3 | Exchange of planning parameters for interlocking with suppliers | Austausch von Planungsparametern für Stellwerke mit Herstellern | ISIL | writer: ETCS subgroup of Interlocking working group | draft | March 13th 2023 by User:RailML Coord Documentation | ||
IL | IS, TT | 4 | Interlocking engineering for signalling | Stellwerkstechnik für Signalisierung | writer: Bane NOR (former: Jernbaneverket Signalling Dpt) | draft | March 13th 2023 by User:RailML Coord Documentation | |||
IS | RS | 3 | Maintenance Planning | Wartungsplanung | MAPL | draft | March 13th 2023 by User:RailML Coord Documentation | |||
IS | – | 3 | NRE Reporting | NRE Meldung | NRER | writer: ÖBB Infrastruktur | draft | March 13th 2023 by User:RailML Coord Documentation | ||
IL | IS | 4 | Operation and Control | Betriebsführung | draft | March 13th 2023 by User:RailML Coord Documentation | ||||
RS | IS, TT, IL | Operational simulation | Betriebssimulation | draft | March 13th 2023 by User:RailML Coord Documentation | |||||
IS | – | 3 | Positioning and Map-Matching | Positionierung und Kartenvergleich | POSI | draft | March 13th 2023 by User:RailML Coord Documentation | |||
IS | IL | 3 | Railway Simulation Laboratory | Eisenbahnbetriebslabor | RLAB | writer: Czech Technical University Prague | draft | June 27th 2022 by User:RailML Coord Documentation | ||
TT | IS, RS | Slot ordering | Trassenbestellung | writer: SMA+Partner (17. 09. 16); reviewer: iRFP |
draft | September 23rd 2024 by User:RailML Orga Ontology | ||||
IS | 3 | Speed directory | Verzeichnis der zulässigen Geschwindigkeiten | SPED | writer: Bombardier Transportation | draft | March 13th 2023 by User:RailML Coord Documentation | |||
TT | IS | TAF/TAP TSI requirements | TAF/TAP TSI Anforderungen | writer: ERA; reviewer: Bahnkonzept |
draft | December 07th 2023 by User:RailML Coord Timetable | ||||
IS | IL, TT, RS | 3 | Timetabling | Fahrplanerstellung | ISTT | writer: ProRail | draft | March 13th 2023 by User:RailML Coord Documentation | ||
IL | IS | Hardware and cable plan | Aussenanlage und Kabelplan | draft | March 13th 2023 by User:RailML Coord Documentation | |||||
RS | IS, TT | Traction power supply simulation | Simulation der Bahnstromversorgung | draft | March 13th 2023 by User:RailML Coord Documentation | |||||
IS | Rail Inspection Data | Schienenprüfdaten | RIND | writer:DZSF & ZEDAS | draft | September 23rd 2024 by User:RailML Coord Documentation | ||||
IS | TT, IL | Traffic Management Plan | TMPL | writer: Bombardier Transportation | implemented | September 23rd 2024 by User:RailML Coord Documentation | ||||
Legend: Red: Writer known; reviewed |
List of inactive use cases
If you want to reactivate your inactive use case, write a post on the forum. For more information about use cases you can also follow our UC guideline.
Directing Subschema |
Involved Subschemas |
Implemented in railML® version (lowest) |
Implemented in railML® version (highest) |
Priority |
Description (EN) | Description (DE) | Abbreviation |
Reported by | Status How to interpret the status |
Reason Why is this UC on hold? |
---|---|---|---|---|---|---|---|---|---|---|
TT | ? | Automatic Route Setting (ARS) Automatic Train Supervision (ATS) |
Zuglenkung | writer: Toshiba Corporation?; reviewer: PSI Transcom |
postponed | Currently no demand | ||||
IL | ? | 7 | Data prepration for signalling | Datenbereitstellung für Stellwerkssysteme | DPRS | writer: EULYNX | postponed | EULYNX withdrew from development | ||
TT | ? | Operational simulation timetable | Betriebssimulation Fahrplan | writer: Open Track Railway Technology?; reviewer: SMA+Partner |
postponed | Currently no demand | ||||
IS | – | 9 | Railway Infrastructure Visualisation | Visualisierung von Schieneninfrastruktur | ISVI | postponed | Only outdated version available | |||
IL | IS | 5 | Site preparation data for Signal Controlled Warning Systems | Daten zur Standortvorbereitung für Rottenwarnsysteme | SCWS | writer: Thales Austria | postponed | Currently no demand | ||
Legend: Red: Writer known; reviewed |
How to interpret the status
Status | Description | Participation | ||||||
---|---|---|---|---|---|---|---|---|
railML® community |
reporting party |
railML® scheme coordinator |
railML® governance board |
railML® scheme development group
| ||||
Phase
|
pre development
|
outlined | The use case has been outlined, a rough idea has been discussed but there is no document, nor draft of one yet. Usually no article about this use case is available in the wiki yet, however, sometimes some basic ideas will have been published | × | ||||
draft | A member of the community has submitted a draft of the use case description. This draft is available in the wiki and can be found above. | ☒ | ||||||
consolidated | The submitted draft of the use case description has been reviewed by another community member and the schema coordinator has accepted it. | × | × | ☒ | × | |||
development
|
in progress | The work for integrating the use case requirements into the railML® schema has begun. A working group is discussing the use case and developing possible additions to the schema. Interested parties are invited to join the working group. | × | ☒ | × | |||
implemented | The requirements of this use case have been implemented into the railML® schema. The implementation work of the working group is done. However, not all documents have been finished (PDF documentation of the use case). | ☒ | × | |||||
released | The previously implemented use case has been fully documented and is thus released. | × | ☒ | |||||
postponed | If an unfinished use case is not being updated for several months and no members of the community have expressed interest in following up with it, the use case will be listed as postponed. | ☒ | ||||||
×=participates — ☒=is responsible |
How to contribute a use case
Generally speaking, contributions to railML® and this wiki are appreciated. For contributing use cases, please follow our UC guideline.