Transcription
Commercial in ConfidenceFATM Message TranslatorMessage Translator ICD and APIContract Number: TBDPrepared for:Prepared By:Flight ATM Systems Ltd.Document NumberFATM-TRANS02Filename: FATM AFTN Translator ICD and API.docRevA0.01Page1/19Paper size: A4All information contained in this document remains the sole and exclusive property of Flight ATM Systems Ltd. No part of it may be copied, or disclosed by the recipient to thirdpersons, without the prior written consent of Flight ATM Systems Ltd.; nor shall it be used for any purpose other than in connection with an agreement or proposed agreementwith Flight ATM Systems Ltd. Registered in the United Kingdom, registration number 562 5816;
FATM Message Translator – Message Translator ICD and APICommercial in Confidence21-Sep-15Referenced DocumentsNo.IdentificationRev DateEdition[1]FATM-TRANS0121 Sep 2015V2.0NameFATM MessageTranslatorAFTN ATS/OLDIMessage TranslatorSourceFATMTable 1 - Referenced DocumentsFlight ATM Systems Ltd.Doc No: FATM-TRANS02Rev: A0.01A42 of 19All information contained in this document remains the sole and exclusive property of Flight ATM Systems Ltd. No part of it may be copied, or disclosed by the recipient to thirdpersons, without the prior written consent of Flight ATM Systems Ltd.; nor shall it be used for any purpose other than in connection with an agreement or proposed agreement withFlight ATM Systems Ltd. Registered in the United Kingdom, registration number 562 5816;
FATM Message Translator – Message Translator ICD and APICommercial in Confidence21-Sep-15Table of Contents1Document Overview . 41.1Identification . 41.2Purpose . 41.3DOCUMENT OVERVIEW . 42Interface Design . 52.1Interface Identification and Diagrams. 52.2INTERFACE PROTOCOL. 72.2.1Message Input . 72.2.2Message Output. 92.2.3Heartbeat Message Input . 112.3AOMT Service MANAGEMENT . 122.3.1Preconditions . 122.3.2ZIP Archive Contents. 122.3.3AOMT Service Management . 142.3.4ADEXP Configuration Files . 152.3.5OLDI Configuration Files . 153REQUIREMENTS TRACEABILITY . 164Appendix A – Acronyms . 17List of FiguresFigure 1 -Figure 2 -Figure 3 -Figure 4 -Figure 5 -AOMT Interface Overview . 6TCP Start up Invocation . 14UDP Start up Invocation . 15TCP Log File Output Example. 15UDP Log File Example . 15List of FiguresTable 1 -Table 2 -Table 3 -Table 4 -Table 5 -Table 6 -Referenced Documents . 2Message Input Protocol . 7Message Output Protocol. 10Heartbeat Message Protocol . 11Software Delivery Content . 13Acronyms. 18Flight ATM Systems Ltd.Doc No: FATM-TRANS02Rev: A0.01A43 of 19All information contained in this document remains the sole and exclusive property of Flight ATM Systems Ltd. No part of it may be copied, or disclosed by the recipient to thirdpersons, without the prior written consent of Flight ATM Systems Ltd.; nor shall it be used for any purpose other than in connection with an agreement or proposed agreement withFlight ATM Systems Ltd. Registered in the United Kingdom, registration number 562 5816;
FATM Message Translator – Message Translator ICD and APICommercial in Confidence21-Sep-151 Document Overview1.1 IdentificationProgram:FATM Message TranslatorDocument Name:Message Translator ICD and APIDocument Number:FATM-TRANS02Revision:A0.01Revision Date:Monday, 21 September 2015Document Owner:Peter Venton – Flight ATM Systems Ltd.File Name:FATM AFTN Translator ICD and API.doc1.2 PurposeThis document provides a description of the Flight ATM Systems AFTN ATS/OLDI MessageTranslator, (AOMT) interface and API that is able to translate: ATS ICAO format messages into ADEXP format; ATS ADEXP format messages into ICAO format; OLDI ICAO format messages into ADEXP format; OLDI ADEXP format messages into ICAO format; Pre-FPL 2012 version messages into Post-FPL 2012 format (irrespective if message format isOLDI or ADEXP); Post-FPL 2012 version messages into Pre-FPL 2012 format (irrespective if message format isOLDI or ADEXP);The AOMT is provided as a network service using either UDP or TCP/IP to provide a servicecontaining the AOMT software.The AOMT receives messages with a target version and format instructions and returns thetranslated message. The format instruction, version instruction and the message text are sent as atext string using the IA5 character set.1.3 DOCUMENT OVERVIEWThis document specifies the interface design of the AOMT in order that the AOMT is able toperform the translation processing as required by a calling system. The message protocol andformats are described to sufficient detail that the interface can be implemented by a systemwishing to use the AOMT service.Flight ATM Systems Ltd.Doc No: FATM-TRANS02Rev: A0.01A44 of 19All information contained in this document remains the sole and exclusive property of Flight ATM Systems Ltd. No part of it may be copied, or disclosed by the recipient to thirdpersons, without the prior written consent of Flight ATM Systems Ltd.; nor shall it be used for any purpose other than in connection with an agreement or proposed agreement withFlight ATM Systems Ltd. Registered in the United Kingdom, registration number 562 5816;
FATM Message Translator – Message Translator ICD and APICommercial in Confidence21-Sep-152 Interface DesignThe interface design uses an application protocol based on either UDP or TCP protocols that cansend and receive messages to/from the AOMT.Three UDP ports for UDP communication will be provided for command, response and AOMTstatus. The command port is used for communication with AOMT.The response port is used for sending the translation response.The status port is used for a cyclic status message.The same message structure is used for all messages. The AOMT will output message counters inthe status message.All three ports are defined as start up parameters.The following restrictions apply to this design: The AOMT only listens for UDP messages from localhost::commandPort.The AOMT sends the result back to localhost:responsePortThe AOMT send status message to localhost:statusPort2.1 Interface Identification and DiagramsThe input data consists of the following items: A message to be translated;A target message format instruction;A target message version instruction;The message to be translated is a text string of IA5 characters representing any of the followingmessages: ATS Message in the ICAO format;OLDI Message in the ICAO format;ATS Message in the ADEXP format;OLDI Message in the ADEXP format;ETFMS Message in the ADEXP format;CADF Message in the ADEXP format;The data input and output are shown in figure 1. For a complete description of the AOMTfunctionality refer to the documents [Error! Reference source not found.].Flight ATM Systems Ltd.Doc No: FATM-TRANS02Rev: A0.01A45 of 19All information contained in this document remains the sole and exclusive property of Flight ATM Systems Ltd. No part of it may be copied, or disclosed by the recipient to thirdpersons, without the prior written consent of Flight ATM Systems Ltd.; nor shall it be used for any purpose other than in connection with an agreement or proposed agreement withFlight ATM Systems Ltd. Registered in the United Kingdom, registration number 562 5816;
FATM Message Translator – Message Translator ICD and APICommercial in igurationData· ADEXPSupportedmessagedefinitions· r:· MessagetoprocessInstructionParameters:· Targetformat· rmatMessageOutputParameters:· ConvertedMessage· Errorindicator· Errors(ifanyoccurred)Figure 1 - AOMT Interface OverviewFlight ATM Systems Ltd.Doc No: FATM-TRANS02Rev: A0.01A46 of 19All information contained in this document remains the sole and exclusive property of Flight ATM Systems Ltd. No part of it may be copied, or disclosed by the recipient to thirdpersons, without the prior written consent of Flight ATM Systems Ltd.; nor shall it be used for any purpose other than in connection with an agreement or proposed agreement withFlight ATM Systems Ltd. Registered in the United Kingdom, registration number 562 5816;
FATM Message Translator – Message Translator ICD and APICommercial in Confidence21-Sep-152.2 INTERFACE PROTOCOLThe interface protocol is defined in this section. The input and output data structures are describedin the sections that follow. Messages are received and sent asynchronously. A message is outputby the AOMT in response to a message input.2.2.1 Message InputWhen data is input to the AOMT, the message protocol must conform to the structure described inTable 2 - below.Data ItemLength(bytes)ValueStart Message Indicator1ASCII 00110The ASCII SOH characterVariableAny printableASCIIcharacterapart fromthe hyphen(ASCII04510)A channel identifier indicating the ATMGW channelthat is requesting translation of this message.1ASCII 04510The ASCII hyphen character ‘-‘ used to separate thechannel name form the target format and versioninstruction.4 or 5ICAOorADEXP1ASCII 04510The ASCII hyphen character ‘-‘ used to separate thetarget format and version instruction.8 or 9PRE 2012orPOST 2012Instruction used to specify the target output FPL 2012version of a message being processed.1ASCII 04510The ASCII hyphen character ‘-‘ used to separate thetarget version instruction and the node name.VariableAny printableASCIIcharacterapart fromthe hyphen(ASCII04510)A channel node name identifying the ATMGW nodethat a translated message will be sent to.1ASCII 00210The ASCII STX character.Channel NameSeparatorTarget formatinstructionSeparatorTarget versioninstructionSeparatorNode NameInstruction/messageseparatorMessage to TranslateEnd of messageindicatorVariableAny IA5string ofcharacters1ASCII 00310CommentInstruction used to specify the output format of amessage being input.The OLDI, ATS, ETFMS or CADF message totranslate, this must include the AFTN header if themessage is NOT an OLDI message.OLDI messages have no header and therefore theheader can be omitted.The ASCII ETX characterTable 2 - Message Input ProtocolFlight ATM Systems Ltd.Doc No: FATM-TRANS02Rev: A0.01A47 of 19All information contained in this document remains the sole and exclusive property of Flight ATM Systems Ltd. No part of it may be copied, or disclosed by the recipient to thirdpersons, without the prior written consent of Flight ATM Systems Ltd.; nor shall it be used for any purpose other than in connection with an agreement or proposed agreement withFlight ATM Systems Ltd. Registered in the United Kingdom, registration number 562 5816;
FATM Message Translator – Message Translator ICD and APICommercial in Confidence2.2.1.121-Sep-15Message Input Example SOH CHANNEL NAME-ICAO-PRE 2012-NODE NAME STX FF LTAAZFZX LTBBZFZXLTAYZGZX261133 0F350 SITNI1B SITNI UL856 NEGRA-LSZH0104-DOF/010723 RVR/200 ORGN/RPL) ETX Flight ATM Systems Ltd.Doc No: FATM-TRANS02Rev: A0.01A48 of 19All information contained in this document remains the sole and exclusive property of Flight ATM Systems Ltd. No part of it may be copied, or disclosed by the recipient to thirdpersons, without the prior written consent of Flight ATM Systems Ltd.; nor shall it be used for any purpose other than in connection with an agreement or proposed agreement withFlight ATM Systems Ltd. Registered in the United Kingdom, registration number 562 5816;
FATM Message Translator – Message Translator ICD and APICommercial in Confidence21-Sep-152.2.2 Message OutputWhen data is output from the AOMT, the message protocol conforms to the structure described inTable 3 - below. Character encoding for the message output is UTF8, with the exception that thetext related to the message body itself is comprised only of characters in the IA5 character set.Length(bytes)Value1ASCII 00110The ASCII SOH characterVariableAnyprintableASCIIcharacterapart fromthe hyphen(ASCII04510)A channel identifier indicating the ATMGWchannel that is requesting translation of thismessage.1ASCII 04510The ASCII hyphen character ‘-‘ used toseparate the channel name and targetformat and version instruction.Yes4 or 5ICAOorADEXPInstruction used to specify the output formatof a message being input. This is the sameas input to the translator.Yes1ASCII 04510The ASCII hyphen character ‘-‘ used toseparate the target format and versioninstruction.Yes8 or 9PRE 2012orPOST 2012Instruction used to specify the output FPL2012 version of a message being input. Thisis the same as input to the translator.Yes1ASCII 04510The ASCII hyphen character ‘-‘ used toseparate the target version instruction andthe node name.VariableAnyprintableASCIIcharacterapart fromthe hyphen(ASCII04510)A channel node name identifying theATMGW node that a translated message willbe sent to.1ASCII 00210The ASCII STX characterYesVariableAny IA5string ofcharactersThe translated OLDI, ATS, ETFMS or CADFmessage.YesError MessageSeparator1ASCII 01010The ASCII NL characterNoError field indicator6ERRORSThe first line output if there are one or moreerrors to include in the output.NoNewline indicator1ASCII 01010The ASCII NL characterNoData ItemStart MessageIndicatorChannel NameSeparatorTarget formatinstructionSeparatorTarget versioninstructionSeparatorNode light ATM Systems Ltd.Doc No: FATM-TRANS02CommentRev: A0.01CompulsoryYesSourceChannelnumberA49 of 19All information contained in this document remains the sole and exclusive property of Flight ATM Systems Ltd. No part of it may be copied, or disclosed by the recipient to thirdpersons, without the prior written consent of Flight ATM Systems Ltd.; nor shall it be used for any purpose other than in connection with an agreement or proposed agreement withFlight ATM Systems Ltd. Registered in the United Kingdom, registration number 562 5816;
FATM Message Translator – Message Translator ICD and APICommercial in ConfidenceData ItemLength(bytes)21-Sep-15ValueCommentCompulsoryAn index to the start of the erroneous data towhich the error pertains with respect to thestart of the field containing the error.NoStart error index1 to 4ASCII 04810ToASCII 05710Index separator1ASCII 04410The ASCII comma characterNoEnd error index1 to 4ASCII 04810ToASCII 05710An index to the end of the erroneous data towhich the error pertains with respect to thestart of the field containing the error.NoIndex separator1ASCII 04410The ASCII comma characterNo1 to 4ASCII 04810ToASCII 05710The start index to the field containing theerroneous data with respect to the start ofthe message.No1ASCII 04410The ASCII comma characterNoVariableAny IA5string ofcharactersThe ICAO field identifier or the ADEXP fieldname to which this error applies.No1ASCII 04410The ASCII comma characterNoVariableAny IA5string ofcharactersAn error message reported by either thetranslator or the message parser. Theseoptional fields (including the previous item‘Newline indicator’) can occur as many timesas there are errors reported by the AOMT.No1ASCII 00310The ASCII ETX characterYesField indexIndex separatorField identifierIndex separatorError MessageEnd of messageindicatorTable 3 - Message Output Protocol2.2.2.1Message Output Example SOH CHANNEL NAME-ICAO-PRE 2012-NODE NAME STX FF LTAAZFZX LTBBZFZXLTAYZGZX261133 0F350 SITNI1B SITNI UL856 NEGRA-LSZH0104-DOF/010723 RVR/200 ORGN/RPL) NL ERRORS NL 0,9,163,F13,FIELD 'LOWW0500A' TOO LONG ETX Flight ATM Systems Ltd.Doc No: FATM-TRANS02Rev: A0.01A410 of 19All information contained in this document remains the sole and exclusive property of Flight ATM Systems Ltd. No part of it may be copied, or disclosed by the recipient to thirdpersons, without the prior written consent of Flight ATM Systems Ltd.; nor shall it be used for any purpose other than in connection with an agreement or proposed agreement withFlight ATM Systems Ltd. Registered in the United Kingdom, registration number 562 5816;
FATM Message Translator – Message Translator ICD and APICommercial in Confidence21-Sep-152.2.3 Heartbeat Message InputThe following table describes the heartbeat messages.Data ItemLength(bytes)Start Message Indicator1ASCII 00110The ASCII SOH characterHeartbeat messageidentifer6STATUSLabel to identify this message as a I 00210The ASCII STX characterICAOorADEXPThe number of messages received by the AOMT; theinteger value can be any length depending on thenumber of received messages.ASCII 00310The ASCII ETX characterNumber of messagesreceived by the AOMTEnd of messageindicator1 to ‘n’1ValueCommentTable 4 - Heartbeat Message Protocol2.2.3.1Message Input Example SOH STATUS STX 12345 ETX Flight ATM Systems Ltd.Doc No: FATM-TRANS02Rev: A0.01A411 of 19All information contained in this document remains the sole and exclusive property of Flight ATM Systems Ltd. No part of it may be copied, or disclosed by the recipient to thirdpersons, without the prior written consent of Flight ATM Systems Ltd.; nor shall it be used for any purpose other than in connection with an agreement or proposed agreement withFlight ATM Systems Ltd. Registered in the United Kingdom, registration number 562 5816;
FATM Message Translator – Message Translator ICD and APICommercial in Confidence21-Sep-152.3 AOMT Service MANAGEMENTThe AOMT is distributed as a ZIP archive. It contains the structure required to run the software.The AOMT application can be run on either windows or linux.2.3.1 PreconditionsThe application requires a Java 8 run time environment, either on the path or or defined by theJAVA HOME environment variable.The application requires write permission to the log directory.2.3.2ZIP Archive ContentsThe AOMT service is delivered as zip file named:aomt-[version].zipThe [version] contains the software delivery version number.When unzipped, a number of directories are created containing the following files that togetherconstitute the software delivery as shown in the following table.Directoryaomt\binContent DescriptionStart up scriptsTMJava library files (*.jar) – third partylibrariesaomt\libTMJava library files (*.jar) – Flight ATMSystem Ltd. librariesFlight ATM Systems Ltd.Doc No: er.jarRev: A0.01A412 of 19All information contained in this document remains the sole and exclusive property of Flight ATM Systems Ltd. No part of it may be copied, or disclosed by the recipient to thirdpersons, without the prior written consent of Flight ATM Systems Ltd.; nor shall it be used for any purpose other than in connection with an agreement or proposed agreement withFlight ATM Systems Ltd. Registered in the United Kingdom, registration number 562 5816;
FATM Message Translator – Message Translator ICD and APICommercial in ConfidenceDirectory21-Sep-15Content DescriptionContentaomt\config\adexpADEXP configuration filesADEXP auxilliary terms.xmlADEXP primary fields.xmlADEXP subfields.xmlADEXP Supported I configuration filesAdjUnitDefault.propertiesaomt\config\aomtAOMT configuration s# Logginghandlers nsoleHandler.level INFOaomt\etc# File Loggingjava.util.logging.FileHandler.formatter .FileHandler.level INFOlogging.properties# Console Loggingjava.util.logging.ConsoleHandler.level WARNINGaomt\logAOMT log files containing system statusinformation.aomt.log (created by the AOMTwhen running).Table 5 - Software Delivery ContentFlight ATM Systems Ltd.Doc No: FATM-TRANS02Rev: A0.01A413 of 19All information contained in this document remains the sole and exclusive property of Flight ATM Systems Ltd. No part of it may be copied, or disclosed by the recipient to thirdpersons, without the prior written consent of Flight ATM Systems Ltd.; nor shall it be used for any purpose other than in connection with an agreement or proposed agreement withFlight ATM Systems Ltd. Registered in the United Kingdom, registration number 562 5816;
FATM Message Translator – Message Translator ICD and APICommercial in Confidence21-Sep-152.3.3 AOMT Service ManagementThere are a number of parameters to set that specify the IP and port number of the service. TheAOMT service runs as a server and expects connections from the system requiring the translationservice.2.3.3.1PrerequisitesThe application requires a java 1.8 runtime to be on the path or defined by the environmentvariable JAVA HOME. An Oracle JRE is recommended.2.3.3.2Starting the AOMT ServiceThe AOMT can be started in either a TCP or UDP mode by invoking the start up scripts withappropriate command line parameters to invoke the AOMT with the required network protocol.2.3.3.2.1Start in TCP ModeThe AOMT TCP start up command synopsis is as follows:aomt TCP [port number]To start the application in TCP mode invoke the start up script with the following command: \aomt\bin\aomt TCP 9990Figure 2 - TCP Start up InvocationThe AOMT waits for connections on the specified port.2.3.3.2.2Start in UDP ModeThe AOMT TCP start up command synopsis is as follows:aomt UDP [command port number][response port number][status portnumber][Reply IP Address][Heartbeat Cyclic Rate]Start the AOMT by invoking the start UP script with the following parameters: Parameter 1 – Specify UDP as the mode; Parameter 2 – Command port number – A port number on which the input message andtranslation instruction are sent, the localhost::commandPort; Parameter 3 – Response port number – A port number on which the output message andtranslation instruction are received, the localhost::responsePort; Parameter 4 – Status port number – A port number on which the heartbeat status messagesare sent, the localhost::statusPort; Parameter 5 – (optional) – The IP address to send the reply to; Parameter 6 (optional) – Specifies the cyclic period for sending the also an optional fifthargument allowing configuration of the status message transmission rate. The fifth argument isthe number of seconds between status message trasmission. If this is not provided AOMT willuse a default value of 10 seconds between status message transmission.The following is an example for the UDP start up command. \aomt\bin\aomt UDP 9990 9991 9992 20Flight ATM Systems Ltd.Doc No: FATM-TRANS02Rev: A0.01A414 of 19All information contained in this document remains the sole and exclusive property of Flight ATM Systems Ltd. No part of it may be copied, or disclosed by the recipient to thirdpersons, without the prior written consent of Flight ATM Systems Ltd.; nor shall it be used for any purpose other than in connection with an agreement or proposed agreement withFlight ATM Systems Ltd. Registered in the United Kingdom, registration number 562 5816;
FATM Message Translator – Message Translator ICD and APICommercial in Confidence21-Sep-15Figure 3 - UDP Start up InvocationOnce the AOMT has started in UDP mode is is ready to receive message input with an associatedcommand on the UDP localhost::commandPort. Translated messages are returned on the UDPlocalhost::responsePort along with any heartbeat messages.2.3.3.3Log File OutputThe AOMT software writes status messages to a log file located in the path shown below. The logfile output includes output from the translator and parser software. \aomt\log\aomt.logFigure 4 - TCP Log File Output ExampleFigure 5 - UDP Log File Example2.3.4 ADEXP Configuration FilesThe ADEXP parser XML configuration files are located in the following directory: \aomt\config\adexp\*.xml2.3.5 OLDI Configuration FilesThe OLDI parser property configuration file is located in the following directory: \aomt\config\oldi\*.propertiesFlight ATM Systems Ltd.Doc No: FATM-TRANS02Rev: A0.01A415 of 19All information contained in this document remains the sole and exclusive property of Flight ATM Systems Ltd. No part of it may be copied, or disclosed by the recipient to thirdpersons, without the prior written consent of Flight ATM Systems Ltd.; nor shall it be used for any purpose other than in connection with an agreement or proposed agreement withFlight ATM Systems Ltd. Registered in the United Kingdom, registration number 562 5816;
FATM Message Translator – Message Translator ICD and APICommercial in Confidence21-Sep-153 REQUIREMENTS TRACEABILITYNone as of producing this document;Flight ATM Systems Ltd.Doc No: FATM-TRANS02Rev: A0.01A416 of 19All information contained in this document remains the sole and exclusive property of Flight ATM Systems Ltd. No part of it may be copied, or disclosed by the recipient to thirdpersons, without the prior written consent of Flight ATM Systems Ltd.; nor shall it be used for any purpose other than in connection with an agreement or proposed agreement withFlight ATM Systems Ltd. Registered in the United Kingdom, registration number 562 5816;
FATM Message Translator – Message Translator ICD and APICommercial in Confidence21-Sep-154 Appendix A – AcronymsAcronymDescriptionACCSAir Defence Command and Control System (NATO)ADEXPATS Data Exchange PresentationAOMTATS and OLDI Message TranslatorASCIIAmerican Standard Code for Information InterchangeATMAir Traffic ManagementATMGWATM GatewayATSAir Traffic ServiceCADFCentralised Airspace Data FunctionCDRLContract Deliverables Requirements ListCODEICAO F18 subfield, specifies the aircraft codeCSCIComputer Software Configuration ItemDIDData Item DescriptionDOFICAO F18 sub-field, Date of FlightETFMSEnhanced Tactical Flow Management SystemETXEnd of Text, ASCII escape characterFPLFlight Plan Message (ICAO)IA5International Alphabet 5ICAOInternational Civil Aviation OrganisationIDDInterface Design DocumentIPInternet ProtocolITInformation TechnologyJREJava Runtime NFlight ATM Systems Ltd.Doc No: FATM-TRANS02Rev: A0.01A417 of 19All information contained in this document remains the sole and exclusive property of Flight ATM Systems Ltd. No part of it may be copied, or disclosed by the recipient to thirdpersons, without the prior written consent of Flight ATM Systems Ltd.; nor shall it be used for any purpose other than in connection with an agreement or proposed agreement withFlight ATM Systems Ltd. Registered in the United Kingdom, registration number 562 5816;
FATM Message Translator – Message Translator ICD and APICommercial in Confidence21-Sep-15AcronymDescriptionNATONorth At
FATM Message Translator - Message Translator ICD and API 21-Sep-15 Commercial in Confidence Flight ATM Systems Ltd. Doc No: FATM-TRANS02 Rev: A0.01 A4 2 of 19 All information contained in this document remains the sole and exclusive property of Flight ATM Systems Ltd.
