PRISE. Status Message (XML) Business Integration for the Port of Hamburg. Message Implementation Guide Version 1.3.0/E. (Valid from

Transcription

1 Message Implementation Guide PRISE XML Status Message PRISE Status Message (XML) Business Integration for the Port of Hamburg Message Implementation Guide Version 1.3.0/E (Valid from ) Mattentwiete Hamburg Phone: Fax: info@dakosy.de Version 1.3.0/E Page: 1 of 11

2 PRISE XML Status Message Change History Version Concerned section Reason Name Datum 1.0 All First compilation Koschine New element AgentCode Extension A. Kunze Addition of the new field Visit_ID Extension A. Kunze Display of element types in manuals extended J. Diettrich /E Field LocalReferenceNumber Max. length increased to 40 J. Diettrich Change requests DAKOSY Mattentwiete Hamburg 1. Phone: Fax: info@dakosy.de Used tools Number Used tools W1 This document was created with the word processing programme MS Word Liability 1. Please note that no liability claims can be derived towards DAKOSY AG for the content of this manual, despite careful developing and examination of this document! Version 1.3.0/E Page: 2 of 11

3 Table of contents 1 Message Structure Guideline... 6 Version 1.3.0/E Page: 3 of 11

4 1 Message Structure Occurrence Status Version InterchangeHeader Version CreationTime ExchangeNumber TestIndicator MessageCount Sender ParticipantCode AgencyID Recipient ParticipantCode AgencyID StatusMessage MessageHeader MessageFunction MessageReferenceNumber MessageSender ParticipantCode AgencyID MessageRecipient ParticipantCode AgencyID AdditionalValue Name Value Body Version StatusCode OriginalMessageReferenceNumber OriginalMessageFunction Visit_ID HPA_Number LocalReferenceNumber BerthReferenceNumber Date Occurrence Draught ExpectedWaterLevel GeneralInformation Version 1.3.0/E Page: 4 of 11

5 0.. 1 ParticipantIdentification AgentCode Location Name Value TransportDetails VoyageNumber IMO VesselName Date CallSign OutboundVessel VoyageNumber IMO VesselName ETD CallSign BerthReferenceNumber LocalReferenceNumber Version 1.3.0/E Page: 5 of 11

6 2 Guideline Status Type prise:statustype Version Type xs:string Use Description Full version of message type of InterchangeHeader, MessageHeader and message body. InterchangeHeader Occurence Type prise:interchange Description Each interchange starts with an element which contains different meta data and is followed by one or more messages. Version Type xs:string Use CreationTime Occurence Type prise:documentcreationtime Example T13:27:00 Description Creation date/time of message document. ExchangeNumber Occurence Type prise:documentexchangenumber Length Example 000ICEN Description Unique reference of an interchange. TestIndicator Occurence Type xs:boolean Default false Name Test indicator MessageCount Occurence Type prise:messagecount FractionDigits 0 Inclusive 1.. Description Number of messages (message elements) within one interchange. In case of PRISE there may be several messages (message elements) per interchange. Sender Occurence Type prise:participant Description Participant of data interchange (e.g. DAKOSY participant). Contains information about the participant who compiled and sent the interchange. ParticipantCode Occurence Type prise:participantcode Description Participant code Name Participant code AgencyID Type xs:string Default DAK Recipient Occurence Type prise:participant Description Participant of data interchange (e.g. DAKOSY participant). Contains information about the consignee of an interchange. This participant can forward the interchange as a whole or split it into single messages to be processed. ParticipantCode Occurence Type prise:participantcode Version 1.3.0/E Page: 6 of 11

7 Description Participant code Name Participant code AgencyID Type xs:string Default DAK StatusMessage Occurence Type prise:statusmessage MessageHeader Occurence Type prise:messageheader Description The message header contains meta information referring to single messages, which are transmitted as part of an interchange. MessageFunction Occurence Type prise:messagefunction Length Example 9 Description This field is used to mark the message as original. Applicable codes 9 MessageReferenceNumber Occurence Type prise:messagereferencenumber Length Description Unique reference to identify a message. An interchange or a transmission file may contain several messages in PRISE. MessageSender Occurence Type prise:participant Description This element contains information about the actual message sender (who may differ from the sender of the interchange). ParticipantCode Occurence Type prise:participantcode Description Participant code AgencyID Type xs:string Default DAK MessageRecipient Occurence Type prise:participant Description This element contains information about the consignee(s) of a message. ParticipantCode Occurence Type prise:participantcode Description Participant code AgencyID Type xs:string Default DAK AdditionalValue Occurence Type prise:additionalvalue Description Reservered space for extensions. Name Type prise:keyname Length Description Name of key value. Value Type prise:keyvalue Length Description Related value (free text) Version 1.3.0/E Page: 7 of 11

8 Body Occurence Type prise:statusmessagedetailtyp Version Type xs:string Use Description Full version of message type of InterchangeHeader, MessageHeader and message body. StatusCode Occurence Type prise:statuscode Length Description --- Status Berth announcement Confirmation of a berth announcement by the Hamburg Port Authority (DV-Elbe) Rejection of a berth announcement by the Hamburg Port Authority (DV-Elbe) No response to a berth announcement from DV-Elbe after 2 hours Berth announcement has been cancelled Berth announcement has been changed ATA has been updated: ATA refers to the allowed time of arrival at the harbour pilot station ETA at berth has been updated ETD at berth has been updated --- Status messages to ETA list Berth announcement has been assigned to an entry in the ETA list of the Elbe pilots. The status includes the ETA for E1, E3 or ST (key ton) and the draught No entry in the ETA list of the Elbe pilots to existing berth announcement Update of draught information from ETA list of Elbe pilots ETA of berth announcement and ETA of ETA list vary widely Update of ETA from ETA list of Elbe pilots referring to E1, E3 or ST (key ton) --- Vessel movements Current position of the vessel (Elbe kilometer, marker/river kilometer, current berth code) Actual arrival: date and time, including terminal, berth code and draught Actual departure: date and time, including terminal, berth code and draught --- Status messages to vessel breadth Possible encounter conflict between two vessels with a summed up overall width exceeding 90 meters --- Confirmation of responsibility Confirmation of responsibility: tugboats, linesmen and Elbe and harbour pilots 942 Notification of "non-responsibility": tugboats, linesmen and Elbe and harbour pilots 944 Warning message if no responsibility has been reported: tugboats, linesmen, Elbe and harbour pilots --- Status to ETC / Draught at departure ETC of berth announcement has been updated 951 Current draught at departure: new or after a change 955 Draught at departure greater than the water level Version 1.3.0/E Page: 8 of 11

9 forecasting --- Further status Current draught from DV-Elbe 961 New order from DV-Elbe OriginalMessageReferenceNumber Occurence Type prise:originalmessagereferencenumber Length Description Reference of original message being responded by this status. The reference is the "MessageReferenceNumber" of the original message. OriginalMessageFunction Occurence Type prise:originalmessagefunction Length Description This field is only to be used in case of status 040 and 041. Referring to the MessageFunction of the previous berth announcement. 1 Cancellation 5 Replacement 9 Original Applicable codes Visit_ID Occurence Type prise:visit_id Length Description Visit ID: unique arrival reference for a given port. This reference will be issued by authorities. The correct pattern is: (DE)([A-Z]{3})-([0-9]{4})-([A-Z]{6}) HPA_Number Occurence Type prise:hpa_number Length Pattern [0-9]{4} Description Provided the reference/transaction no. of the HPA is known, it has to be specified in this segment. The reference/transaction no. has to be specified in case of a cancellation or when cancelling the berth announcement. LocalReferenceNumber Occurence Type prise:localreferencenumber Length Description This element is meant to set the internal reference number of the message sender, e.g. an ID of a berth announcement. BerthReferenceNumber Occurence Type prise:berthreferencenumber Length Pattern [0-9]{27} Description Unique reference to assign a berth announcement. Date Occurence Type prise:datum Description The specification of date/time depends on the status type. Examples for possible values: 1. Status change, date/time (e.g. in case of status 040, 041) 2. Only in case of differing ETA specifications in berth announcement and ETA list (status 935) 3. Specification of date of the last ETA list (according to sender) (e.g. status 925, 929, 930) Version 1.3.0/E Page: 9 of 11

10 Draught Occurence Type prise:decimal4.2 FractionDigits 2 TotalDigits 4 Description Depending on the status code, the draught of the ETA list or the draught reported by the terminal is specified. ExpectedWaterLevel Occurence Type prise:expectedwaterlevel Length Description Expected water level according to the forecast. GeneralInformation Occurence Type prise:generalinformation Length Description General information ParticipantIdentification Occurence Type prise:participantidentification Length Description The participant will be set in the following cases: - If the competence/responsibility or another status is reported for transmission in PRISE. - The field "ParticipantIdentification" would be specified with value "OHA", if DV-Elbe reports a draught. AgentCode Occurence Type prise:agentcodetype Length Description Code of carrier: the carrier list of the HPA is used Location Occurence Type prise:location Description Several information concerning vessel positions (marker/ river kilometer, berth code etc.). Name Type prise:keyname Length Description Name of key value Value Type prise:keyvalue Length Description Related value (free text) TransportDetails Occurence Type prise:vessel VoyageNumber Occurence Type prise:voyagenumber IMO Occurence Type prise:imo Length Pattern [0-9]{7} VesselName Occurence Type prise:vesselname Length Date Occurence Type prise:datum Description The specifications of date/time depend on the status type. Examples for possible values: Arrival date/time, estimated (ETA) Arrival date/time, actual (ETA) Departure date/time, actual (ETD) Completion date or time, estimated (ETC) CallSign Occurence Type prise:callsign Length Version 1.3.0/E Page: 10 of 11

11 OutboundVessel Occurence Type prise:vesselagf Description Specification of the overall width > 90 m in case of the calculated encounter of two vessels VoyageNumber Occurence Type prise:voyagenumber IMO Occurence Type prise:imo Length Pattern [0-9]{7} VesselName Occurence Type prise:vesselname Length ETD Occurence Type prise:datum Description Date/time of departure, estimated CallSign Occurence Type prise:callsign Length BerthReferenceNumber Occurence Type prise:berthreferencenumber Length Pattern [0-9]{27} Description Unique reference to assign a berth announcement. LocalReferenceNumber Occurence Type prise:localreferencenumber Length Description The LRN can be used to trace a berth announcement. Version 1.3.0/E Page: 11 of 11