Path Request process message sequence

Content
VersionRelease dateAuthorHighlights
227.06.2022Nicolas Jasinski

- Alignment between use cases description and sequence diagram

- Implementation of PRM to applicants

- OIM structure update and alignment to Sector xsd schema

- Inclusion of the "Automatic downgrade of an acceptance indicator" use case

323.09.2022Nicolas Jasinski

Overall remark: improved alignment with the existing implementation, the implementation across the different process types/use cases and the Sector Handbook

- "Reject dossier as Leading IM" - PTID and RPTID: development under analysis 

- "Send offer" notifications: updated PTID and RPTID implementation

- "Accept the offer as Leading Applicant" notifications: updated PTID and RPTID implementation

- "Refuse offer as LA" notifications: updated PTID and RPTID implementation

-In progress

Nicolas Jasinski

- Reject dossier as Leading IM: PTID implementation status (implemented)

USE CASES OF THE PATH REQUEST PROCESSES 

TOR is always equal to "2" in the Path Request process.

 

Create dossier 

Sent information

The dossier is created by the Leading Applicant (LA). To do that, it shall send a Path Coordination Message with Train Information element to PCS with the following content, so that the system can build up an international dossier with the respective Applicant-IM pairs:

  • Message header:
    • Sender: company code of the leading applicant
    • Recipient: 3178 (RNE)
  • TOI: 30 – create dossier
  • Planned Transport Identifiers: TR ID.
  • Train Information

 

Result

The dossier is created in PCS. If there is an issue with the message, PCS sends back an Error Message with the root cause..

Path Coordination Messages can contain Train Information and/or Path Information element. For dossier creation, PCS considers the information from the Train Information element. Based on that, PCS prepares the dossier with the following content:

  • Territories: based on the RA  - IM pairs in the Train Information.
  • Sub-paths: based on the Planned Journey Location information in the Train Information element (each RA - IM pair must have at least two locations in the Train Information). PR IDs are generated for each sub-paths based on the PCS path IDs in the system
  • Dossier ID: CR ID in TAF TSI
  • Train ID

 

Notifications 

The LA receives a Receipt Confirmation Message with the following content:

  • Message header:
    • Sender: 3178 (RNE)
    • Recipient: company code of the LA
  • Related reference

The involved applicants shall be informed that a dossier was created and that it is now in Harmonization, they receive an Object Info Message with the following content:

  • Message header:
    • Sender: 3178 (RNE)
    • Recipient: company code of any involved applicant
  • Identifier: CR ID
  • Train Information Extended:
    • PlannedTransportIdentifiers (PTID): TR ID
    • RelatedPlannedTransportIdentifiers (RPTID): all objects ID of the dossier
    • PathInformationExtended (PIE):
      • PTID: PR ID
      • Path Information: for each PR listed in PTID

 

Set acceptance indicator to green 

Applicable for both RAs and IMs for harmonisation and coordination purposes. 

Sent Information

Any involved agency who would like to set the acceptance indicator to green shall send Path Coordination Message without Train Information and Path Information with the following content:

  • Message header:
    • Sender: company code of any involved agency
    • Recipient: 3178 (RNE)
  • TOI: according to the TOI mapping above. Applicants and IMs can use those TOIs to change their acceptance indicators to the proper colour in the different dossier statuses.
  • Planned Transport Identifiers: TR ID, CR ID

 

Result

If all the mandatory information is fulfilled in the dossier, the acceptance indicators belonging to the involved agency are changed to green. If not, then PCS will send an Error Message.

 

Notifications 

The agency that set the light receives a Receipt Confirmation Message.

The involved agencies (applicants or IMs depending on the phase) shall be informed about the phase promotion. They receive a Path Coordination Message without Train Information and Path Information and with the following content:

  • Message header:
    • Sender: 3178 (RNE)
    • Recipient: company code of any involved agency
  • TOI: according to the TOI mapping
  • Planned Transport Identifiers: TR ID, CR ID, PR or PA ID

If the object (PR/PA) has not been prepared via a TAF TSI message, the object company code will be RNE's and not the agency's that created the object. To identify the responsible applicant/IM that updated the indicator for the mentioned PRID/PAID, please refer to the path information included in a PRM, PDM or OIM for the dossier and the responsible RU/IM will be indicated for the corresponding PR ID / PA ID.

 

Set acceptance indicator to red 

Applicable for both RAs and IMs for harmonisation and coordination purposes. 

Sent information

Any involved agency who would like to set the acceptance indicator to red shall send Path Coordination Message without Train Information and Path Information with the following content:

  • Message header:

    • Sender: company code of the involved agency
    • Recipient: 3178 (RNE)
  • TOI: according to the TOI mapping above. Applicants and IMs can use those TOIs to change their acceptance indicators to the proper colour in the different dossier statuses.
  • Planned Transport Identifiers: TR ID, CR ID
  • Mandatory free text field on the message level: reason for the red light

It works the same as changing the light to green or yellow, the only difference is that the sender agency shall put a mandatory comment in the free text field of the message.

 

Result

The involved agency set its acceptance indicators to red and the reason is saved in the comment area of the dossier.

 

Notifications

The agency that set the light receives a Receipt Confirmation Message.

The involved agencies (applicants or IMs depending on the phase) shall be informed about the phase promotion. They receive a Path Coordination Message without Train Information and Path Information and with the following content:

  • Message header:
    • Sender: 3178 (RNE)
    • Recipient: company code of any involved agency
  • TOI: according to the TOI mapping
  • Planned Transport Identifiers: TR ID, CR ID, PR or PA ID

If the object (PR/PA) has not been prepared via a TAF TSI message, the company code will be RNE's. To identify the responsible applicant/IM that updated the indicator for the mentioned PR/PAID, please refer to the Path Information element included in a PRM, PDM or OIM.

 

Set acceptance indicator to yellow

Applicable for both RAs and IMs for harmonisation and coordination purposes.  

Sent Information

Any involved agency who would like to set the acceptance indicator to green shall send Path Coordination Message without Train Information and Path Information with the following content:

  • Message header:

    • Sender: company code of any involved agency
    • Recipient: 3178 (RNE)
  • TOI: according to the TOI mapping above. Applicants and IMs can use those TOIs to change their acceptance indicators to the proper colour in the different dossier statuses.
  • Planned Transport Identifiers: TR ID, CR ID

 

Result

If all the mandatory information is fulfilled in the dossier, the acceptance indicators belonging to the involved agency are changed to green. If not, then PCS will send an Error Message.

 

Notifications 

The agency that set the light receives a Receipt Confirmation Message.

The involved agencies (applicants or IMs depending on the phase) shall be informed about the phase promotion. They receive a Path Coordination Message without Train Information and Path Information and with the following content:

  • Message header:
    • Sender: 3178 (RNE)
    • Recipient: company code of any involved agency
  • TOI: according to the TOI mapping
  • Planned Transport Identifiers: TR ID, CR ID, PR or PA ID

If the object (PR/PA) has not been prepared via a TAF message, the object company code will be RNE's and not the agency's that created the object. To identify the responsible applicant/IM that updated the indicator for the mentioned PRID/PAID, please refer to the path information included in a PRM, PDM or OIM for the dossier and the responsible RU/IM will be indicated for the corresponding PRID/PAID (also available with the getDossier webservice).

 

General timetable update 

Applicable for both RAs and IMs to make any kind of timetable update (e.g., departure time change or location deletion/add) in the PCS dossier. Please note that if an information (e.g., departure time change or location) already exists in the dossier and is not included in the PCoM, this information will be deleted from the dossier.

Sent information

Any involved agency who would like to make an update on the timetable in a PCS dossier shall send a Path Coordination Message with Path Information and the following content:

  • Message header:

    • Sender: company code of the agency making the update
    • Recipient: 3178 (RNE)
  • TOI: depending on the dossier status and the agency type
  • Planned Transport Identifiers: TR ID, CR ID, PR ID or PA ID (depending on the agency type)
  • Path Information 

 

Result

If everything went fine, the dossier is updated in PCS. If not, an Error Message is sent back with the root cause.

 

Notifications 

The updater receives a Receipt Confirmation Message.

Affected agencies receive an Object Info Message with the following content:

  • Message header:
    • Sender: 3178 (RNE)
    • Recipient: company code of any affected agency
  • Identifier: CR ID
  • TOI: 01 harmonization in process, 08 coordination update or 13 preparation of final offer - in process (depending on the dossier status and the agency type)
  • Train Information Extended:
    • PlannedTransportIdentifiers (PTID): TR ID
    • RelatedPlannedTransportIdentifiers (RPTID): all objects ID of the dossier
    • PathInformationExtended (PIE):
      • PTID: all modified PR or PA (depending on the phase) 
      • Path Information: for each PR or PA ID listed in PTID
      • Every subpath gets its own PathInformationExtended element

 

Automatic downgrade of an acceptance indicator 

Please refer to this guide for more details.

Sent information

Not applicable.

 

Result

The acceptance indicator of the affected agency is changed to yellow.

 

Notifications

The affected agencies receive a Path Coordination Message with the following content:

  • Message header:
    • Sender: 3178 (RNE)
    • Recipient: company code of any affected applicant or IM (depending on the phase)
  • TOI: 01 harmonization in process, 08 coordination update or 13 preparation of final offer - in process (depending on the dossier status and the agency type)
  • Planned Transport Identifiers: TR ID, CR ID, PR ID and or PA ID of the agency that made the change resulted in the downgrade.

 

Submit Path Request

The aim of this use case is to promote the dossier from Harmonization to Path Request as a leading Applicant. As PCS stores everything in the dossier, there is no need to send the PathRequest for every single sub-paths (PR). The leading Applicant simply promotes the whole dossier, also on behalf of the other involved Applicants. This promotion can also occur with an automatic promotion of PCS according to the PCS deadlines and specific conditions. 

Sent information

The LA who would like to promote the dossier to Path Request shall send a Path Coordination Message without Train Information and Path Information and the following content:

  • Message header:
    • Sender: company code of the LA
    • Recipient: 3178 (RNE)
  • TOI: 04 – request ready (NPR, LPR, RP, Ad-hoc) or 19 - pre-accepted offer (Ad-hoc with pre-accepted offer)
  • Planned Transport Identifiers: TR ID, CR ID

 

Result

If all the mandatory information is fulfilled in the dossier and all the acceptance indicators of the Applicants are set to green, the dossier will be promoted. If not, then PCS will send an Error Message.

 

Notifications

The LA receives a Receipt Confirmation Message

Involved applicants shall be informed about the phase promotion (under development). They receive a Path Coordination Message without Train Information and Path Information and with the following content:

  • Message header:
    • Sender: 3178 (RNE)
    • Recipient: company code of any involved applicant
  • TOI: 04 - request ready (NPR, LPR, RP, Ad-hoc) or 19 - pre-accepted offer (Ad-hoc)
  • Planned Transport Identifiers: TR ID, CR ID

 

Information about the dossier in Path Request phase

All involved agencies shall be informed about the path requests. They receive a Path Request Message for their territory with the following content:

  • Message header:
    • Sender: 3178 (RNE)
    • Recipient: company code of any involved IM/applicant
  • TOI: 04 - request ready (NPR, LPR, RP, Ad-hoc) or 19 - pre-accepted offer (Ad-hoc)
  • Planned Transport Identifiers: TR ID, CR ID, PR ID
  • Related Planned Transport Identifiers: PA ID (IM Timetable) corresponding to the PR ID (applicant timetable) from the Planned Transport Identifiers element and all other PR IDs belonging to the same territory.
  • Train Information
  • Path Information

 

Release Path Elaboration

Path Request is a milestone in PCS and dossiers are automatically promoted to the next phase, called Path Elaboration. Involved IMs receive a Path Coordination Message with Train Information and Path Information. As it’s only a “simple” phase promotion, there is no Object Info Message in this case.

  • Message header:
    • Sender: 3178 (RNE)
    • Recipient: company code of any involved IM
  • TOI: 07 – create offer
  • Planned Transport Identifiers: TR ID, CR ID, PR ID
  • Related Planned Transport Identifiers: PA ID (IM Timetable) corresponding to the PR ID (applicant timetable) from the Planned Transport Identifiers element and all other PR IDs belonging to the same territory.
  • Train Information
  • Path Information

 

Delete a sub-path from a dossier 

Applicable for both RAs and IMs.

Sent information

Any involved agency who would like to delete a sub-path from a dossier shall send a Path Coordination Message without Train Information and Path Infrmation and with the following content:

  • Message header:
    • Sender: company code of any involved applicant
    • Recipient: 3178 (RNE)
  • Planned Transport Identifiers: TR ID, CR ID, PR ID or PA ID (depending on the agency type)
  • TOI: 32 – path canceled full

 

Result

The sub-path either with the PR ID from the Applicant timetable or with the PA ID from the IM timetable is successfully deleted.

 

Notifications

The updater receives a Receipt Confirmation Message.

As this update affects the whole dossier content, affected agencies receive an Object Info Message (under improvement: info about "deleted" path) without Train Information and Path Information from PCS with the following content:

  • Message header:
    • Sender: 3178 (RNE)
    • Recipient: company code of any affected applicant or IM
  • Identifier: CR ID
  • TOI: 32 – path canceled full

 

Send Offer

The aim of this use case is to show how the leading IM/AB can send an offer (draft or final). The offer submission can also occur with an automatic submission of PCS according to the PCS deadlines and specific conditions. 

Sent information

The LIM who would like to submit an offer for a PCS dossier shall send a Path Coordination Message without Train Information and Path Information with the following content:

  • Message header:

    • Sender: company code of the LIM
    • Recipient: 3178 (RNE)
  • TOI: 09 - draft offer (for promotions from Path Elaboration during New Path Request, Late Path Request and Rolling Planning process types), 16 - final offer (for promotions from Post-processing during New Path Request, Late Path Request and Rolling Planning process types, from Path Elaboration during Ad-hoc Path Request process type)
  • Planned Transport Identifiers: TR ID, CR ID

 

Result

If all the mandatory information is fulfilled in the dossier and all the acceptance indicators of the IMs/ABs are set to green, the dossier will be promoted. If not, then PCS will send an Error Message.

 

Notifications

The LIM receives a Receipt Confirmation Message.

Involved IMs shall be informed about the phase promotion. They receive a Path Coordination Message with the following content:

  • Message header:
    • Sender: 3178 (RNE)
    • Recipient: company code of any involved IM
  • TOI: 09 – draft offer, 16 – final offer
  • Planned Transport Identifiers: TR ID, CR ID, PA ID
  • Related Planned Transport Identifiers: all other PA IDs and PR IDs belonging to the same territory as the PA ID listed in Planned Transport Identifiers element

All involved agencies shall be informed about the offers. They receive a Path Details Message with the following content:

  • Message header:
    • Sender: 3178 (RNE)
    • Recipient: company code of any involved agency
  • TOI: 09 – draft offer, 16 – final offer
  • Planned Transport Identifiers: TR ID, CR ID, PA ID
  • Related Planned Transport Identifiers: all other PA IDs and PR IDs belonging to the same territory as the PA ID listed in Planned Transport Identifiers element
  • Path Information

 

Reject dossier as Leading IM 

The aim of this use case to show how a leading IM can reject a dossier (only possible Path Elaboration phase).

Sent information

The LIM who would like to reject a dossier in PCS shall send a Path Coordination Message without Train Information and Path Information and with the following content:

  • Message header:
    • Sender: company code of the LIM
    • Recipient: 3178 (RNE)
  • TOI: 29 - withdrawal
  • Planned Transport Identifiers: TR ID, CR ID
  • Free text field on the message level: the reason for the rejection

 

Result

The dossier is rejected by the leading IM and it goes back to Harmonization status. Also, the reason for the rejection is saved to the comment area of the dossier.

 

Notifications

The LIM receives a receipt Confirmation Message. 

All agencies shall be informed about the rejection. They receive a Path Coordination Message without Train Information and Path Information and with the following content:

  • Message header:
    • Sender: 3178 (RNE)
    • Recipient: company code of any involved agency
  • TOI: 29 - withdrawal
  • Planned Transport Identifiers: TR ID, CR ID, PR ID 
  • Related Planned Transport Identifiers: PA IDs and PR IDs belonging to the same territory as the PR ID listed in Planned Transport Identifiers element (under analysis)
  • Free text field on the message level: the reason for the rejection

 

Accept the offer as Leading Applicant 

The aim of this use case to show, how a leading Applicant can accept the dossier and promote it to Active Timetable:

  • New Path Request and Rolling Planning processes: the acceptance is only possible in the Final Offer phase (after the Post-processing phase)
  • Late Path Request and Ad-hoc Path Request processes: the acceptance is possible in the Acceptance phase (next step following the PAth Elaboration)

Sent information

The LA who would like to accept the dossier and move it to Active Timetable shall send a Path Coordination Message without Train Information and Path Information with the following content. This is valid for all process types.

  • Message header:
    • Sender: company code of the LA
    • Recipient: 3178 (RNE)
  • TOI: 17 – final offer - accepted
  • Planned Transport Identifiers: TR ID, CR ID

 

Result

If all the mandatory information is fulfilled in the dossier and all the acceptance indicators of the applicants are set to green, the dossier will be promoted, and it arrives at the Active Timetable phase.

 

Notifications

The LA receives a Receipt Confirmation Message.

Involved IMs shall be informed about the acceptance; thus, PCS will send Path Confirmed Messages with the following content:

  • Message header:
    • Sender: 3178 (RNE)
    • Recipient: company code of any involved IM
  • TOI: 17 – final offer - accepted
  • Planned Transport Identifiers: TR ID, CR ID, PA ID
  • Related Planned Transport Identifiers: all other PA IDs and PR IDs belonging to the same territory as the PA ID listed as Planned Transport Identifiers element

 

Dossier transition to Active Timetable

As the dossier arrived at Active Timetable, it reached its final destination in the path request process. To keep all applicants up to date, PCS sends Path Details Messages with the booked paths to all involved agencies with the following content: 

  • Message header:
    • Sender: 3178 (RNE)
    • Recipient: company code of any involved agency
  • TOI: 22 - booked
  • Planned Transport Identifiers: TR ID, CR ID, PA ID
  • Related Planned Transport Identifiers: all other PA IDs and PR IDs belonging to the same territory as the PA ID listed as Planned Transport Identifiers element
  • Path Information

The same shall happen for Pre-accepted offer dossier: after the LIM sends the offer, the dossier transitions Active Timetable.

 

Refuse Offer as Leading Applicant 

The aim of this use case is to show, how a leading Applicant can refuse an offer. Two options are available to them:

  1. Refusal without revision
  2. Refusal with required revision (available only for Ad-hoc path requests)

Sent information

The LA who would like to refuse the offer shall send a Path Coordination Message to PCS without Train Information and Path Information with the following content:

  • Message header:
    • Sender: company code of the LA
    • Recipient: 3178 (RNE)
  • TOI: 25 – offer/final offer rejected (without revision) or 27 – offer/final offer rejected (revision required)
  • Planned Transport Identifiers: TR ID, CR ID

 

Result

The result depends on the selected refusal option. If it’s done without revision, the dossier will go to the Closed phase, but if it’s with revision (available only for Ad-hoc path request), it will go back to Path Elaboration.

 

Notifications

Involved applicants shall be informed about the rejection. They receive a Path Coordination Message without Train Information and Path Information with the following content:

  • Message header:
    • Sender: 3178 (RNE)
    • Recipient: company code of any involved applicant
  • TOI: 25 – offer/final offer rejected (without revision) or 27 – offer/final offer rejected (revision required)
  • PTID: TR ID, CR ID, PA ID
  • RPITD: other PA IDs and PR IDs belonging to the same territory as the PA ID listed in Planned Transport Identifiers element

Involved IMs shall be informed about the rejection too. They receive a Path Details Refused Message with the following content:

  • Message header:
    • Sender: 3178 (RNE)
    • Recipient: company code of any involved IM
  • TOI: 25 – offer/final offer rejected (without revision) or 27 – offer/final offer rejected (revision required)
  • PTID: TR ID, CR ID, PA ID
  • RPITD: other PA IDs and PR IDs belonging to the same territory as the PA ID listed in Planned Transport Identifiers element

 

Make Observations (Development on hold - Pending alignment with RNE Process group and PCS TB)

The aim of this use case to show how an Applicant can place an Observation in a dossier.

Sent information

The involved applicant who would like to place an Observation shall send a Path Coordination Message without Train Information and Path Information with the following content. Please note that this use case is valid only for New Path Request and Rolling Planning process types because the Consultation phase is not part of the other process types.

  • Message header:
    • Sender: company code of the applicant making the observation
    • Recipient: 3178 (RNE)
  • TOI: 11 – observation - in process
  • Planned Transport Identifiers: TR ID, CR ID, PA ID
  • Free text field: the text of the Observation

 

Result

The Observation is saved in PCS in the comment area.

 

Notifications

The applicant that made the observation shall be informed that it was made successfully. He receives a Receipt Confirmation Message.

The IMs shall be informed that an Observation was made to one of the sub-paths. They receive a Path Coordination Message without Train Information and Path Information with the following content:

  • Message header:
    • Sender: 3178 (RNE)
    • Recipient: company code of any involved agency
  • TOI: 11 – observation - in process
  • Planned Transport Identifiers: TR ID, CR ID, PA ID
  • Free text field: the text of the Observation

 

Release Post-Processing 

The aim of this use case is to show,how the leading Applicant can promote the dossier to Post-processing. This promotion can also occur with an automatic promotion of PCS according to the PCS deadlines and specific conditions. 

Sent information

The LA who would like to promote the dossier to Post-processing shall send a Path Coordination Message without Train Information and Path Information with the following content:

  • Message header:
    • Sender: company code of the LA
    • Recipient: 3178 (RNE)
  • TOI: 12 – observation - complete
  • Planned Transport Identifiers: TR ID, CR ID

 

Result

The dossier is promoted to Post-processing.

 

Notifications

The LA receives a Receipt Confirmation Message. 

All involved agencies shall be informed about the dossier promotion. They receive a Path Coordination Message without Train Information and Path Information with the following content:

  • Message header:
    • Sender: 3178 (RNE)
    • Recipient: company code of any involved agency
  • TOI: 12 – observation - complete
  • Planned Transport Identifiers: TR ID, CR ID

 

Withdraw dossier 

The aim of this use case to show,how a leading Applicant can withdraw a dossier (available only in Path Elaboration phase).  

Sent information

The LA who would like to withdraw a dossier in PCS shall send a Path Coordination Message without Train Information and Path Information with the following content:

  • Message header:
    • Sender: company code of the LA
    • Recipient: 3178 (RNE)
  • TOI: 29 - withdrawal
  • Planned Transport Identifiers: TR ID, CR ID
  • Free text field on the message level: the reason for the withdrawal

 

Result

The dossier is withdrawn by the leading Applicant and it goes back to Harmonization status. Also, the reason for the withdrawal is saved to the comment area of the dossier.

 

Notifications

The LA receives a Receipt Confirmation Message. 

All agencies shall be informed about the withdrawal. They receive a Path Coordination Message without Train Information and Path Information with the following content:

  • Message header:
    • Sender: 3178 (RNE)
    • Recipient: company code of any involved agencies
  • TOI: 29 - withdrawal
  • Planned Transport Identifiers: TR ID, CR ID, PR ID
  • Free text field on the message level: reason for the withdrawal

 

Get dossier 

Any involved agency of the dossier has a chance to download the dosser from PCS at any time. To do so, they only need to send an Object Info Message and PCS will send back the dossier also packed to an Object Info Message.

Sent information

The involved agency who would like to download a dossier in PCS shall send an Object Info Message without Train and Path Information Extended element and with the following content:

  • Message header:
    • Sender: company code of the involved agency
    • Recipient: 3178 (RNE)
  • ObjectInfoType: R
  • Identifier: CR ID

 

Result

As it is not an update in PCS, there is no result in the system, apart from the registered web-service request.

 

Notifications

The requesting agency receives an Object Info Message with the following content:

  • Message header:
    • Sender: 3178 (RNE)
    • Recipient: company code of the involved Applicant
  • ObjectInfoType: I
  • Identifier: CR ID
  • Train Information Extended:
    • PlannedTransportIdentifiers (PTID): TR ID
    • RelatedPlannedTransportIdentifiers (RPTID): all objects ID of the dossier
    • PathInformationExtended (PIE):
      • PTID: all PR or PA ID (depending on the phase) of all the subpaths.
      • Path Information: for each PR or PA ID listed in PTID
      • Every subpath gets its own PathInformationExtended element

 

File