CIF Schedule Records: Difference between revisions

From Open Rail Data Wiki
← Older edit
Jpl (talk | contribs)
337 edits
m Bank holiday running note
Tidy up CIF Schedule Records page
 
Line 1: Line 1:
== Overview ==
== Overview ==
Schedule records are contained within the [[SCHEDULE]] data feed, and provide information about the possible schedules available for trains.  For a given train service, there may be multiple schedules listed - the date of the train service and any short / very-short term plans will affect which schedule is current.
Schedule records are contained within the [[SCHEDULE]] data feed, and provide information about the possible schedules available for trains.  For a given train service, there may be multiple schedules listed - the date of the train service and any short / very-short term plans will affect which schedule is current.


Line 11: Line 12:


== Record Format ==
== Record Format ==
<pre>
BSRG828851510191510231100100 POO2N75    113575825 DMUE  090      S            O
BX        SRY                                                                 
LOGLGQHL  1703 17033  UEG    TB                                               
LICWLRSSJ          1706 00000000                                             
LICWLRSWJ          1706H00000000      UEG                                     
LIBSHB    1709 1710      17091710        T                                   
CRLENZIE  OO2N75    123578903 DMUE  090      S                               
LILENZIE  1714 1714H    17141714        T                                   
LICROY              1720 000000001                      1H                     
LIGNHLUJN          1726 00000000                        H                     
LIGNHLLJN          1727 00000000                                             
LICRMRSWJ          1729 00000000                                             
LICRMRSEJ          1730 00000000                                             
LICAMELON 1731 1732      17311732        T                                   
LTFALKRKG 1734 17341    TF                                                   
</pre>
== Record Types ==
=== BS - Basic Schedule ===
{|class ="wikitable"
! Field !! Format !! Size !! Mandatory !! Comment
|-
| Record Identity || String || 2 || Y || Value ''BS''.
|-
| Transaction Type || Char || 1 || Y || The type of transaction
* '''N''' - New
* '''D''' - Delete
* '''R''' - Revise.
|-
| Train UID || String || 6 || Y || The identifier for the schedule.  This is made up of a letter plus five numbers.  There may be multiple schedules for one schedule UID.  See also the ''train_uid'' field of the [[Train_Activation | TRUST Train Activation]] message type.
|-
| Date Runs From || Date (YYMMDD)|| 6 || Y || The start date of the schedule.
|-
| Date Runs To || Date (YYMMDD)|| 6 || Y* || The end date of the schedule.
|-
| Days Run || Bit String || 7 || Y* || A seven-bit field; first bit starting from the left represents Monday, and last bit represents Sunday. A ''1'' means that the service runs on that day, while a ''0'' means that it does not.
|-
| Bank Holiday Running || Char || 1 || || Bank holiday running code:
* ''X'' - Does not run on specified Bank Holiday Mondays
* ''G'' - Does not run on Glasgow Bank Holidays.
'''Note:''' The sole purpose of this field is to add the BHX symbol to the relevant column in a printed timetable. Actual changes for bank holiday workings for each train schedule are indicated by STP overlays or STP cancellations.
|-
| Train Status || Char || 1 || Y* || See [[CIF_Codes#Train_Status | train status codes]].
|-
| Train Category || String || 2 || Y* || See [[CIF_Codes#Train_Category | train category codes]].
|-
| Train Identity || String || 4 || Y* || Signalling ID, also referred to as headcode, not to be confused with below.  For passenger services, this is the headcode of the service.  For anonymous freight services this will be blank.
|-
| Headcode || Numeric || 4 ||  || National Reservation System headcode, designated by train operator, not to be confused with above.
|-
| Course Indicator || Numeric || 1 || Y || Not used. Value ''1''.
|-
| Train Service Code || Numeric || 8 || Y* || Divides trains into ''[[TrainServiceCode | service groups ]]''. Is used for attribution of revenue.
|-
| Portion ID || Char || 1 ||  || Used to denote a Portion ID for services involved in joining / splitting activities (Associations).
|-
| Power Type || String || 3 || Y* || See [[CIF_Codes#Power_Type | power type codes]].
|-
| Timing Load || String || 4 ||  || See [[CIF_Codes#Timing_Load | timing load codes]].
|-
| Speed || Numeric || 3 || Y* || Planned speed of the train service in miles per hour.
|-
| Operating Characteristics || String || 6 ||  || See [[CIF_Codes#Operating_Characteristics | operating characteristics codes]].
|-
| Seating Class || Char || 1 ||  || Seating classes available:
* ''Blank'' or ''B'' - First and standard
* ''S'' - Standard class only.
|-
| Sleepers || Char || 1 ||  || Sleeping accommodation available:
* ''B'' - First and standard class
* ''F'' - First Class only
* ''S'' - Standard class only.
|-
| Reservations || Char || 1 ||  || Reservation recommendations:
* ''A'' - Reservations compulsory
* ''E'' - Reservations for bicycles essential
* ''R'' - Reservations recommended
* ''S'' - Reservations possible from any station.
|-
| Connection Indicator || Char || 1 ||  || Not used.
|-
| Catering Code || String || 4 ||  || Up to two characters from the following:
* ''C'' - Buffet Service
* ''F'' - Restaurant Car available for First Class passengers
* ''H'' - Hot food available
* ''M'' - Meal included for First Class passengers
* ''P'' - Wheelchair only reservations
* ''R'' - Restaurant
* ''T'' - Trolley service.
|-
| Service Branding || String || 4 ||  || Service brand:
* ''E'' - Eurostar.
|-
| Spare ||  || 1 ||  ||
|-
| STP Indicator || Char || 1 || Y || STP (short-term planning) schedule indicator:
* '''C''' - STP cancellation of permanent association
* '''N''' - New STP association (not an overlay)
* '''O''' - STP overlay of permanent association
* '''P''' - Permanent association
|}
<nowiki>*</nowiki> may be truncated in ''Delete'' records.
=== BX - Basic Schedule Extra Details ===
Note that for Deletion and Cancellation of schedules, a BX record will not be issued.
{|class ="wikitable"
! Field !! Format !! Size !! Mandatory !! Comment
|-
| Record Identity || String || 2 || Y || Value ''BX''.
|-
| Traction Class || String || 4 ||  || Not used.
|-
| UIC Code || Numeric || 5 ||  || A 5-character numeric code for train services running to/from continental Europe.
|-
| ATOC Code || String || 2 || Y || See [[TOC_Codes | TOC codes]].
|-
| Applicable Timetable Code || Char || 1 || Y ||
* ''Y'' - Train is subject to performance monitoring (Applicable Timetable Service)
* ''N'' - Train is not subject to performance monitoring (Not Applicable Timetable Service)
|-
| Reserved field || String || 8 ||  || RSID. Not populated from ITPS.
|-
| Reserved field || Char || 1 ||  || Data source. Not populated from ITPS.
|-
| Spare ||  || 57 ||  ||
|}
=== LO - Origin Location ===


{|class ="wikitable"
A schedule comprises a [[CIF_Basic_Schedule | BS (Basic Schedule)]] record.  For actions other than 'delete', there will be a [[CIF_Basic_Schedule_Extended | BX (Basic Schedule Extended)]] record, and a group comprising [[CIF_Location | LO/LI/CR/LT records]]:
! Field !! Size !! Comment
|-
| Record Identity || 2 || Value ''LO''.
|-
| Location || 8 || TIPLOC + Suffix
|-
| Scheduled Departure Time || 5
|-
| Public Departure Time || 4
|-
| Platform || 3
|-
| Line || 3
|-
| Engineering Allowance || 2
|-
| Pathing Allowance || 2
|-
| Activity || 12
|-
| Performance Allowance || 2
|-
| Spare || 37
|}


=== LI - Intermediate Location ===
* Exactly one Location Origin (LO) record
* Zero or more Location Intermediate (LI) records
* Zero or more Change en Route (CR) records
* Exactly one Location Terminate (LT) record.


{|class ="wikitable"
For BS records with a type of 'delete', this will be the only record, as schedules to be deleted are identified only by a truncated record.
! Field !! Size !! Comment
|-
| Record Identity || 2 || Value ''LI''.
|-
| Location || 8 || TIPLOC + Suffix
|-
| Scheduled Arrival Time || 5
|-
| Scheduled Departure Time || 5
|-
| Scheduled Pass || 5
|-
| Public Arrival || 4
|-
| Public Departure || 4
|-
| Platform || 3
|-
| Line || 3
|-
| Path || 3
|-
| Activity || 12
|-
| Engineering Allowance || 2
|-
| Pathing Allowance || 2
|-
| Performance Allowance || 2
|-
| Spare || 20
|}


{{Navtable-CifSchedule}}
{{Navtable-CifSchedule}}

Latest revision as of 08:31, 18 November 2023

Overview

Schedule records are contained within the SCHEDULE data feed, and provide information about the possible schedules available for trains. For a given train service, there may be multiple schedules listed - the date of the train service and any short / very-short term plans will affect which schedule is current.

A schedule record comprises of a header containing a schedule UID, data about the schedule (including whether it is a train, bus or ship) and validity dates, and an ordered list of locations and times at which a particular service should arrive, depart or pass.

  • Originating locations will always have a WTT departure time and optionally a public departure time
  • Intermediate locations in a schedule will have a passing time if they are a mandatory timing point, or an arrival and departure time if the train carries out an activity at that location
  • Terminating locations will always have a WTT arrival time and optionally a public arrival time, which may be some minutes later than the WTT time
  • A location may have one or more activities associated with it - for example, U for locations where the train calls to pick up passengers (i.e. not available for alighting), D for locations where the train calls to set down passengers (i.e. not available for boarding).
  • A location may have engineering, pathing or performance allowances

Record Format

A schedule comprises a BS (Basic Schedule) record. For actions other than 'delete', there will be a BX (Basic Schedule Extended) record, and a group comprising LO/LI/CR/LT records:

  • Exactly one Location Origin (LO) record
  • Zero or more Location Intermediate (LI) records
  • Zero or more Change en Route (CR) records
  • Exactly one Location Terminate (LT) record.

For BS records with a type of 'delete', this will be the only record, as schedules to be deleted are identified only by a truncated record.


CIF
CIF HD (Header) • ZZ (End of File)
TIPLOC TI (TIPLOC Insert) • TA (TIPLOC Amend) • TD (TIPLOC Delete)
Association AA (Association)
Location BS (Basic Schedule) • BX (Basic Schedule Extended) • LO (Location Origin) • LI (Location Intermediate) • CR (Change-en-Route) • LT (Location Terminate)


Network Rail Open Data Feeds
Data Feeds About the Feeds • Account States • Durable Subscriptions • Example Code ( PHP / C# / Java / Ruby / Node.js) • Advanced Uses • FAQ • Release Notes
RTPPM RTPPM Feed
Train Movements Train Movements Feed • Train Activation • Train Cancellation • Train Movement • Train Reinstatement • Change of Origin • Change of Identity • Change of Location • TSPEED Field • Planned Cancellations • Cancellation Codes
TD TD Feed • C-Class Messages • S-Class Messages • Train Describers • TD Berths
VSTP VSTP Feed
TSR TSR Feed • Route Codes
SCHEDULE SCHEDULE Feed • TIPLOC Records • Schedule and Location Records • Association Records • CIF Codes • How Scheduling Works • Allowances
Reference Data Reference Data Feed • TOC Codes • CIF Codes • Delay Attribution Codes • Identifying Locations (STANOX, TIPLOC, NLC and 3-Alpha Codes) • STANOX Geographical Areas • Train Planning data (BPLAN)
Retrieved from "https://wiki.openraildata.com/index.php?title=CIF_Schedule_Records&oldid=3296"