UC:Use cases: Difference between revisions

From railML 2 Wiki
Jump to navigation Jump to search
[unchecked revision][checked revision]
(32 intermediate revisions by 3 users not shown)
Line 1: Line 1:
In this page you learn how to contribute good '''Use Cases'''.
{{navi}}
{{head|Use cases}}
 
In this page you learn what is a '''use case''' and find a list of {{rml}} use cases.
 
While the emphasis of the {{rml}}-wiki lies in documenting single elements in a bottom-up approach, we also try to help users to capture the concepts of {{rml}} via [[Dev:Examples|examples]] and use cases in a top down approach.


While the emphasis of the {{rml}}-wiki lies in documenting single elements in a bootom-up-approach, we also try to help users to capture the concepts of {{rml}} via [[Dev:Examples|examples]] and use cases in a top down approach.
==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''[[#*|*]]. It is described as a list of steps (actions or events) to achieve this 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''[[#*|*]]. It is described as a list of steps (actions or events) to achieve this outcome.


What distinguishes a use case from an example is, that examples will typically consist of pieces of {{rml}}-code, whereas use cases will typically be formulated in natural language or ''Unified Modelling Language'' (UML). Examples are solutions (to nutshell problems). Use cases are descriptions (to nutshell tasks).
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.


In the case of {{rml}}, use cases will typically deal with the exchange of data between two systems. The use case should then illustrate the system requirements to achieve the data exchange.
What distinguishes a use case from an example is, that examples will typically consist of pieces of {{rml}}-code, whereas use cases will typically be formulated in natural language or ''Unified Modelling Language'' (UML). Examples are solutions to use cases.


==What makes a good use case?==
=={{rml}} Use Cases==
A good use case should be ''complete'', ''comprehensible'' and ''practically relevant''. Ideally, it should be ''perceivable by the public'' (A problem that can be understood by and occur to everybody is more illustrative than one that only occurs to a small subgroup of users). Finally, the use case should be ''objective'' in the sense that it is not biased to the requirements or solutions of a certain organization or company.
===By category===
[[:category:Use case (CO)|CO Use Cases]] – [[:category:Use case (IL)|IL Use Cases]] – [[:category:Use case (IS)|IS Use Cases]] – [[:category:Use case (RS)|RS Use Cases]] – [[:category:Use case (TT)|TT Use Cases]] – [[:Category:Use cases by company]]
===List===
[[UC:Use cases/table|View/edit list on the separate source page]].
{{:UC:Use cases/table}}


==Structure==
===How to interpret the status===
Use cases are usually assigned to a subschema. The article name should follow the paradigm <subschema>:US:<use case>, e.g. [[IS:UC:Timetabling]].
<div style="writing-mode: tb-rl;"></div>
{|class="wikitable"
!rowspan=2|&nbsp;!!Status!!Description!!colspan=5|participation
|-
!&nbsp;!!&nbsp;!!<div style="writing-mode: tb-rl;font-size:70%">{{rml}} community</div>!!<div style="writing-mode: tb-rl;font-size:70%">reporting party</div>!!<div style="writing-mode: tb-rl;font-size:70%">{{rml}} scheme coordinator</div>!!<div style="writing-mode: tb-rl;font-size:70%">{{rml}} governance board</div>!!<div style="writing-mode: tb-rl;font-size:70%">{{rml}} scheme development group</div>
|-
|rowspan=3|<div style="writing-mode: tb-rl;font-size:70%">'''pre development'''</div>||''planned''
|the use case is planned, but there is no draft available by now; usually there will be no article about this use case in the wiki; Sometimes some basic ideas will be published
|style="text-align:center;"|×
|
|
|
|
|-
|''draft''
|a user has submitted a draft. Usually there will exist an article about the use case where you find the draft
|
|style="text-align:center;"|☒
|
|
|
|-
|''consolidated''
|the draft has been reviewed and accepted by the scheme coordinator
|style="text-align:center;"|×
|style="text-align:center;"|×
|style="text-align:center;"|☒
|
|style="text-align:center;"|×
|-
|rowspan=3|<div style="writing-mode: tb-rl;font-size:70%">'''development phase'''</div>||''requirements''
|the '''development phase''' begins with an assessment, if and how the {{rml}} schema has to be refined as to depict the use case
|style="text-align:center;"|×
|
|style="text-align:center;"|☒
|
|style="text-align:center;"|×
|-
|''model''
|the requirements of this use case have been implemented into the currant {{rml}} schema
|
|
|style="text-align:center;"|☒
|
|style="text-align:center;"|×
|-
|''finished''
|the use case has been completely implemented, documented and released
|
|
|style="text-align:center;"|×
|style="text-align:center;"|☒
|
|-
|
|''postponed''
|if an unfinished use case is not being barried further for several months, it will be listed as postponed
|
|
|style="text-align:center;"|☒
|
|
|-
!colspan="8"|×=participates — ☒=is responsible
|}


In {{rml}}, use cases are usually presented with the following structure (which, too, can be seen in the example [[IS:UC:Timetabling]]):
*Description: A sketch of the task, the necessary steps and the requirements in general.
:It is important to note, to which {{rml}}versions a use case or certain aspects of it apply, as use cases will devellop further with the develllopment of {{rml}}.
*Data flows and interfaces
*Interference with other {{rml}} schemas
*Characterizing Data
**How often do the data change (update)?
**Which views are represented by the data (focus)?
**Which specific timetable data do you expect to receive/send (elements)?
==How to contribute a use case==
==How to contribute a use case==
# Please, coordinate with the coordinator of the respective subschema before making a sub case. Feel free to start an article in your userspace at your own risk.
Generally speaking, contributions to {{rml}} and this wiki are appreciated. For contributing use cases, please follow our [[dev:Use cases|UC guideline]].
# Develop the use case according to the mentioned criteria (especially [[#structure]] and [[#What makes a good use case?]]).
 
# Let the subschema coordinator review the article.
# Publish the article. Don't forget to version the use case and match it with the {{rml}}-versions to which it applies — both the use case and {{rml}} will evolve in the course of time. Please enter the article into the use case collection of the respective subschema, as in [[#Lists]].
==Lists==
As use cases refer to certain subschemas, they are listed along this line:
*[[TT:UseCases]]
*[[IS:UseCases]]
*[[RS:UseCases]]
*[[IL:UseCases]]
==References==
==References==
<div id="*">[[#t*|*]] http://www.ibm.com/developerworks/library/co-design5/</div>
<div id="*">[[#t*|*]] {{external|http://www.engr.sjsu.edu/fayad/current.courses/cmpe202-Fall2009/docs/lecture2/CmpE202-Use-Cases-3.pdf}}</div>

Revision as of 15:33, 15 March 2019

RailML Trademark RGB V2.png
XML Railway exchange format
https://railML.org
Latest release: 2.5
(September 1st, 2021)
 
Main Menu
 
Subschemas
XML tree
UML diagrams
Use cases
Versions & Changes

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*. 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 CasesIL Use CasesIS Use CasesRS Use CasesTT Use CasesCategory:Use cases by company

List

View/edit list on the separate source page.

🗒️ This page is mirrored from page UC:Use cases/table in The railML® 3 wiki.
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 model February 3rd 2020 by User:RailML Coord Documentation
IS 3.1 3.2 X Network statement of an infrastructure manager Schie­nen­netz­be­nut­zungs­be­din­gun­gen eines Infrastrukturbetreibers NEST writer: Správa železnic (former: SŽDC) / ProRail / Bane NOR model February 3rd 2020 by User:RailML Coord Documentation
IS RS 3.1 3.2 X RINF Reporting RINF Meldung RINR writer: SNCF Réseau merged into NEST February 3rd 2020 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)
model February 3rd 2020 by User:RailML Coord Documentation
IS IL 3.1 3.2 X Schematic Track Plan Schematische Gleisplandarstellung SCTP writer: Jernbanedirektoratet / Bane NOR model February 3rd 2020 by User:RailML Coord Documentation
IS TT, IL 3.2 3.2 X Integrated TMS Integriertes Verkehrsmanagement ITMS writer: Bombardier Transportation model February 3rd 2020 by User:RailML Coord Documentation
TT IL, IS, RS 3.2 3.2 X Traffic Management Plan writer: Thales Germany model February 3rd 2020 by User:RailML Coord Documentation
IS IL 3.2 3.2 X ETCS track net ETCS Streckenatlas ETCS writer: Thales Germany model February 3rd 2020 by User:RailML Coord Documentation ETCS Streckenatlas
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 model February 3rd 2020 by User:RailML Coord Documentation |ETCS Streckenatlas
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 model February 3rd 2020 by User:RailML Coord Documentation
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 model February 3rd 2020 by User:RailML Coord Documentation
TT IS, RS 3.2 3.2 X Passenger information at stations Fahrgastinformation am Bahnhof writer: PSI Transcom (20. 05. 15);
reviewer: init
model February 3rd 2020 by User:RailML Coord Documentation
TT IS, RS, IL 3.3 1 Run Time Calculation Input Data Eingangsdaten für die Fahrzeitrechnung RTCI writer: Jernbanedirektoratet / Bane NOR consolidated June 08th 2023 by User:RailML Coord Documentation
Run Time Calculation Input Data – Infrastructure properties Eingangsdaten für die Fahrzeitrechnung - Infrastruktur Eigenschaften RTCI-a writer: Jernbanedirektoratet draft
Run Time Calculation Input Data – Rolling stock properties Eingangsdaten für die Fahrzeitrechnung - Fahrzeug Eigenschaften RTCI-b writer: Jernbanedirektoratet draft
Run Time Calculation Input Data – Timetable properties Eingangsdaten für die Fahrzeitrechnung - Fahrplan Eigenschaften RTCI-c writer: Jernbanedirektoratet draft
TT IS, RS 3.3 1 Long Term Circulation Planning Langfristige Umlaufplanung LTCP reporter: IVU
writer & reviewer: TT developer group
draft November 30th 2023 by User:RailML Coord Documentation
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 February 3rd 2020 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 February 3rd 2020 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 February 3rd 2020 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 February 3rd 2020 by User:RailML Coord Documentation
TT IS, RS Timetable Information Fahrplanauskunft TINF writer: HaCon Ingenieurgesellschaft (13. 03. 15);
reviewer: IVU Traffic Technologies
consolidated, under revision February 3rd 2020 by User:RailML Coord Documentation
IS 2 Track Geometry Gleisgeometrie TRGE writer: ÖBB Infrastruktur review February 3rd 2020 by User:RailML Coord Documentation
IS TT, IL, RS 3 Asset status representation Darstellung des Infrastrukturzustands ASSR writer: DLR for IN2Rail project draft February 3rd 2020 by User:RailML Coord Documentation
IS IL CAD for railway signaling CAD für Zugsignalisierung CASP writer: Railcomplete AS draft February 3rd 2020 by User:RailML Coord Documentation
IS IL, TT, RS 3 Capacity Planning Kapazitätsplanung CAPL writer: Bane NOR (erstwhile: JBV) draft February 3rd 2020 by User:RailML Coord Documentation
IS IL 3 Capture schematic visualisation information of track assets Erstellung schematischer Visualisierungs-Informationen von Schienenanlagen draft February 3rd 2020 by User:RailML Coord Documentation
IS TT, RS 2 Driver Advisory System (DAS) Fahrerassistenzsystem DASY writer: Siemens Mobility Germany? draft February 3rd 2020 by User:RailML Coord Documentation
IS IL, RS, TT Exchange of Logical Train Positions writer: Siemens Mobility Switzerland;
reviewer: ???
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 Her­stel­lern ISIL writer: IS draft February 3rd 2020 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 February 3rd 2020 by User:RailML Coord Documentation
IS RS 3 Maintenance Planning Wartungsplanung MAPL draft February 3rd 2020 by User:RailML Coord Documentation
IS 3 NRE Reporting NRE Meldung NRER writer: ÖBB Infrastruktur draft February 3rd 2020 by User:RailML Coord Documentation
IL IS 4 Operation and Control Betriebsführung draft February 3rd 2020 by User:RailML Coord Documentation
RS IS, TT, IL Operational simulation Betriebssimulation draft February 3rd 2020 by User:RailML Coord Documentation
TT IS, IL, RS Passenger information inside the train Fahrgastinformation im Zug writer: Interautomation (17. 01. 17);
reviewer: PSI Transcom and iRFP
draft February 3rd 2020 by User:RailML Coord Documentation
IS RS, TT 2 Passenger Information System Fahrgast-Informationssystem PISY draft February 3rd 2020 by User:RailML Coord Documentation
IS ? Posession Management Daten für Betra und Gleissperrungen POMA writer: Siemens Mobility Germany (10. 01. 22);
reviewer: HaCon Ingenieurgesellschaft
draft July 18th 2022 by User:RailML Coord Documentation
IS 3 Positioning and Map-Matching Positionierung und Kartenvergleich POSI draft February 3rd 2020 by User:RailML Coord Documentation
IS 2 Railway Infrastructure Recording Erfassung der Schieneninfrastruktur ISRC writer: Bahnkonzept draft February 3rd 2020 by User:RailML Coord Documentation
IS IL 3 Railway Simulation Laboratory Eisenbahnbetriebslabor RLAB writer: Czech Technical University Prague draft February 3rd 2020 by User:RailML Coord Documentation
TT IS, RS Slot ordering Trassenbestellung writer: SMA+Partner (17. 09. 16);
reviewer: iRFP
draft February 3rd 2020 by User:RailML Coord Documentation
IS 3 Speed directory Verzeichnis der zulässigen Geschwindigkeiten SPED writer: Bombardier Transportation draft February 3rd 2020 by User:RailML Coord Documentation
TT IS TAF/TAP TSI requirements TAF/TAP TSI Anforderungen writer: ERA;
reviewer: Bahnkonzept
draft February 3rd 2020 by User:RailML Coord Documentation
IS IL, TT, RS 3 Timetabling Fahrplanerstellung ISTT writer: ProRail draft February 3rd 2020 by User:RailML Coord Documentation
IL IS Hardware and cable plan Aussenanlage und Kabelplan draft February 3rd 2020 by User:RailML Coord Documentation
RS IS, TT Traction power supply simulation Simulation der Bahnstromversorgung draft February 3rd 2020 by User:RailML Coord Documentation
IS Rail Inspection Data Schienenprüfdaten RIND reporter:DZSF & ZEDAS
writer:DZSF
draft FIXME! th by [[User:]]

 

How to interpret the status

  Status Description participation
   
railML® community
reporting party
railML® scheme coordinator
railML® governance board
railML® scheme development group
pre development
planned the use case is planned, but there is no draft available by now; usually there will be no article about this use case in the wiki; Sometimes some basic ideas will be published ×
draft a user has submitted a draft. Usually there will exist an article about the use case where you find the draft
consolidated the draft has been reviewed and accepted by the scheme coordinator × × ×
development phase
requirements the development phase begins with an assessment, if and how the railML® schema has to be refined as to depict the use case × ×
model the requirements of this use case have been implemented into the currant railML® schema ×
finished the use case has been completely implemented, documented and released ×
postponed if an unfinished use case is not being barried further for several months, it 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.

References