View source for Dev:changes/2.3

{{head|{{rml}} schema changes between {{rml|2.2}} and {{rml|2.3}}}}

This site is intended to collect the schema changes between {{rml|2.2}} and {{rml|2.3}} by topics, that influence the XML output.

A complete diff comparison can be found under [[Dev:changes/2.3/diff]]

Changes are also marked on the element pages with {{Vers|introduced with version 2.3}} for introduced components and {{depVers|deprecated with version 2.3}} for components that became obsolete. All occurances of these tags are listed in [[:Category:Intro/2.3]] respectively [[:Category:Depr/2.3]].

For changes with other version upgrades see [[Dev:changes]].

== Timetable subschema ==

{{Missing information|topic=the tickets {{ticket|258}} and {{ticket|241}}|user=[[Benutzer:Vasco Paul Kolmorgen|Vasco Paul Kolmorgen]] 10:49, 22. June 2016 (CET)}}

=== Upward compatibility ===
In principle {{rml}} provides an ''upward'' compatibility - e.g. a {{rml|2.2}} import interface would be able to process a {{rml|2.3}} file because only optional elements/attributes are added in a minor version. In principle this holds true for the changes in {{rml|2.3}}. However, the main changes for connections and cancellations are based on either additional data (cancellations) or missing data (external connections). With these changes the upward compatibility is no longer possible and as a consequence a {{rml|2.3}} file that is designed to be imported by a {{rml|2.2}} import interface must not:
* contain external connections with a missint @trainRef attribute
* contain connections with @nonConnection attribute value of true
* contain trains or trainParts with a @cancellation attribute value of true

=== Cancellation of {{TT:Doc|train}} or {{TT:Doc|trainPart}} ===
{{change
|fact=The new cancellation attribute of a {{TT:Tag|train}} or {{TT:Tag|trainPart}} can be used within one {{rml}} file without the need for the importing system to compare two files to identify cancellations.
|recommendation=Use the new {{Attr|cancellation }} attribute to mark a cancellation and provide it to an importing system that can handle cancellations.
'''NOTE:''' A {{rml|2.3}} export file will need to be adapted to the importing system - i.e. whether or not the system supports cancellations (2.3 import) or not (2.2 import with ''upward'' compatibility).
|ticket={{ticket|247}}
|commit={{SVN|612}}, {{SVN|613}}
|example=
<syntaxhighlight lang="xml">
 <rail:trainPart id="CNL_242_2" trainNumber="242" description="CNL 242" timetablePeriodRef="J08" categoryRef="cCNL" cancellation="true">
  <rail:ocpsTT>
  ...
  </rail:ocpsTT>
 </rail:trainPart>
 </syntaxhighlight>
|xsd=timetableTypes.xsd
|nattr=<br>
* /timetable/trainParts/trainPart/@cancellation
* /timetable/trains/train/@cancellation 
}}

=== Extend {{TT:Doc|connection}} element ===
{{change
|fact=The {{TT:Tag|connection}} element has been extended with new attributes as well as for partial exports.
|reason=Connection information needs to be provided for trains that are not part of the {{rml}} file as well as connections that shall not be used.
'''NOTE:''' A {{rml|2.3}} export file will need to be adapted to the importing system - i.e. whether or not the system supports extended connections (2.3 import) or not (2.2 import with ''upward'' compatibility). 
|ticket={{ticket|244}}
|commit={{SVN|614}}, {{SVN|615}}, {{SVN|651}}
|xsd=timetableTypes.xsd
|uattr=connections/connection/@trainRef
|nattr=<br>
* connections/connection/@operatingPeriodRef
* connections/connection/@notGuaranteed
* connections/connection/@nonConnection
* connections/connection/@samePlatform 
|nelem=<br>
* connections/connection/externalReference
** externalReference/tafTapTsiTrainID
** externalReference/trainNumber
** externalReference/lineNumber
** externalReference/information 
}}

=== {{TT:Doc|tafTapTsiTrainID}} ===
{{change
|fact=The {{TT:Tag|tafTapTsiTrainID}} element has been introduced.
|recommendation=Use the new {{TT:Tag|tafTapTsiTrainID}} element for defining the unique train identifier for the unique train numbering.
|ticket={{ticket|236}}
|commit={{SVN|641}}, {{SVN|644}}, {{SVN|652}}, {{SVN|655}}
|xsd=<br>
* timetable.xsd 
* timetableTypes.xsd
;@timetable.xsd
<syntaxhighlight lang="xml">
<xs:train>
....
<xs:element name="tafTapTsiTrainID" type="rail:eTapTsiTransportOperationalIdentifier" minOccurs="0" maxOccurs="1">
     <xs:annotation>
        <xs:documentation>Optional information corresponding to the TAF/TAP TSI train ID.</xs:documentation>
     </xs:annotation>
</xs:element>
....
</xs:train>

<xs:attributeGroup name="aTapTsiCompositIdentifierOperationalType">
    <xs:annotation>
         <xs:documentation>Used for unique identification of the objects handled in the messages such as train, path, path request or case refernce.</xs:documentation>
    </xs:annotation>
    <xs:attribute name="objectType" type="rail:tTapTsiObjectType" use="required"/>
    <xs:attribute name="companyCode" type="rail:tCompanyCode" use="required"/>
    <xs:attribute name="core" type="rail:tTapTsiCore" use="required"/>
    <xs:attribute name="variant" type="rail:tTapTsiVariant" use="required"/>
    <xs:attribute name="timetableYear" type="rail:tTapTsiTimetableYear" use="required"/>
    <xs:attribute name="startDate" type="rail:tTapTsiStartDate" use="optional"/>
</xs:attributeGroup>
 </syntaxhighlight>
|example=
<syntaxhighlight lang="xml">
    <tafTapTsiTrainID objectType="TR" companyCode="0071" core="47110815ABCD" variant="01" timetableYear="2016" />
 </syntaxhighlight>
|nelem=/timetable/trains/train/tafTapTsiTrainID
}}

=== Internal refactoring ===
{{change
|fact=There is no need for the complex type eAnnotationText element definition.
|recommendation=The type reference for the annotation text shall reference the tAnnotationText directly.
|ticket={{ticket|241}}
|commit={{SVN|605}}
|xsd=timetable.xsd
}}

=== Mark {{TT:Doc|trainPart}}/{{Attr|@operator}} as deprecated ===
{{change
|reason=With the introduction of the new {{TT:Tag|operationalUnitBinding}} element in {{rml|2.2}} the {{Attr|@operator}} attribute needs to be marked as deprecated.
|ticket={{ticket|258}}
|commit={{SVN|617}}
|xsd=timetableTypes.xsd
|uattr=timetable/trainParts/trainPart/@operator
}}

=== {{CO:Doc|usingAny}} for timetable ===
{{change
|fact=The timetable schema shall be extended to allow a general use of the any element/attribute ({{CO:Tag|usingAny}}).
|reason=All elements matching a set of defined rules will be extended so that there will be no need to create a new version for every element that needs to be extended.
|ticket={{ticket|268}} and {{ticket|267}}
|commit={{SVN|638}}
|xsd=<br>
* railwayBaseTypes.xsd
* genericRailML.xsd
* timetableTypes.xsd
* timetable.xsd 
|uelem=<br>
* /timetablePeriods/timetablePeriod/holidays/holiday
* /operatingPeriods/operatingPeriod/operatingDay
* /operatingPeriods/operatingPeriod/operatingDay/operatingDayDeviance
* /operatingPeriods/operatingPeriod/specialService
* /trainParts/trainPart/formationTT
* /trainParts/trainPart/formationTT/equipmentUsage/equipment
* /trainParts/trainPart/formationTT/equipmentUsage/equipment/etcs
* /trainParts/trainPart/formationTT/passengerUsage
* /trainParts/trainPart/formationTT/passengerUsage/places
* /trainParts/trainPart/formationTT/reservationInfo/booking
* /trainParts/trainPart/ocpsTT/ocpTT/connections/connection
* /trainParts/trainPart/ocpsTT/ocpTT/statistics/statistic
* /trainParts/trainPart/ocpsTT/ocpTT/statistics/statistic/mean
* /trainParts/trainPart/ocpsTT/ocpTT/statistics/statistic/median
* /trainParts/trainPart/ocpsTT/ocpTT/statistics/statistic/standardDeviation
* /trainParts/trainPart/ocpsTT/ocpTT/statistics/statistic/statisticAnalyses
* /trainParts/trainPart/ocpsTT/ocpTT/sectionTT
* /trainParts/trainPart/ocpsTT/ocpTT/sectionTT/runTimes
* /trainParts/trainPart/ocpsTT/ocpTT/stopDescription
* /trainParts/trainPart/ocpsTT/ocpTT/stopDescription/stopTimes
* /trains/train/trainPartSequence
* /trains/train/trainPartSequence/brakeUsage
* /trains/train/trainPartSequence/brakeUsage/auxiliaryBrakes
* /rosterings/rostering/blockParts
* /rosterings/rostering/blocks/block/blockPartSequence
* /rosterings/rostering/circulations/circulation
}}

== Infrastructure subschema ==

==={{IS:Doc|clearanceGauge}} and related===
{{change
|fact={{IS:Tag|clearanceGauge_infraAttributes}}, {{IS:Tag|clearanceGauge_clearanceGaugeChange}}, {{IS:Tag|clearanceGaugeChange}} and {{IS:Tag|clearanceGaugeChanges}} have been introduced.
|reason={{missing information|user=[[User:Ferri Leberl|Ferri Leberl]] ([[User talk:Ferri Leberl|talk]]) 13:14, 13 June 2017 (CEST)}}
|recomendation={{missing information|user=[[User:Ferri Leberl|Ferri Leberl]] ([[User talk:Ferri Leberl|talk]]) 13:14, 13 June 2017 (CEST)}}
|trac={{ticket|3}}
|svn={{missing information|user=[[User:Ferri Leberl|Ferri Leberl]] ([[User talk:Ferri Leberl|talk]]) 13:14, 13 June 2017 (CEST)}}
|example={{missing information|user=[[User:Ferri Leberl|Ferri Leberl]] ([[User talk:Ferri Leberl|talk]]) 13:14, 13 June 2017 (CEST)}}
}}
=== {{IS:Doc|trainRadio}}, {{IS:Doc|trainRadioChange}} ===
{{change
|fact=The {{IS:Tag|trainRadio}} element and {{IS:Tag|trainRadioChange}} element have been introduced.
|recommendation=Use the new {{IS:Tag|trainRadio}} and {{IS:Tag|trainRadioChange}} elements for defining conditions describing the train radio conditions along the track.
|ticket={{ticket|43}}
|commit={{SVN|630}}
|example=<br>
;ocs element sample:
<syntaxhighlight lang="xml">
<ocsElements>
  <trainRadioChanges>
    <trainRadioChange id="trc01" pos="57.46" dir="up" radioSystem="GSM-R" broadcastCalls="true">
    </trainRadioChange>
  </trainRadioChanges>
</ocsElements>
</syntaxhighlight>
;infra attributes sample:
<syntaxhighlight lang="xml">
<infraAttrGroups>
  <infraAttributes id="ia01">
    <trainRadio radioSystem="GSM-R" broadcastCalls="true" />
  </infraAttributes>
</infraAttrGroups>
</syntaxhighlight>
}}

=== {{IS:Doc|speedChange}}/{{Attr|@vMax}} ===
{{change
|fact=The parameter {{Attr|vMax}} in the {{IS:Tag|speedChange}} element has been modified so that it can also handle the value "end".
|recommendation=Use the new value "end" in order to mark the end of a temporary speed restriction.
|ticket={{ticket|97}}
|commit={{SVN|609}}
|example=
<syntaxhighlight lang="xml">
<speedChange id="sc7" pos="256.7" vMax="end" dir="up" />
</syntaxhighlight>
}}

=== {{IS:Doc|radiusChange}}/{{Attr|@geometryElementDescription}} ===
{{change
|fact=A new attribute named {{Attr|geometryElementDescription}} has been added to the {{IS:Tag|radiusChange}} element. It is an enumeration parameter, which provides the following entries that enable a more detailed description of transition curves:
* TS_cubicParabola
* TS_parabola4
* TS_clothoide; the usually used transition curve in modern railways, see {{wiki|Euler_spiral|Euler spiral}} and {{Deu|{{wiki|de:Klothoide#Anwendung_im_Verkehrswegebau|Klothoide (German)}}}} description
* TS_WienerBogen; a special transition curve used in Austria and Germany, see {{Deu|{{wiki|de:Wiener_Bogen|Wiener Bogen (German)}}}} description
* TS_BlossBogen; a special transition curve widely in Germany, see {{Deu|{{wiki|de:Blossbogen|Blossbogen (German)}}}} description
* TS_Sinusoide
* TS_Cosinusoide
* SC
* (any other)
|reason=So far, it was not possible to model transition curves in {{rml}} although they represent a basic track alignment feature.
|recommendation=Use the new {{Attr|geometryElementDescription}} attribute in the {{IS:Tag|radiusChange}} element for modelling the begin and end points of transition curves.
|ticket={{ticket|251}}
|commit={{SVN|616}}
|example=<br>
;sample for transition curve begin:
<syntaxhighlight lang="xml">
<radiusChange ... geometryElementDescription='TS_clothoide' />
</syntaxhighlight>
;sample for transition curve end:
<syntaxhighlight lang="xml">
<radiusChange ... geometryElementDescription='SC' />
</syntaxhighlight>
}}

=== {{IS:Doc|tsi}} ===
{{change
|fact=The element {{IS:Tag|tsi}} has been marked deprecated.
|reason=Elements dedicated for the usage in conjunction with TAP TSI shall be replaced by a more generic approach.
|recommendation=Instead of the element {{IS:Tag|tsi}}, please use the {{IS:Tag|designator}} element with the new register entry "PLC" (Primary Location Code) for referencing a TAF TSI relevant name of an operational control point.
|ticket={{ticket|252}}
|commit={{SVN|611}}
|example=<br>
;old sample ({{rml|2.2}})
<syntaxhighlight lang="xml">
<ocp ... name='Buchs (SG)' ...>
  <tsi country='85' location='09404' check='' />
</ocp>
</syntaxhighlight>
;new sample ({{rml|2.3}})
<syntaxhighlight lang="xml">
<ocp ... name='Buchs (SG)' ...>
  <designator register='PLC' entry='CH9404' />
</ocp>
</syntaxhighlight>
}}

=== {{IS:Doc|line}}/{{Attr|@lineCategory}} ===
{{change
|fact=The optional attribut {{Attr|lineCategory}} has been added to the parameters of the element {{IS:Tag|line}}.
|reason=The European standard EN 15528 defines several line categories for classification of railway lines depending on allowed maximum axle load and meterload paramters.
|recommendation=Use the new paramter {{Attr|lineCategory}} within the element {{IS:Tag|line}} to define a line category according to EN 15528. The following values are possible:
* A
* B1, B2
* C2, C3, C4
* D2, D3, D4, D4xL
* E4, E5
* (any other)
|ticket={{ticket|259}}
|commit={{SVN|620}}, {{SVN|621}}, {{SVN|622}}
|example=
<syntaxhighlight lang="xml">
<line ... lineCategory='E4' />
</syntaxhighlight>
}}

=== {{IS:Doc|additionalName}}/{{Attr|@xml:lang}} ===
{{change
|fact=Although being optional, the attribut {{Attr|xml:lang}} should always be given in the {{IS:Tag|additionalName}} element.
|reason=In order to being able to correctly read the given additional name e.g. for an OCP, it is necessary to know in which language the additional name has been written.
|recommendation=Always use the optional paramter {{Attr|xml:lang}} when using the element {{IS:Tag|additionalName}}.
|ticket={{ticket|263}}
|commit={{SVN|629}}
|example=
<syntaxhighlight lang="xml">
<ocp id="ocp_ΑΘΗΝ" name="ΑΘΗΝΑ">
  <additionalName name="Ἀθῆναι" xml:lang="grc"/>
  <additionalName name="ΑΘΗΝΑ" xml:lang="el-Grek"/>
  <additionalName name="ATHINA" xml:lang="el-Latn"/>
  <additionalName name="Athens" xml:lang="en"/>
  <additionalName name="Athen" xml:lang="de"/>
  <additionalName name="Athènes" xml:lang="fr"/>
</ocp>
</syntaxhighlight>
}}

=== {{IS:Doc|crossedElement}} ===
{{change
|fact=New optional element {{IS:Doc|crossedElement}} has been added for the elements {{IS:Doc|levelCrossing}}, {{IS:Doc|brigde}} and {{IS:Doc|tunnel}}.
|reason=This implementation allows to model more specific information about natural and infrastructure landmarks that are crossed by a river, a railway line or a street.
|recommendation=If you want to define information about a natural or infrastructure landmark that you are going to cross with your track, please use the new element {{IS:Tag|crossedElement}}.
|ticket={{ticket|271}}
|commit={{SVN|629}}
|example=<br>
;sample for brigde{{sic}}
<syntaxhighlight lang="xml">
<brigde id="br01" name="Marienbrücke" pos="2050">
  <crossedElements>
    <crossedElement type="highway:cycleway" id="cw01" name="Elberadweg" pos="2200" />
    <crossedElement type="highway:road" id="rd01" name="B6" pos="2150" />
    <crossedElement type="natural:river" id="ri01" name="Elbe" pos="2100" />
  </crossedElements>
</brigde>
</syntaxhighlight>
}}

== Rollingstock subschema ==

=== {{RS:Doc|vehicleIdentification}} ===
{{change
|fact=The {{RS:Doc|vehicleIdentification}} element in the {{RS:Tag|operator}} was introduced for storing UIC numbers.
|reason=The UIC has developed two variants for unique identification numbers of vehicles, i.e. locomotives and wagons. Both types consists of 12 digits. As the identification encodes also the vehicle owner/operator it was included as part of the {{RS:Tag|operator}} element to have a clear relation to validity period.
|recommendation=Use the new {{RS:Tag|vehicleIdentification}} element for each {{RS:Tag|operator}} element defined for the particular vehicle.
|commit={{SVN|643}}
|example=<br>
;New sample ({{rml|2.3}})
<syntaxhighlight lang="xml">
<operator ...>
  <vehicleIdentification uicIdentNumber='978081940527' countryCode='D' vehicleKeeperMarking='LEG' />
</operator>
</syntaxhighlight>
}}

=== {{RS:Doc|trainClearanceGauge}} ===
{{change
|fact=The {{RS:Doc|trainClearanceGauge}} element in the {{RS:Tag|wagon}} was introduced for storing the vehicle clearance gauge(s) in a unified way.
|reason=There are several clearance gauges for railway vehicles defined in national or international regulations and standards. They are taken from the prepared code list to be comparable with similar data of a railway line.
|recommendation=The use of the new {{RS:Tag|trainClearanceGauge}} shall only take elements out of the given list ''TrainClearanceGauges.xml''.
|ticket={{ticket|3}}
|commit={{SVN|627}}, {{SVN|623}}
|example=<br>
;New sample ({{rml|2.3}})
<syntaxhighlight lang="xml">
<wagon ...>
  <trainClearanceGauge code='GC' />
  <trainClearanceGauge code='DE2' />
</wagon>
</syntaxhighlight>
}}

=== {{RS:Doc|maintenanceIntervals}} ===
{{change
|fact=The {{RS:Doc|maintenanceIntervals}} element in the {{RS:Tag|vehicle}} was introduced for storing individual maintenance intervals of railway vehicles.
|reason=For the asset management of railway vehicles it shall be possible to store individual maintenance intervals with the vehicle data.
|ticket={{ticket|77}}
|commit={{SVN|624}}
|example=<br>
;New sample ({{rml|2.3}})
<syntaxhighlight lang="xml">
<vehicle ...>
  <maintenanceIntervals>
    <maintenanceInterval id='RSMI1' name='R1' maximumIntervalDays='365' maximumIntervalDistance='20000'/>
    <maintenanceInterval id='RSMI2' name='S1' maximumIntervalDays='730' maximumIntervalDistance='50000'/>
  </maintenanceIntervals>
</vehicle>
</syntaxhighlight>
}}

== Common subschema ==

=== Codelists ===
{{change
|fact=[[dev:Codelists|Codelist]] XSD and XML files have been moved to a common folder called ''codelists''. Each codelist will get the name describing its content.
|recommendation=Update references to the new codelists folder as well as the updated file names:
* codelists/InfrastructureManagers.xml
* codelists/InfrastructureManagers.xsd
* codelists/ListBaseTypes.xsd
* codelists/Registers.xml
* codelists/Registers.xsd
* codelists/TrainProtectionSystems.xml
* codelists/TrainProtectionSystems.xsd .
|ticket={{ticket|272}}
|commit={{SVN|631}}, {{SVN|632}}, {{SVN|637}}, {{SVN|653}}
}}

=== {{CO:Doc|companyCode}} ===
{{change
|fact=The codelist for infrastructure managers has been extended to include a 'TAF TAP TSI / UIC company code' -
|recommendation=Existing codes have been added to the InfrastructureManagers.xml file and can be used by importing systems.
|ticket={{ticket|272}}
|commit={{SVN|632}}, {{SVN|653}}, {{SVN|656}}, {{SVN|657}}
|xsd=<br>
*InfrastructureManagers.xsd<syntaxhighlight lang="xml">
<xs:element name="companyCode" type="railcode:tCompanyCode" minOccurs="0">
  <xs:annotation>
    <xs:documentation>company codes according TAP TSI B.8 and UIC IRS/leaflet 920-1:2006</xs:documentation>
  </xs:annotation>
</xs:element>
...
<xs:simpleType name="tCompanyCode">
  <xs:restriction base="xs:string">
    <xs:length value="4"/>
    <xs:pattern value="[0-9]{4}"/>
  </xs:restriction>
</xs:simpleType>
</syntaxhighlight>
*InfrastructureManagers.xml<syntaxhighlight lang="xml">
<infrastructureManager code="ADF">
  <name xml:lang="es">Administrador de Infraestructuras Ferroviarias</name>
  <name xml:lang="en">Administrator of Railway Network</name> 
  <isoCountryCode>ES</isoCountryCode>
  <companyCode>0071</companyCode>
</infrastructureManager>
</syntaxhighlight>
}}

=== New attributes for places and services ===
{{change
|fact=Additional commercial attributes from TAP TSI
* rail:aPlaces shall be modified in such a way that the values of the corresponding TAP TSI code list B.4.9039 can be accomodated.
* rail:aServices shall be modified in such a way that the values of the corresponding TAP TSI code list B.4.7161 can be accomodated. 
|reason=The elements for places (RS:{{RS:Doc|places}}, TT:{{TT:Doc|places}}) and services (RS:{{RS:Doc|service|passenger}}, TT:{{TT:Doc|service}}) shall be extended to allow specification of TAP TSI specific codes. 
The new attribute will be available for both the definition for rolling stock (RS) as well as for timetable (TT).
|ticket={{ticket|250}}
|commit={{SVN|618}}, {{SVN|633}}, {{SVN|634}}, {{SVN|635}}, {{SVN|636}}, {{SVN|654}}
|xsd=railwayBaseTypes.xsd
|nattr=<br>
* /rollingstock/vehicles/vehicle/wagon/passenger/places/@tapTsiType9039Code
* /rollingstock/vehicles/vehicle/wagon/passenger/service/@tapTsiType7161Code
* /timetable/trainParts/trainPart/formationTT/passengerUsage/places/@tapTsiType9039Code
* /timetable/trainParts/trainPart/formationTT/passengerUsage/service/@tapTsiType7161Code 
}}


[[Category:GeneralDescription]]