DV-Elbe Berth Info Business Integration for the Port of Hamburg. Mattentwiete Hamburg

Transcription

1 Message Implementation Guide PRISE DV-Elbe Berth Info Business Integration for the Port of Hamburg Message Implementation Guide Version 1.3.0/E (Valid from ) Mattentwiete Hamburg Phone: Fax: info@dakosy.de Alle Rechte, auch die der Übersetzung, des Nachdruckes oder der Vervielfältigung des Dokumentes oder Teilen daraus, vorbehalten. Kein Teil des Dokumentes darf ohne Genehmigung der AG reproduziert, unter Verwendung elektronischer Systeme verarbeitet, vervielfältigt und verbreitet werden.

2 Change History Message Implementation Guide Version Concerned section Reason Name Datum 1.0 All First English version Anton Kunze Addition of the new field Visit_ID A. Kunze Display of element types in manuals extended J. Diettrich New element BerthDetails to transmit meter marks or bollard information Element BerthDetails - New code PF (= pale, specification of unit according to which the berth is divided) in element "BerthDetails"/attribute "BerthUnitCode". - New element "BerthOrder" = side of vessel by which the vessel shall be moored. - New element "BerthOrderInformation" = specification about the side of vessel by which the vessel shall be moored Change requests Mattentwiete Hamburg 1. Phone: Fax: info@dakosy.de A. Kunze J. Diettrich d tools Number d 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 AG for the content of this manual, despite careful developing and examination of this document! Version Page: 2 of 9

3 Table of contents 1. Message Structure Guideline... 6 Version Page: 3 of 9

4 1. Message Structure Occurrence DvElbe_BerthInfo Version InterchangeHeader Version CreationTime ExchangeNumber TestIndicator MessageCount Sender ParticipantCode AgencyID Recipient ParticipantCode AgencyID DvElbe_BerthInfoMessage MessageType MessageHeader Version MessageReferenceNumber MessageSender ParticipantCode AgencyID MessageRecipient ParticipantCode AgencyID AdditionalValue Name Value Body Version ID HPA_Number Visit_ID ID_Berth BerthReferenceNumber VesselName IMO Version Page: 4 of 9

5 Occurrence CallSign ETA ETD MovementType BerthCode BerthNotes BerthDetails BerthUnitCode xs:sequence BerthFrom BerthTo BerthOrder BerthOrderInformation MaklerCode Version Page: 5 of 9

6 2. Guideline Annotation DvElbe_BerthInfo Type prise:dvelbe_berthinfotype Version Type xs:string Description Full version of message type of InterchangeHeader, MessageHeader and message body. InterchangeHeader Occurence Type prise:interchangeheader Description Each interchange starts with an element which contains different meta data and is followed by one or more messages. Version Type xs:string Description Version of interchange header CreationTime Occurence Type prise:documentcreationtime Description Creation date/time of message document. Format : T13:20:00+02:00 ExchangeNumber Occurence Type prise:documentexchangenumber Length Description Unique reference of an interchange. Example 000ICEN TestIndicator Occurence Type xs:boolean Default false Description 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. participant), contains information about the participant who compiled and sent the interchange. ParticipantCode Occurence Type prise:participantcode Length AgencyID Type xs:string Recipient Occurence Type prise:participant Description Participant of interchange (e.g. participant) ParticipantCode Occurence Type prise:participantcode Length AgencyID Type xs:string DvElbe_BerthInfoMessage Occurence Type prise:dvelbe_berthinfomessagetype MessageType Type prise:messagetype Description Message type (DVI = DV-Elbe-LP- Info), mandatory Version Page: 6 of 9

7 Annotation information unless the message type is described in the root element. Applicable codes DVI MessageHeader Occurence Type prise:messageheader Description The message header contains meta information referring to single messages, which are transmitted as part of an interchange. Version Type xs:string 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 Length AgencyID Type xs:string MessageRecipient Occurence Type prise:participant Description This element contains information about the recipient(s) of a message. ParticipantCode Occurence Type prise:participantcode Length AgencyID Type xs:string AdditionalValue Occurence Type prise:additionalvaluetype Description Reserved space for extensions Name Type prise:keyname Length Description Name of key value Value Type prise:keyvalue Length Description Related value (free text) Body Occurence Type prise:bodytype Version Type xs:string Description Version of message body ID Occurence Type prise:idtype Length Description ID of process in DV-Elbe (per port call, absolutely clear) Version Page: 7 of 9

8 Annotation HPA_Number Occurence Type prise:hpa_numbertype Length Pattern ([0-9]){4} 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}) ID_Berth Occurence Type prise:idtype Length Description ID of berth announcement (GUID) BerthReferenceNumber Occurence Type prise:berthreferencenumbertype Pattern [0-9]{27} Description The BRN is specified (unique ID in PRISE), if the berth comes from PRISE. VesselName Occurence Type prise:vesselnametype Length IMO Occurence Type prise:imotype Pattern ([0-9]){7} CallSign Occurence Type prise:callsigntype Length ETA Occurence Type xs:datetime ETD Occurence Type xs:datetime MovementType Occurence Type prise:movementtypetype Description Tugboat helping manoeuvring incoming vessels: + Tugboat helping manoeuvring the vessel during the change of berth: 0 Applicable codes 0 + BerthCode Occurence Type prise:berthcodetype Length Description Berth code (length of quay) BerthNotes Occurence Type prise:berthnotetype Length Description Berth notes BerthDetails Occurence Type prise:lputype BerthUnitCode Type prise:lpuntercode1type Description Specification of unit according to which the berth is divided. (MM = meter mark, PO = bollard, PF=pale) Applicable codes MM PF PO xs:sequence Occurence Version Page: 8 of 9

9 Annotation BerthFrom Occurence Type xs:int FractionDigits 0 Inclusive Description Position_from BerthTo Occurence Type xs:int FractionDigits 0 Inclusive Description Position_to BerthOrder Occurence Type prise:lpordertype Length Description Side of vessel by which the vessel shall be moored. (OS = without side, BB = portside, STB = starbordside, STG = other). When entering the code STG = other, the field BerthOrderInformation always has to be specified. Applicable codes BB OS STB STG BerthOrderInformation Occurence Type prise:berthorderinformation Length Name Info about the side of vessel by which the vessel shall be moored. MaklerCode Occurence Type prise:maklercodetype Length Description The agent code of the HPA is used. Version Page: 9 of 9