UC:UseCases

From railML 3 Wiki
Jump to navigation Jump to search
RailML Trademark RGB V3.png
XML Railway exchange format
https://railML.org
Latest release: 3.3
(November 5th 2024)
 
Quick links
Subschemas
XML tree
UML diagrams
Use cases
Versions & Changes
Guides
Semantic Constraints
FAQ
railML® 2 WikiRailTopoModel® 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 CasesIL Use CasesIS Use CasesRS Use CasesTT Use Cases

List of active use cases

[Template fetch failed for https://wiki3.railml.org/index.php?title=Template:UC:Use_cases/table&action=raw: HTTP 404]

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 RAIV 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
Green: Writer known; not reviewed
Priority: "X" means that work is finished, but Use case will be updated when needed by the community. "1" is the highest priority.
Status: How to interpret the status

How to interpret the status

Status Description Participation
railML® community
reporting party
railML® schema coordinator
railML® governance board
railML® schema 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.

References