128
Time Based Flow Management (TBFM) Metering Information Service JAVA Messaging Service Description Document (JMSDD) Revision G (for Release 4.3.2) CDRL E05 Document Number: FAA-TBFM-2015-0043 March 9th, 2015 Status: Final Lockheed Martin Corporation 9221 Corporate Boulevard Rockville, MD 20850

SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

  • Upload
    others

  • View
    1

  • Download
    0

Embed Size (px)

Citation preview

Page 1: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

Time Based Flow Management (TBFM)

Metering Information Service JAVA Messaging Service

Description Document (JMSDD) Revision G (for Release 4.3.2) CDRL E05

Document Number: FAA-TBFM-2015-0043

March 9th, 2015 Status: Final

Lockheed Martin Corporation 9221 Corporate Boulevard

Rockville, MD 20850

Copyright © 2015 Lockheed Martin Corporation as an unpublished work. All rights reserved. Sponsored under U.S. Government Contract DTFAWA-10-C-00052.

Page 2: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

U.S. Departmentof Transportation

Federal AviationAdministration

JAVA Messaging Service Description Document

Time Based Flow Management (TBFM) Metering Information

Service

Page 3: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

JAVA Messaging Service Description DocumentTBFM Metering Information Service

Approval Signatures

Name Organization Signature DateSigned

ii

Page 4: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

JAVA Messaging Service Description DocumentTBFM Metering Information Service

Revision RecordREVISIONLETTER

DESCRIPTION DATE ENTERED BY

ABC

Release 4.1 DraftRelease 4.1 Final

Release 4.1 Revised Final

July 5, 2013August 6, 2013October 8, 2013

SUSUSU

DEF

Release 4.1.1 FinalRelease 4.2 Final

Release 4.3.2 Final

January 7, 2014 May 27, 2014March 9, 2015

RAWHTH

G Release 4.3.2 Final January 13, 2016 VC

Page 5: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

TABLE OF CONTENTS

1.0 Scope.....................................................................................11.1 Background........................................................................................................................1

2.0 Applicable Documents.............................................................32.1 Government Documents.....................................................................................................3

2.2 Non-government Standards and Other Publications..........................................................3

3.0 Definitions..............................................................................53.1 Terms and Definitions........................................................................................................5

3.2 Acronyms and Abbreviations.............................................................................................9

3.3 Glossary............................................................................................................................10

4.0 Service profile......................................................................204.1 Service Provider...............................................................................................................20

4.1.1 Point of Contact.........................................................................................................20

4.2 Service Consumers...........................................................................................................21

4.3 Service Functionality........................................................................................................21

4.4 Security.............................................................................................................................22

4.5 Qualities of Service..........................................................................................................23

4.6 Service Policies................................................................................................................24

4.7 Environmental Constraints...............................................................................................24

5.0 Service Interface...................................................................255.1 Interface(s)........................................................................................................................25

5.2 Operation(s)......................................................................................................................265.2.1 Processing Considerations.........................................................................................26

5.3 Messages..........................................................................................................................285.3.1 “air” (Aircraft Information) Application-Specific Message Properties.....................29

5.3.1.1 Summary of STD Message Property..................................................................305.3.2 “con” (Configuration Information)Application-Specific Message Properties..........315.3.3 “oth” (Other Information)Application-Specific Message Properties........................335.3.4 “adp” (Adaptation Information)Application-Specific Message Properties...............345.3.5 Synchronization Message Properties.........................................................................35

5.4 Exceptions Handling........................................................................................................37

5.5 Data..................................................................................................................................37

6.0 Service implementation.........................................................37

iv

Page 6: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

6.1 Bindings............................................................................................................................376.1.1 Weblogic Binding......................................................................................................37

6.1.1.1 Message Protocol................................................................................................386.1.1.2 Other Protocols...................................................................................................39

6.2 End Points.........................................................................................................................396.2.1 NEMS........................................................................................................................39

Appendix A: Metering Information Service XML Schema Definition (XSD)..........................................................................................40Appendix B: Metering Information Service XML Data Element Format Descriptions..................................................................................0

LIST OF FIGURES

Figure 1: Header Property Relationships.......................................................................................28

LIST OF TABLES

Table 1: JMS Security Mechanisms..............................................................................................22Table 2: JMS AP Provider binding................................................................................................25

Page 7: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

1.0 SCOPE

This JMSDD describes the Time Based Flow Management (TBFM) Metering Information Service. The TBFM Metering Information Service publishes metering information to allow the TBFM system, Federal Aviation Administration (FAA) systems (e.g. Traffic Flow Management System (TFMS)), and external entities to collaborate, share TBFM data and be informed metering events. Metering information is the data produced or generated during the process of managing aircraft flow by scheduling the time at which each aircraft should cross a predetermined Meter Reference Element (MRE) in order to meet user-defined scheduling constraints.

The description is divided into three core sections: Service Profile, Service Interfaces, and Service Implementation.

The Service Profile section answers the question “what does the service do?”. It does this in a manner that allows a service consumer to determine whether a particular service meets its needs.

The Service Interfaces section answers the question “how does the service work?”. It describes the interface and semantics of the service; that is, it details the content of requests, message formats, data types, and transport formats.

The Service Implementation section answers the question “how does one access the service?”. It specifies the communication protocol and network address.

1.1 Background

The Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and calculates aircraft Estimated Times of Arrival (ETA) and corresponding STA at various points along the aircraft flight path to an airport. When flights approach a congested airport, TBFM is used to determine how the multiple streams of incoming flights can be sequenced and scheduled to fully utilize the runway and other airport resources and avoid unnecessary delay in compliance with all operational constraints. TBFM displays delay times to the respective En Route controller to aid traffic flow decision making from the ARTCC and/or Terminal Radar Approach Control (TRACON) controlled airspace to the runway.

TBFM is operational at all domestic ARTCCs, and access to TBFM schedule timelines and traffic plan views are provided to at least one TRACON and tower associated with each ARTCC by the use of remote Graphical User Interfaces (GUI). Also, TBFM is a key traffic flow management decision support tool in use at the Air Traffic Control System Command Center (ATCSCC). In its Traffic Management Unit (TMU), the ATCSCC has operational TBFM displays from all of the ARTCCs.

1

Page 8: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

2.0 APPLICABLE DOCUMENTS

2.1 Government Documents

[1 ] FAA-STD-073, Preparation of Java Message Service Description Documents, W3C Working Draft, 16 April 2013https://tbfm.lmbps.com/browse/TBFM-2766

[2] FAA-STD-070, Preparation of Web Service Requirements Documents, 12 July 2012.

http://www.tc.faa.gov/its/worldpac/standards/faa-std-070.pdf

[3] FAA-STD-025f, Preparation of Interface Documentation, 30 November 2007. http://www.tc.faa.gov/its/worldpac/standards/faa-std-025f.pdf

[4] FAA-STD-064, Web Service Registration, 1 May 2009.http://www.tc.faa.gov/its/worldpac/standards/faa-std-064.pdf

[5] FAA-STD-066, Web Service Taxonomies, 26 February 2010.http://www.tc.faa.gov/its/worldpac/standards/faa-std-066.pdf

[6] SWIM Controlled Vocabulary, March 2013http://www.faa.gov/go/swimvocabulary

2.2 Non-government Standards and Other Publications

[7] Glossary of Security Terms, SANS Institute, August 2011.http://www.sans.org/resources/glossary.php

[8] RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, Network Working Group, January 2005.http://www.rfc-editor.org/rfc/rfc3986.txt

[9] ISO/IEC 12207: 2008 Information Technology – Software Life Cycle Processes, 2008.

2

Page 9: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

http://www.iso.org/iso/home/store/catalogue_ics/catalogue_detail_ics.htm?csnumber=43447

[10] ISO/IEC 11404, Information technology — General-Purpose Datatypes (GPD), Second http://standards.iso.org/ittf/PubliclyAvailableStandards/c039479_ISO_IEC_11404_2007(E).zip

[11] ISO/IEC CD 20944-002, Information Technology – Metadata Interoperability and Bindings (MDIB) – Part 002, Common Vocabulary, 12 April 2004.http://jtc1sc32.org/doc/N1101-1150/32N1105T-CD20944-002.pdf

[12] DCMI Glossary, Dublin Core Metadata Initiative, User Guide Committee, 23 April 2004.http://dublincore.org/documents/usageguide/glossary.shtml

[13] Wikipediahttp://en.wikipedia.org/wiki/

[14] Java 2 Platform, Enterprise Edition, v 1.3 API Specificationhttp://docs.oracle.com/javaee/1.3/api/

[15] RFC 2828, Internet Security Glossary, Network Working Group, May 2000.http://www.ietf.org/rfc/rfc2828.txt

[16] Web Services Description Requirements, W3C Working Draft, 28 October 2002.http://www.w3.org/TR/2002/WD-ws-desc-reqs-20021028/

[17] Web Services Architecture, W3C Working Group Note, 11 February 2004.http://www.w3.org/TR/ws-arch

[18] XML Schema Requirements, W3C Working Draft, 12 September 2005http://www.w3.org/2001/XMLSchema

[19] Weblogic JMS 1.1 Implementation Standard, Working Draft.http://download.oracle.com/otn-pub/jcp/7195-jms-1.1-fr-spec-oth-JSpec/jms-1_1-fr-spec.pdf?AuthParam=1375195065_2c00ad75af26861b97b1bc4aa8a44027

3

Page 10: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

3.0 DEFINITIONS

3.1 Terms and Definitions

Asynchronous An interaction in which the associated messages are chronologically and procedurally decoupled. For example, in a request-response interaction, the client agent can process the response at some indeterminate point in the future when its existence is discovered.[17]

Audit A process that records information needed to establish accountability for system events and for the actions of system entities that cause them. [15]

Authentication The process of verifying an identity claimed by or for a system entity. [15]

Authorization The granting of rights or permission to a system entity (mainly but not always a user or a group of users) to access a service. [2]

Binding

Confidentiality

An association between an interface, a concrete protocol, and a data format. A binding specifies the protocol and data format to be used in transmitting messages defined by the associated interface. [16]

Protective measures that assure that information is not made available or disclosed to unauthorized individuals, entities, or processes (i.e., to any unauthorized system entity). [15]

Data Element A unit of data for which the definition, identification, representation, and permissible values are specified by means of a set of attributes.

Datatype A set of distinct values, characterized by properties of those values, and by operations on those values.[10]

Effect A state or condition that results from interaction with a service. Multiple states may result depending on the extent to which the interaction completes successfully or generates a fault.

End Point An association between a fully-specified binding and a physical point (i.e., a network address) at which a service may be accessed.

4

Page 11: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

Fault A message that is returned as a result of an error that prevents a service from implementing a required function. A fault usually contains information about the cause of the error. [2]

Format The arrangement of bits or characters within a group, such as a data element, message, or language. [2]

Idempotent A term used to describe an operation in which a given message will have the same effect whether it is received once or multiple times; i.e., receiving duplicates of a given message will not cause any undesirable effect. [2]

Input Data entered into, or the process of entering data into, an information processing system or any of its parts for storage or processing. (Adapted from [11])

Integrity Protective measures that assure that data has not been changed, destroyed, or lost in an unauthorized or accidental manner. [15]

Java Message Service (JMS)

A Java-based application programming interface (API) that provides a common way for Java programs to create, send, receive, and read an enterprise messaging system's messages.[6]

JMS Client An application or process that produces and/or receives messages. [13]

JMS Producer A messaging system that implements JMS in addition to the other administrative and control functionality required of a full featured messaging product.[14]

Message A basic unit of communication from one software agent to another sent in a single logical transmission.[6]

Message Producer

A JMS client that creates and sends messages.

Namespace A collection of names, identified by a URI reference, that are used in XML documents as element types and attribute names. The use of XML namespaces to uniquely identify metadata terms allows those terms to be unambiguously used across applications, promoting the possibility of shared semantics. [12]

NAS Enterprise Messaging Service

A NAS-based implementation of message-oriented middleware (MOM) that is responsible for distributing messages among information consumers and providers, as well as providing administrative functionality that includes (but is not limited to) fault tolerance, load balancing, mediation and orchestration support. [6]

5

Page 12: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

Non-Repudiation Protective measures against false denial of involvement in a communication. [15]

Operation A set of messages related to a single service action. (Adapted from [16])

Organization A unique framework of authority within which a person or persons act, or are designated to act, towards some purpose. Any department, service, or other entity within an organization which needs to be identified for information exchange. [6]

Output Data transferred out of, or the process by which an information processing system or any of its parts transfers data out of, that system or part. (Adapted from [11])

Permissible Values

The set of allowable instances of a data element. [2]

Precondition A state or condition that is required to be true before an action can be successfully invoked.

Protocol A formal set of conventions governing the format and control of interaction among communicating functional units. [6]

Quality of Service (QoS)

A parameter that specifies and measures the value of a provided service.[6]

Security The protection of information and data so that unauthorized persons or systems cannot read or modify them and authorized persons or systems are not denied access to them. [9]

Security Mechanism

A process (or a device incorporating such a process) that can be used in a system to implement a security service that is provided by or within the system. [15]

Service A mechanism to enable access to one or more capabilities, where the access is provided using a prescribed interface and is exercised consistent with constraints and policies as specified by the service description.[6]

6

Page 13: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

Service Consumer An organization that seeks to satisfy a particular need through the use of capabilities offered by means of a service. [6]

Service Description

The information needed in order to use, or consider using, a service.[6]

Service Interface The means by which the underlying capabilities of a service are accessed.[6]

Service Provider An organization that offers the use of capabilities by means of a service.[6]

Topic A distribution mechanism for publishing messages that are delivered to multiple subscribers.

Uniform Resource Identifier (URI)

A compact string of characters for identifying an abstract or physical resource. [8]

Uniform Resource Locator (URL)

A type of URI that identifies a resource via a representation of its primary access mechanism (e.g., its network "location"), rather than by some other attributes it may have. [8]

User A human, his/her agent, a surrogate, or an entity that interacts with information processing systems. [11] A person, organization entity, or automated process that accesses a system, whether authorized to do so or not. [7]

Web Service A platform-independent, loosely-coupled software component designed to support interoperable machine-to-machine interaction over a network. It has an interface described in a machine-processable format. Other systems interact with the Web service in a manner prescribed by its description by means of XML-based messages conveyed using Internet transport protocols in conjunction with other Web-related standards. [6]

7

Page 14: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

3.2 Acronyms and Abbreviations

AAR Airport Acceptance RateACM Adjacent Center MeteringAPI Application Programming InterfaceARTCC Air Route Traffic Control CenterARTS Automated Radar Terminal SystemATC Air Traffic ControlATCSCC Air Traffic Control System Command Center ATCT Airport Traffic Control TowerEDC En Route Departure CapabilityERAM En Route Automation ModernizationETA Estimated Time of ArrivalFAA Federal Aviation AdministrationFAF Final Approach FixFNTB FAA National Test BedFTI FAA Telecommunications InfrastructureGUI Graphical User InterfaceICD Interface Control DocumentJMS JAVA Messaging ServiceJMS-C JMS ConsumerJMSDD JMS Design DocumentJMS-P JMS PublisherMF Meter FixMIT Miles in TrailMINIT Minutes In TrailMRE Metering Reference ElementMTBF Mean Time Between FailuresMTTR Mean Time To RestoreNAS National Airspace SystemNEMS National Enterprise Messaging ServiceNSRR NAS Registry/RepositoryPTP Point to PointQoS Quality of ServiceR&D Research & DevelopmentSAP Service Access PointSSD System Specification DocumentSLA Service Level AgreementSTA Scheduled Time of Arrival

8

Page 15: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

SWIM System Wide Information ManagementTBFM Time Based Flow ManagementTBM Time Based MeteringTFMS Traffic Flow Management SystemTMC Traffic Management CoordinatorTMI Traffic Management InitiativeTMU Traffic Management UnitTRACON Terminal Radar Approach ControlURL Uniform Resource LocatorWJHTC William J. Hughes Technical Center XSD XML Schema Definition

3.3 Glossary

Active Aircraft: Aircraft that are actively flying within the NAS environment.

Adaptation: A collection of data files that customizes the functions of TBFM to a specific air traffic control facility.

Adapted Airport: An airport for which adaptation data files exist and schedules/advisories may be generated by TBFM.

Adaptation Information: Includes Airspace and Airport configuration.

Adjacent Center: A Center other than the Center which contains the adapted arrival airport(s) for which schedules/advisories may be generated by TBFM.

Adjacent TRACON: A TRACON which shares a border with the arrival TRACON which is the subject of TBFM metering.

Airport Acceptance Rate: A dynamic input parameter specifying the number of arriving aircraft (measured at the runway threshold) which an airport or airspace can accept from the ARTCC per hour. AAR is used to calculate the desired interval between successive arrival aircraft.

Airport Runway Configuration: The list of arrival runways at an airport that are active (i.e., operational) for any specific time interval.

Airport Status Information: Includes AAR, runway status and configurations.

Aircraft information: Includes type of aircraft such as the model, engine type and performance characteristics.

9

Page 16: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

APREQ Process: Approval Required. ARTCC and TRACON TMC puts restriction on local departures, specifying that they must call for approval before releasing a flight into a congested airspace.

Arrival Group: Each Arrival Group implements arrival scheduling for one or more airports within a TRACON. An Arrival Group schedules meter fixes and associated outer arcs (OAs), and arrival airport runways (Final Approach Fix (FAF), threshold (THD), or simply Runway (RWY) when no distinction between FAF and THD is necessary) such that the specified meter fix, TRACON, and airport runway constraints are satisfied and the resulting Scheduled Times of Arrival (STAs) are closely coordinated. An Arrival Group is associated with the concept of "arrival metering". Arrival metering seeks to adjust flight arrival times to a metered airport such that flights are delivered to the subject TRACON in accordance with the specified constraints of the metering fixes, the TRACON, and metered arrival airport. Arrival metering, and the collection of TBFM automation elements that implement arrival metering.

Calibrated Air Speed (CAS): The airspeed measured on an aircraft using a forward mounted pivot tube. This measured speed is relative to the local wind, and is lower than the true air speed by the square root of the ratio of the density of the local atmosphere to the density of the atmosphere at sea level.

Constraint Satisfaction Point: A runway, or a meter fix, or a meter point

Configurable Parameters: Include arrival gates, MREs, arrival airports, runways at arrival airports, satellite airports, preferential arrival routes (PARs), center airway routes for display, TRACON maps for display, ARTCC sector boundaries, TRACON boundaries, Special Use Airspace (SUA).

Departed Flight Plan: A flight plan issued for an aircraft that has just become airborne and has been detected on any NAS system. The coordination time is the actual time of takeoff.

Display Point: An optional arc where ETA and STA may be displayed. ETA and STA at the Display Point are based on a calculated schedule referenced to the Meter Point.

Eligible Flight: Flight with a new or amended active flight plan

10

Page 17: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

En Route Group: The En Route Group presently implements the En Route Departure Capability (EDC), the Multiple Meter Point (MMP) capability, and the En Route portion of the TBFM Coupled Scheduling (CS) function. The En Route Group schedules meter points (MPs) and associated outer points (OPs). A MP or an OP may be a "point" (fix) but are most usually adapted as arcs with altitude floor and ceiling, so each adapted arc may be seen as a section of a cylinder. A particular MP is scheduled according to the constraints and rules of the application (EDC, MMP or CS) it is associated with; an EDC meter point, a general airspace MP (AMP) associated with MMP, or a coupled meter point (CMP) associated with CS. The En Route Group is associated with the concept of "En Route Metering". En Route Metering (ERM) seeks to adjust flight arrival times at meter points adapted in En Route airspace such that flights are delivered in accordance with the meter point's specified constraints.

Estimated Flight Plan: A flight plan issued for an aircraft that is currently airborne in the NAS system. The coordination time listed is the estimated time of entry into this ARTCC.

Estimated Time of Arrival: ETA is the time at which the aircraft is estimated to cross the MRE (e.g. runway threshold, MRE, FAF). The ETA is determined without any restrictions imposed by other aircraft or airspace constraints. A non-radar based ETA is derived from an aircraft’s flight plan. It is used until the aircraft is tracked by radar. A radar-based ETA is computed based on the aircraft’s current position and velocity estimates given by the surveillance processor, the expected route, speed, altitude profile of the aircraft to the threshold, and the projected wind. The ETA is the earliest time an aircraft would cross a fix or runway threshold if allowed to follow its assigned flight path without being impeded by separation constraints to other aircraft and with no weather or air traffic control restrictions are placed on the aircraft flight.

Estimated Time of Departure: The time at which the aircraft is estimated to take off.

Feeder Gate: A region in which arrival aircraft enter the TRACON. A feeder gate may contain one or more MREs. The typical TRACON has four feeder gates, one each to the North East, North West, South East and South West of the airport

Final Approach: The last portion of a standard landing pattern in which the aircraft is moving on the runway heading and is approaching the runway in an attempt to land. There is very little variability in potential landing time after an aircraft has established itself on the Final Approach segment.

11

Page 18: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

Final approach Fix: This is a fix that marks the beginning of the ILS approach for a runway.

Fix: A geographical position determined by visual reference to the surface, by reference to one or more radio navigational aids (NAVAIDs), by celestial plotting, or by another navigational device. A geographical point expressed in latitude and longitude (which Is converted to system coordinates). The fix is stored and uniquely identified in adaptation. A fix is both an aid for navigation and a reference point for control purposes. The geographical position of an aircraft for a specified time which is established by reference to navigational aids or celestial plot.

Flight Events: Include arrivals at destination airports, departures from originating airports, fix crossings, and entry to or exit from facility airspace.

Flight Information: Includes flight plan data (NAS/FAA/ICAO); aircraft location (lat/long); speed; heading; altitude; schedules (ETAs and STAs associated with each MRE); planned route data including SIDs, En Route, and STARs; updates; estimated time of departure data, flight and track messages, FCA index files, FEA definition files, FCATA flight lists, DZ messages, surface data, and NAS users’ departure intent data.

Flight Information Updates: The system receives updated flight information upon receipt of the following messages: position update messages; arrival messages; departure messages; NAS airspace element crossing messages (e.g. NAVAID, FEA, sector crossing).

Flight Plan: A detailed plan for each flight occurring under Instrument Flight Rules. The flight plan contains a route of flight, anticipated departure and arrival times, aircraft identification, aircraft call sign, aircraft type, on board equipment, anticipated speed and altitude, and other information pertinent to the flight. TBFM makes substantial use of this information in order to anticipate aircraft routing and procedures.

Frozen Schedule: In TBFM, the portion of the schedule which is beyond the Freeze Horizon and which is not subject to further change.

Gate: See Feeder Gate

12

Page 19: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

Ground Speed: The rate of travel of an aircraft relative to earth fixed coordinates. This is the velocity reported by ground based radar tracking. It is also the velocity reported by the Global Positioning System.

Host Converted Route: The final computerized version of the route of flight taken originally from the field ten route of flight in the flight plan. The process of converting this route of flight involves translating all fixes into standard ones for that area, expanding all short hand expressions to their full form, converting the end of the flight using the active Preferred Arrival Route (PAR), and calculating a predicted time of passage for every fix in the route.

In-Center Departure: A flight destined for a TBFM airport that originates in the same center as the TBFM airport.

Instrument Flight Rules: Rules governing the procedures for conducting instrument flight. Also a term used by pilots and controllers to indicate type of flight plan.

In-TRACON Departure: A flight destined for a TBFM airport that originates within the same TRACON as the TBFM airport (a very short flight).

Manually Assign: Refers to the act (or resulting condition, as in Manually Assigned) of performing a “Drag & Drop” action on an airborne flight so as to assign the flight a specific STA.

Manually Schedule: Refers to the act (or resulting condition, as in Manually Scheduled) of manually causing the TBFM system to determine the STA of a flight due to the manual entry of a “ready time” or “Drag & Drop” of a metered departure.

Meter Fix: A generic term referring to any waypoint used for one or more of the following TBFM functions: nominal interior TRACON route determination, application of non-runway scheduling constraints and Host meter list display development. Specific types of meter fixes are: Host adapted meter fixes, CTAS meter fixes and scheduling meter fixes.

Meter Fix Arc: An arc defined in adaptation with both range and angular extent, referenced to a runway or airport. When adapted, the meter fix arc is used instead of the scheduling meter fix to generate routes, apply constraints and calculate ETAs and STAs.

Meter Point: A term referring to an actively scheduled (deconflicted) MRE that is usually adapted in en route airspace. Meter points are used in a

13

Page 20: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

number of TBFM system applications including Coupled Scheduling (CS) and the En route Departure Capability (EDC).

Meter Reference Element: Any NAS or user-defined element, including arcs, points, meter fixes, freeze horizons, runway thresholds, and final approach fixes.

Metered Departure: A metered departure is any flight departing from an adapted departure airport that the TBFM system schedules to a meter point or metered arrival airport.

Metering: (1) Controlling the flow rate (aircraft per hour) into the terminal area; (2) Controlling the traffic flow rate past a particular gate, usually without concern for spacing the traffic or the particular sequence that results; or (3) The En Route Metering (ERM) or the Arrival Sequencing Program (ASP) functions.

Miles-In-Trail: A method of restricting aircraft flow in a stream based on defining a minimum separation distance between aircraft

Minutes-In-Trail: A method of restricting aircraft flow in a stream based on defining a minimum separation time between aircraft.

MRE Restrictions: Reductions in capacity due to constraints applied to MREs. Types of constraints include, but are not limited to: Miles-in-Trail, Minutes-in-Trail, arrival rates, and reductions in capacity due to weather.

Outer Fix: An adapted fix along the route of flight, prior to the CTAS meter fix that is associated with an outer meter arc.

Outer Fix Arc: An arc at a distance beyond the meter fix.

Outer Meter Arc (OMA): An arc defined in adaptation with both range and angular extent, referenced to a CTAS meter fix. When adapted, the outer meter arc is used to provide an ETA and STA referenced to the intersection of the aircraft route with the outer meter arc.

Outer Point (OP): An arc defined in adaptation with both range and angular extent, referenced to a Meter Point. When adapted, the Outer Point is used to provide an ETA and STA referenced to the intersection of the aircraft route with the Outer Point.

14

Page 21: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

Outer-Four Arc (O4A): An arc defined in adaptation with both range and angular extent, referenced to an Outer-Three Arc. When adapted, the Outer-Four Arc is used to provide an ETA and STA referenced to the intersection of the aircraft route with the Outer-Four Arc.

Outer-Four Point (O4P): An arc defined in adaptation with both range and angular extent, referenced to an Outer-Three Point. When adapted, the Outer-Four Point is used to provide an ETA and STA referenced to the intersection of the aircraft route with the Outer-Four Point.

Outer-outer Arc (OOA): An arc defined in adaptation that is specified by an arc center point, a range and an angular extent. An Outer-outer arc is associated with one or more Outer meter arcs. When adapted, the Outer-outer arc is used to provide an ETA and STA referenced to the intersection of the aircraft route with the Outer-outer arc.

Outer-Outer Point (OOP): An arc defined in adaptation with both range and angular extent, referenced to an Outer Point. When adapted, the Outer-Outer Point is used to provide an ETA and STA referenced to the intersection of the aircraft route with the Outer-Outer Point.

Outer-Three Arc (O3A): An arc defined in adaptation with both range and angular extent, referenced to an Outer-Outer Arc. When adapted, the Outer-Three Arc is used to provide an ETA and STA referenced to the intersection of the aircraft route with the Outer-Three Arc.

Outer-Three Point (O3P): An arc defined in adaptation with both range and angular extent, referenced to an Outer-Outer Point. When adapted, the Outer-Three Point is used to provide an ETA and STA referenced to the intersection of the aircraft route with the Outer-Outer Point.

Proposed Flight Plan: A flight plan issued for an aircraft that has not yet become airborne. The coordination time is the proposed time of takeoff.

Route Information: Includes NAS published Departure (SIDs), En Route and Arrival (STARS) routes. These routes include RNAV/RNP SIDs and STARs.

Runway Threshold: The beginning of the arrival runway, and the location of aircraft touchdown used by TBFM in its scheduling calculations.

Proposed Flights: Consist of flight plans only.

15

Page 22: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

Satellite Airports: Airports that lie under or within the airspace of the ARTCC. Usually used by TMA in the sense of airports from which aircraft are departing to go to a TMA-adapted airport.

Schedule: A specific sequenced list of Scheduled Times of Arrival (STAs) and the corresponding times in which each aircraft will cross the runway threshold or other point of reference.

Schedule Freeze: In TBFM, aircraft at a certain distance or time from the CTAS meter fix have their schedule "Frozen". This means that its STA is no longer recalculated, and that the aircraft's CTAS meter fix (and scheduling meter fix) and runway assignment will not be changed.

Scheduled Time of Arrival: An STA is the desired time that an aircraft should cross an MRE. It takes other flights, constraints and airspace configuration into account. An STA is the result of the TMA scheduler calculating an arrival time according to parameters such as spacing, aircraft performance, and weather.

Scheduler Information: Includes any settings that affect how a schedule is built.

Scheduling Constraint: Any parameter, condition, or rule that acts to restrict the range of STAs that may be assigned to a metered flight. Note that a metered flight's ETA is not considered a scheduling constraint.

Schedling Meter Fix: A waypoint, which is at a distance from the destination airport, at which full scheduling (constraint application and deconfliction) is performed within TBFM software. Scheduling in TBFM is performed by the Dynamic Planner (DP). DP provides schedule deconfliction at two locations, at the runway or final approach fix and the scheduling fix.

Scheduling Meter Point: A waypoint at which TBFM software in EDC mode will perform full scheduling (constraint application and deconfliction).

STA Lock Point: A time or distance from a MRE at which the flight’s STA becomes locked.

Stream Class The set of aircraft of specific type(s) that will cross a particular feeder gate meter fix (e.g., all jets crossing LANDR). Attributes considered when assigning flights to a stream class; aircraft engine class, assigned CTAS meter fix, airport configuration anticipated for the time of landing at the arrival airport, departure fix, and filed altitude.

16

Page 23: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

Stream Class Configuration A set of combinations of streams and superstreams that are commonly used together.

Super Stream Class The set of one or more stream classes that have a combined miles-in-trail sepeartion constraint.

TBFM Internal Departure: An aircraft that originates “close enough” to the adapted airport that the TBFM scheduler must account for the presence of the aircraft prior to (or soon after) the aircraft departs.

Time Based Flow Management Software and hardware ATC automation tool developed for the purpose of providing automated schedules on arrival and departure air traffic at terminal and En Route facilities. TBFM assists TMCs and controllers by providing information and arrival schedules for projected traffic. TBFM generates runway assignments, landing sequences, and schedules arriving aircraft to runway threshold and MRE. It also asissts TMCs in runway configuration control, flow management, and interfacility coordination.

Time-Based Metering: A method of restricting aircraft flow by scheduling the time at which each aircraft should cross a predetermined MRE.

Time-to-Fly: Quantity in seconds required to fly from one defined point in airspace to another.

Track Time: The time associated with a radar track report.

Tracked Flights: Flights which have departed and are being actively tracked by radar. Within TBFM, these flights include flight plans and radar tracks.

TRACON Acceptance Rate A dynamic input parameter specifying the number of arriving aircraft which the TRACON airspace can accept from the ARTCC per hour. TRACON Acceptance Rate is used to calculate the desired interval between successive arrival aircraft.

Traffic Flow Definition: Parameters for restrictions applied to MREs including flow, MIT, MINIT and type of equipment.

Traffic Management Coordinator: The title for an individual air traffic controller located in the Traffic Management Unit who is responsible for metering traffic as it flows into and out of the ARTCC or TRACON. Under TBFM, the TMC performs the system-wide management of air traffic. The TMC communicates directly with area supervisors (as opposed to communicating directly with pilots). A typical function is that of metering operations, for example, closing gates or controlling the

17

Page 24: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

volume to meet acceptable rates. Also known simply as Traffic Manager.

Traffic Management Initiatives:A coordinated plan of action for maintaining a safe and efficient flow of air traffic. Examples of TMIs include ground delay programs, airspace flow programs, MIT/MINIT restrictions, altitude capping, and closed routes.

True Air Speed: The rate of travel of an aircraft relative to the air mass in which it is flying. The True Air Speed vector is the Ground Speed vector minus the Wind vector.

3.4

18

Page 25: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

4.0 SERVICE PROFILE

This section provides the information needed to discover and use this service.

Service ProfileName TBFM Metering Information ServiceService Unique Identifier urn:us:gov:dot:faa:atm:tfm:tbfmmeteringpublicationDescription The TBFM Metering Information Service publishes metering

information to allow the TBFM system, FAA systems (e.g. TFMS), and external entities to collaborate and be informed during metering events.

Namespace urn:us:gov:dot:faa:atm:tfm:tbfmmeteringpublicationVersion 1.0Service category FAA ServiceLifecycle stage Production – Status indicates that the service is of sufficient

quality and is compliant with standards and regulations. Approved for use.

Service criticality Essential -- Loss of this service would raise the risk associatedwith providing safe and efficient operations to an unacceptable level.

4.1 Service Provider

Service ProviderName FAA TBFM ProgramDescription An en route automation program within the FAA Air Traffic

Organization that adjusts capacity/demand imbalances at select airports, departure fixes, arrival fixes and en route points across the National Airspace System (NAS).

Organization URI urn:us:gov:dot:faa:atm:tfmWeb Page URL http://www.faa.gov

4.1.1 Point of Contact

Point of ContactName Crystal ToneyOrganization Federal Aviation AdministrationTitle TBFM Program Management Senior ManagerPhone (202) 493-5577Email [email protected]

19

Page 26: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

4.2 Service Consumers

The TBFM Metering Information Service is consumed by two types of subscribers: those subscribers internal to the NAS and those subscribers that are external to the NAS.

4.3 Service Functionality

The TBFM Metering Information Service at each ARTCC publishes metering information describing the metering data in use at each ARTCC in the National Airspace System (NAS). TBFM metering information data includes knowledge of when metering is in effect at an ARTCC when Adjacent Center Metering (ACM) is occurring and at which sites, flight STAs to the runway threshold, meter fix and all arcs, flight ETAs to the runway threshold, meter fix and all arcs, airport configurations presently in effect at every ARTCC, airport acceptance rates and flow settings (e.g., runway buffer), and En Route Departure Capability (EDC) aircraft departure times.

At a high level, the TBFM Metering Information Service data includes:

Aircraft information – Flight Plan Information, ETAs, STAs, Meter Reference Element (MRE) information, and Scheduling information

Configuration information - Arrival Airport Configuration Information, Airport Acceptance Rate Group, TRACON Acceptance Rate Group, Meter Point Acceptance Rate Group, Runway Acceptance Rate Group, Super Stream Class Configuration Group, and Satellite Airport Configuration Group

Status Group information – TBFM Metering Status, TBFM Interface Status

Adaptation Information – TRACON Name, Gate Name, Arrival Airport Information, Airport Configuration, and MRE Information – this information is needed so that Names which refer to adapted items can continue to be used in Aircraft Information and in Configuration Information publications; i.e., System Wide Information Management (SWIM) Service consumers need to understand the received data without having the benefit of access to adaptation data files read in by the TBFM system.

The XML Schema Definition (XSD) for the data outline above is detailed in Appendix A.

Service FunctionalityBusiness functionality Deliver current TBFM metering state data to NAS systems for

use in internal processing.Real world effect TBFM information is synched to all consumers.

20

Page 27: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

4.4 Security

The TBFM Metering Information Service employs security control through the use of JMS header properties, as described in Section 5.2.1. The NAS Enterprise Messaging Service (NEMS) provides the following security mechanisms:

The NEMS security capability provides authentication and service level access control including integrity, privacy, and encryption.

Access controls are supported through the use of username and password credentials supplied when establishing connections to NEMS interfaces. Username and password credentials are unique to each NEMS client and established during on-ramping.

Transport level encryption of messages between NEMS and Providers and Consumers is to be supported using Secure Socket Layer (SSL) and X.509 self-signed certificates established during the on-ramping process.

Regarding encryption, NEMS has not enabled the use of SSL and X.509 certificates at this time. Those features will be released at a later date (Capability B5).

Message bodies are validated against published service interface descriptions XSDs published on the NAS Registry/Repository (NSRR).

TBFM obtains updated Sensitive Flight Data (SFD) identification files via the FAA Aeronautical Data Exchange (ADX) website on a periodic basis or as directed by System Operations Services (AJR) for time critical requirements. Following the FAA approved Security Program for Sensitive Flight Data Identification, TBFM uses the information in those files to mark, or tag, service messages as containing sensitive or non-sensitive flight data. During the SWIM on-boarding process, each client is authorized to receive either sensitive or non-sensitive flight data, and is configured accordingly when on-ramped to NEMS. NEMS uses the client configuration and each message’s “Send To” tag to ensure messages with sensitive flight data are only sent to clients authorized to receive sensitive flight data. Flight data marked as sensitive under this FAA Security Program is Sensitive Security Information (SSI) in accordance with 49 CFR 15.5(b)(1) and 49 USC 40119(a) and must be protected in accordance with FAA Order 1600.75, Protecting Senstive Unclassfied Information (SUI).

Table 1: JMS Security Mechanisms

Mechanism PurposeAuthentication To assure that system entities (individuals, entities, or processes) are who they

claim to be.Authorization To assure that system entities have been granted the right or permission to access

a service.Integrity To assure that data has not been changed, destroyed, or lost in an unauthorized or

accidental manner. Confidentiality To assure that information is not made available or disclosed to unauthorized

system entities.Non-Repudiation To assure that the sender or recipient of a message cannot legitimately claim that

they did or did not participate in the message exchange.

21

Page 28: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

Audit To record information needed to establish accountability for system events and for the actions of system entities that cause them.

4.5 Qualities of Service

The quality of service (QoS) parameters specified below are between the TBFM system and NEMS.

Note: the TBFM system is in the Essential service category so the Mean Time to Restore Service has to be within or equal to 10 minutes and the Mean Time to Repair at the TBFM system level is 30 minutes for all the processors. However, the Metering service requires multiple processors to function properly and thus the MTTR value at the service level is lower than that of the system level.

QoS Parameter ValueAvailability .999 (system level)Maximum Time To Restore 4 hrs (Metering Service)Mean Time Between Failure 4016 hrs (Metering Service)

Name Definition Calculation Method Units of MeasureAvailability The probability that a

system or constituent piece will be operationalduring any randomly selected period of time, or, alternatively, thefraction of the total available operating time that the system orconstituent piece is operational.

100 * ((Maximum Available Hours – Total Outage Time)/ Maximum Available Hours)

Percentage of available time that thesystem is operationallyavailable, accurate to 3 decimal places

Maximum Time To Restore (MTTR)

The maximum total elapsed time from initial failure to resumption ofoperation.

Measured time. Minutes.

Mean Time Between Failure (MTBF)

Average time between hardware or

The sum of the individual times

Minutes.

22

Page 29: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

Name Definition Calculation Method Units of Measuresoftware component failures that do not result in the loss of the service.

between noncritical failures divided by the number of noncritical failures.

The TBFM Metering Information Service payload is published at upon startup, at a static rate of once per 15 minute interval (for all messages - <adp>, <con>, <oth>, and <air>), and upon change as described in Section 5.3.1 and subsequent sections.

A newly connected consumer will have to wait a maximum of 15 minutes prior to the receiving a refresh of data including adaptation, where the wait time will be dependent upon how far the system is into the current refresh cycle (e.g., if connected at the start, the consumer will wait 15 minutes. If connected in the middle, the consumer will wait approximately 7 minutes, etc.).

The TBFM Metering Information Service does not support reconstitution upon initial consumer connection. However, the service supports a full reconstitution of data upon failure recovery of the producer.

4.6 Service Policies

No specific service policies are applied to this service. However, through the consumer on-ramping process, NEMS designates a consumer as either a NAS or non-NAS consumer. NEMS allows internal entities to subscribe to the Metering Information Service “NAS Only” topics . Non-NAS consumers are not allowed to subscribe to the Metering Information Service “NAS Only” topics.

These headers are defined in more detail in Section 5.2.1.

4.7 Environmental Constraints

This service covers three NEMS operating environments: 1) Research & Development (R&D) NEMS at William J. Hughes Technical Center

(WJHTC)2) FTI National Test Bed (FNTB) NEMS at WJHTC3) NAS-OPS NEMS deployed to ARTCCs.

Environmental ConstraintsService Constraints FAA Telecommunications Infrastructure (FTI) environmentDeployed NEMS Environment

R&D, FNTB and NAS-OPS

Message Producer Type NAS applicationRecord Type Live

23

Page 30: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

24

Page 31: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

5.0 SERVICE INTERFACE

This section provides detailed information about the types and content of messages that the TBFM Metering Information Service exchanges, message exchange models that the service deploys, and any conditions implied by these messages.

5.1 Interface(s)

The TBFM Metering Information Service, which follows a “publish/subscribe” messaging model, only employs a single interface to NEMS, through which all metering data can be subscribed to and received.

All external users interested in subscribing to TBFM SWIM services negotiate connections to the TBFM Metering Information Service data queue with NEMS as a design time activity. Once authenticated and connected to NEMS, the client receives a download of the requested data categories and groups along with status information, configuration information, and aircraft information. Subsequently, the client receives updates to configuration and aircraft information at adapted intervals (i.e. periodically) as well as when data items change (i.e. real-time), between the adapted intervals.

TBFM Publisher Interface to NEMS

The TBFM Metering Information Service publisher interfaces with the NEMS using the NEMS Java Message Service – Producer (JMS-P) service with the Weblogic implementation described below [19]. The values in the message header are set by TBFM when the message is written to the Service Access Point (SAP) of the JMS-P.

The NEMS JMS SAP facilitates the publication of data products for consumption by JMS-C using a Pub/Sub messaging model and the sending of messages directly to JMS-C using a Point to Point (PTP) messaging model. JMS-P and JMS-C services message transfer asynchronously using the JMS Application Program Interfaces (API). TBFM Metering Information Service messages are bound to the NEMS JMS AP protocol through the use of the JMS provider specific client API as specified in the table below.

Table 2: JMS AP Provider binding

JMS Provider

Client JAR Notes

Weblogic JMS

wljmsclient.jar See http://docs.oracle.com/cd/E11035_01/wls100/client/thinclient.html for more details.

Consumer Interface to NEMS

25

Page 32: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

The TBFM Metering Information Service consumer interfaces with the NEMS using the NEMS Java Message Service-Consumer (JMS-C) service with the Weblogic implementation as described above [19].

5.2 Operation(s)

The operation description below details the sequence and cardinality of messages sent to NEMS for connected and authorized clients.

Messages are sent to NEMS in three ways relevant to sequencing. The first way is that whenever a piece of TBFM data is updated, a message including the update is sent immediately. Second, periodically a refresh of all TBFM data is sent. These operations are asynchronous; they depend on the periods of refresh as well as the schedule of updates to TBFM system data. The operation which sends updates immediately is non-idempotent; each message results in a new or changed value for its corresponding data group. The operations which send data periodically are semi-idempotent. The data sent in those messages is not necessarily different than data sent before it. Preconditions for the sending of data are an available connection to the NEMS interface as well as successful authorization to the NEMS interface. No input is required; as soon as a connection is established TBFM data is published. The output is all TBFM data. The result of the operations is that NEMS will have been updated with the most current TBFM data. No fault messages are sent.

5.2.1 Processing Considerations

Two processing considerations apply to the payload of the TBFM Metering Information Service: 1. The internal filtering of non TBFM generated data prior to publication to NEMS and 2. The routing of published data by NEMS to interested consumers based on producer applied payload properties. As the first is an internal TBFM process and therefore not applicable in this context of the JMSDD, only the routing of data by NEMS is described below. Messages published by TBFM to NEMS will be compressed using gzip compression to limit FTI bandwidth impact on the operational network.

To ensure proper routing by NEMS of TBFM metering data to authorized NAS consumers, the TBFM Metering Information Service includes JMS header properties on the payload, where the properties indicate the following:

SEC_LEVEL – contains the security level which is “NAS Only” or “All” DATA_CAT – contains the tag name of the parent data category (adp, con, oth, air, and

sync) DATA_GROUP – contains the tag name of the child or data group (e.g., flt) STDCHG – included in <air>/<flt> message when in a real-time update:

a. Scheduled time of departure (STD) has been approved (scheduled);b. Scheduled time of departure has been modified;c. Scheduled time of departure has been canceled (i.e., no longer scheduled).

26

Page 33: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

STDCHG is also included during synchronization publications (initial, periodic, and recovery), as well as the addition of a flight, if scheduled time of departure is present (i.e., scheduled).

ARTCC – contains the ID of the ARTCC to which the data payload applies (e.g., ZOA,

ZDC, etc.). SYNC – contains an indication of whether the message is a system synchronization

marker, a periodic synchronization message, or a real time update message (e.g., SYS, PER).

Only “NAS Only” consumers are authorized to subscribe to the TBFM Metering Information Service data containing a SEC_LEVEL equal to “NAS Only”.

The relationships between the various DATA_CAT and DATA_GROUP properties are illustrated below.

27

Page 34: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

Aircraft Information Category <air>

TBFM Metering Information Service

Configuration Information Category <con>

Other Information Category <oth>

Flight Plan Information

<flt>

MRE Assignments

<mrp>

ETAs<eta>

STAs<sta>

Scheduling Information

<sch>

TBFM Metering Status<tmg>

TBFM Interface Status<int>

Arrival Airport Configuration Information

<aac>

Airport Acceptance

Rate<aar>

TRACON Acceptance

Rate<tar>

Meter Point Acceptance

Rate<mar>

Runway Acceptance

Rate<rar>

Super Stream Class

Configuration<scc>

Satellite Airport Configuration

<sac>

Adaptation Information Category <adp>

TRACON Name Group

<trn>

Gate Names<gans>

Airport/Runway/

Configuration Names<apns>

MRE Names<mrns>

Stream Class Names<scns>

LEGENDDATA_CAT

DATA_GROUP

Sync Category <sync>

System Sync Start

<system_start>

Periodic Sync Start

<periodic_start>

Periodic Sync End

<periodic_end>

Figure 1: Header Property Relationships

28

Page 35: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

5.3 Messages

The TBFM Metering Information Service publishes the following message, each of which is further detailed in later sections.

5.3.1 “air” (Aircraft Information) Application-Specific Message Properties

Aircraft Information MessageMessage Name Aircraft Information <air>Message Description Provides metering information about an aircraft; specifically:

flight plan (relevant subset), STAs, ETAs, Meter Reference Elements (MREs) Assignments, and scheduling group information

Message Header Attributes

SEC_LEVEL, DATA_CAT, DATA_GROUP, ARTCC, SYNC, STDCHG

Message Property Descriptions

SEC_LEVEL – filtering level DATA_CAT – Aircraft Specific DataDATA_GROUP – Child Data Group IdentifierARTCC – Originating ARTCC IdentifierSYNC – sync message IdentifierSTDCHG – On real-time updates, this identifier indicates flights with a time of departure that is now set, a STD value that is updated, or a STD that is canceled. On synchronization (initial, periodic, or restoration), and on addition of a new flight, this identifier indicates flights that have scheduled time of departure.

Permissible Property Values

SEC_LEVEL = All, NAS OnlyDATA_CAT = airDATA_GROUP = flt, mrp, eta, sta, schSTDCHG = TRUE (only in <flt> data group)ARTCC = ZAB, ZAU, ZBW, ZDC, ZDV, ZFW, ZHU, ZID, ZJX, ZKC, ZLA, ZLC, ZMA, ZME, ZMP, ZNY, ZOA, ZOB, ZSE, ZTLSYNC = PER null

Message ID (if applicable) msgId= “NNNN” where N=[0:9]Filter Criteria Message is filtered prior to reaching designated topic.Applicable Topic/Queue FAA SWIM/Harris will provide the unique connection details

for each NAS OPS NEMS at an ARTCC via the TBFM Publisher On-Ramping form for each TBFM site

Delivery Mode Non-persistentMessage Body Type Text (XML)Message Priority (if applicable)

NA

Message Size Range (bytes) includes header

Average size per message: 313 bytes (5 <air> message set)Estimated worst case number of <air> msgs during sync: 3580

29

Page 36: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

Aircraft Information Messageand payloadMessage Frequency Highest frequency rate = 1 <air> msg every 6 sec for each flight

being managed by TBFM. The highest message frequency will be for the <air> data group and that <eta> messages will be published only when a flight's eta changes by 12 sec or more. The <air> message is published optionally upon change, upon initial system synchronization and optionally upon periodic synchronization.

STD messages are irregular – not generated at a constant rate. There may be several in any given day for each flight being managed by TBFM.

Estimated worst case steady state <air> msg rate: 500 msg/sec for largest ARTCC

Message Latency 1 sec Compression Gzip per RFCs (Request for Comments) 1951,

http://www.ietf.org/rfc/rfc1951.txt (deflate format) and 1952, http://www.ietf.org/rfc/rfc1951.txt (gzip format). Gzip compression is used to limit operational FTI bandwidth impact.

5.3.1.1 Summary of STD Message Property

Revised STD messages - TBFM will publish STD when it is scheduled or updated. In these cases, TBFM will set the property STDCHG=TRUE in the <air>/<flt> msessage. In SYNC messages for flights whose STD is set, TBFM will also set the STDCHG=TRUE. <air>/<flt> messages which include the STDCHG=TRUE property will contain the <aid>, <apt>, <dap> and <std> fields.

STD Cancellations – When a STD for a flight is cancelled, the <std> value will not be 0, but instead will be empty. So rather than “<std>0</std>”, the <air>/<flt> message will include the STDCHG=TRUE property and will contain the “<std/>” field. The STDCHG=TRUE property and the “<std/>” field distinguishes this STD message as a STD cancellation message.

30

Page 37: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

5.3.2 “con” (Configuration Information)Application-Specific Message Properties

Configuration Information MessageMessage Name Configuration Information <con>Message Description Provides metering information about the configuration of the

system; specifically: airport configurations, airport acceptance rates, TRACON acceptance rates, gate acceptance rates, Meter Point acceptance rates, runway acceptances rates, super stream class configurations, and satellite airport configurations

Message Header Attributes

SEC_LEVEL, DATA_CAT, DATA_GROUP, ARTCC, SYNC

Message Property Descriptions

SEC_LEVEL – filtering level DATA_CAT – Aircraft Specific DataDATA_GROUP – Child Data Group IdentifierARTCC – Originating ARTCC IdentifierSYNC – sync message Identifier

Permissible Property Values

SEC_LEVEL = AllDATA_CAT = conDATA_GROUP = aac, aar, tar, gar, mar, rar, scc, sacARTCC = ZAB, ZAU, ZBW, ZDC, ZDV, ZFW, ZHU, ZID, ZJX, ZKC, ZLA, ZLC, ZMA, ZME, ZMP, ZNY, ZOA, ZOB, ZSE, ZTLSYNC = PER, null

Message ID (if applicable) NoneFilter Criteria Message is filtered prior to reaching designated topic.Applicable Topic/Queue FAA SWIM/Harris will provide the unique connection details

for each NAS OPS NEMS at an ARTCC via the TBFM Publisher On-Ramping form for each TBFM site

Delivery Mode Non-persistentMessage Body Type Text (XML)Message Priority (if applicable)

NA

Message Size Range (bytes) includes header and payload

Average size per message: 5336 bytesEstimated worst case number of <con> msgs during sync: 1055

Message Frequency upon startup, every 15 minutes per periodic sync, and upon change (approximately 1 update message every 5 hours per ARTCC)

Message Latency 1 sec Compression Gzip per RFCs (Request for Comments) 1951,

http://www.ietf.org/rfc/rfc1951.txt (deflate format) and 1952, http://www.ietf.org/rfc/rfc1951.txt (gzip format). Gzip compression is used to limit operational FTI bandwidth impact.

31

Page 38: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

32

Page 39: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

5.3.3 “oth” (Other Information)Application-Specific Message Properties

Other Information MessageMessage Name Other Information <oth>Message Description Provides metering information about the status of metering and

the status of system interfaces Message Header Attributes

SEC_LEVEL, DATA_CAT, DATA_GROUP, ARTCC, SYNC

Message Property Descriptions

SEC_LEVEL – filtering level DATA_CAT – Aircraft Specific DataDATA_GROUP – Child Data Group IdentifierARTCC – Originating ARTCC IdentifierSYNC - sync message Identifier

Permissible Property Values

SEC_LEVEL = AllDATA_CAT = othDATA_GROUP = tmg, intARTCC = ZAB, ZAU, ZBW, ZDC, ZDV, ZFW, ZHU, ZID, ZJX, ZKC, ZLA, ZLC, ZMA, ZME, ZMP, ZNY, ZOA, ZOB, ZSE, ZTLSYNC = PER, null

Message ID (if applicable) NoneFilter Criteria Message is filtered prior to reaching designated topic.Applicable Topic/Queue FAA SWIM/Harris will provide the unique connection details

for each NAS OPS NEMS at an ARTCC via the TBFM Publisher On-Ramping form for each TBFM site

Delivery Mode Non-persistentMessage Body Type Text (XML)Message Priority (if applicable)

NA

Message Size Range (bytes) includes header and payload

Average size per message: 1317 bytesEstimated worst case number of <oth> msgs during sync: 27:

Message Frequency upon startup, every 15 minutes per periodic sync, and upon interface change (infrequent)

Message Latency 1 sec Compression Gzip per RFCs (Request for Comments) 1951,

http://www.ietf.org/rfc/rfc1951.txt (deflate format) and 1952, http://www.ietf.org/rfc/rfc1951.txt (gzip format). Gzip compression is used to limit operational FTI bandwidth impact.

33

Page 40: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

5.3.4 “adp” (Adaptation Information)Application-Specific Message Properties

Adaptation Information MessageMessage Name Adaptation Information <adp>Message Description Provides information about applicable system adaptation to

include TRACON names, gate names, configuration names, Meter Reference Point names, and stream class names

Message Header Attributes

SEC_LEVEL, DATA_CAT, DATA_GROUP, ARTCC, SYNC

Message Property Descriptions

SEC_LEVEL – filtering level DATA_CAT – Aircraft Specific DataDATA_GROUP – Child Data Group IdentifierARTCC – Originating ARTCC IdentifierSYNC - sync message Identifier

Permissible Property Values

SEC_LEVEL = AllDATA_CAT = adpDATA_GROUP = trn, gans, apns, mrns, scnsARTCC = ZAB, ZAU, ZBW, ZDC, ZDV, ZFW, ZHU, ZID, ZJX, ZKC, ZLA, ZLC, ZMA, ZME, ZMP, ZNY, ZOA, ZOB, ZSE, ZTLSYNC = PER, null

Message ID (if applicable) NoneFilter Criteria Message is filtered prior to reaching designated topic.Applicable Topic/Queue FAA SWIM/Harris will provide the unique connection details

for each NAS OPS NEMS at an ARTCC via the TBFM Publisher On-Ramping form for each TBFM site

Delivery Mode Non-persistentMessage Body Type Text (XML)Message Priority (if applicable)

NA

Message Size Range (bytes) includes header and payload

Average size per message = 2519 bytesEstmated worst case number of <adp> messages during sync: 25

Message Frequency Published only during syncs…. upon startup and every 15 minutes per periodic sync

Message Latency 1 sec Compression Gzip per RFCs (Request for Comments) 1951,

http://www.ietf.org/rfc/rfc1951.txt (deflate format) and 1952, http://www.ietf.org/rfc/rfc1951.txt (gzip format). Gzip

34

Page 41: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

Adaptation Information Messagecompression is used to limit operational FTI bandwidth impact.

35

Page 42: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

5.3.5 Synchronization Message Properties

This message includes no body. It is sent only to indicate an impending refresh of all TBFM data, either as a result of system startup or a periodic synchronization event. The various combinations of headers are detailed below, as they will be published, to indicate an impending refresh of either type.

Messages with DATA_GROUP = system_start precede a full synchronization which occurs as a result of a system startup. This full synchronization is then followed by real time updates, as they occur within the system. Messages with DATA_GROUP = periodic_start precede a periodic synchronization which occurs every 15 minutes. An indication that the periodic sync is complete is provided by a message with DATA_GROUP = periodic_end.

The TBFM Metering Information Service is a single threaded application which will service a synchronization message completely before update/delta messages are published. Message timestamps are provided on the data to ensure the integrity of the data in the case of failure / stale data.

SYNC= DATA_CAT= DATA_GROUP= MeaningSYS sync system_start Message that marks the start of a system

syncPER sync periodic_start Message that marks the start of a

periodic syncPER sync periodic_end Message that marks the end of a periodic

syncPER {air,con,oth,adp} Per DATA_CAT Message is a periodic update message

and consumer to start subscribing to periodic messages to time-compare them to like messages in data base

system_startMessage Properties SEC_LEVEL, DATA_CAT, DATA_GROUP, ARTCC, SYNCMessage Property Descriptions

SEC_LEVEL – filtering level DATA_CAT – Aircraft Specific DataDATA_GROUP – Child Data Group IdentifierARTCC – Originating ARTCC IdentifierSYNC – sync message Identifier

Permissible Property Values

SEC_LEVEL = AllDATA_CAT = syncDATA_GROUP = system_startARTCC = ZAB, ZAU, ZBW, ZDC, ZDV, ZFW, ZHU, ZID,

36

Page 43: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

system_startZJX, ZKC, ZLA, ZLC, ZMA, ZME, ZMP, ZNY, ZOA, ZOB, ZSE, ZTLSYNC = SYS

periodic_startMessage Properties SEC_LEVEL, DATA_CAT, DATA_GROUP, ARTCC, SYNCMessage Property Descriptions

SEC_LEVEL – filtering level DATA_CAT – Aircraft Specific DataDATA_GROUP – Child Data Group IdentifierARTCC – Originating ARTCC IdentifierSYNC – sync message Identifier

Permissible Property Values

SEC_LEVEL = AllDATA_CAT = syncDATA_GROUP = periodic_startARTCC = ZAB, ZAU, ZBW, ZDC, ZDV, ZFW, ZHU, ZID, ZJX, ZKC, ZLA, ZLC, ZMA, ZME, ZMP, ZNY, ZOA, ZOB, ZSE, ZTLSYNC = PER

periodic_endMessage Properties SEC_LEVEL, DATA_CAT, DATA_GROUP, ARTCC, SYNCMessage Property Descriptions

SEC_LEVEL – filtering level DATA_CAT – Aircraft Specific DataDATA_GROUP – Child Data Group IdentifierARTCC – Originating ARTCC IdentifierSYNC – sync message Identifier

Permissible Property Values

SEC_LEVEL = AllDATA_CAT = syncDATA_GROUP = periodic_endARTCC = ZAB, ZAU, ZBW, ZDC, ZDV, ZFW, ZHU, ZID, ZJX, ZKC, ZLA, ZLC, ZMA, ZME, ZMP, ZNY, ZOA, ZOB, ZSE, ZTLSYNC = PER

By assigning to messages the header values shown above, a consumer would subscribe to a single topic and process TBFM Metering Information Service messages as two channels – a steady state channel and a synchronization channel which the consumer could subscribe to using a thread for each channel.

From a consumer point of view, the steady state channel is continuously subscribed to. These are messages the consumer must be subscribed to continuously because they indicate either real-time data updates or are markers for periodic or system synchronization events. The synchronization channel messages are those a consumer would only subscribe to when a synchronization marker

37

Page 44: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

was received that indicated an impending system or periodic synchronization stream of messages.

5.4 Exceptions Handling

The TBFM Metering Information Service does not propagate error messages to consumers. All error handling is internal to TBFM only and, therefore, this section does not apply.

5.5 Data

Appendix A contains the Schema documenting the data described below. Appendix B includes just the data element format for quick reference

6.0 SERVICE IMPLEMENTATION

The TBFM Metering Information Service is implemented as a JMS-P service. All access points to the service are wholly contained within NEMS. Hence, the data, transport, and message protocols as well as the network address detailed below are applicable to NEMS only.

6.1 Bindings

6.1.1 Weblogic Binding

The TBFM Metering Information Service data is published in an XML format [18].

The TBFM Metering Information Service message s are bound to the NEMS JMS AP protocol through the use of a Weblogic implementation [19] of the JMS provider specific client API, as described in Section 5.1. Data Protocol.

Messages published via the NEMS JMS-P SAP consist of three parts: headers, properties and payload.

The values in the header are provided by the TBFM Metering Information Service when the message is written to the NEMS SAP. These headers and message payloads published are described in Sections 5.2.1 and 5.3.

The JMS property options are predetermined as part of the JMS-P on-ramping process. NEMS executes message routing to JMS-C by matching the Pub/Sub messaging properties of each message to the Pub/Sub messaging properties of interest to the JMS-C as defined by the TBFM Metering Information Service.

38

Page 45: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

Physical Layer

Presentation Layer

Session Layer

Transport Layer

Network Layer

Data Link Layer

Physical Layer

ApplicationProcesses

JMS Provider JMS Client

TCP

IEEE 802.3(RJ45)

IEEE 802.3(RJ45)

Application Layer

HTTP(S) (optional for ActiveMQ)

Presentation Layer

Session Layer

Transport Layer

Network Layer

Data Link Layer

Application Layer

ApplicationProcesses

IP

FTI

IP

SSL(optional)

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

6.1.1.1 Message Protocol

The TBFM Metering Information Service delivers messages to NEMS through a Weblogic JMS implementation interface to NEMS [19]. Messages are subsequently routed to JMS-Cs using Pub/Sub messaging. The TBFM Metering Information Service (JMS-C portion) receives messages from NEMS through a Weblogic JMS implementation interface to NEMS.

39

Page 46: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

Figure 1: JMS AP Transport

The TBFM Metering Information Service delivers messages to NEMS through a Weblogic JMS implementation [19]. Messages are subsequently routed to consumers using Pub/Sub messaging.

6.1.1.2 Other Protocols

None.

6.2 End Points

The TBFM Metering Information Service has a single end point – NEMS. Information pertaining to this end point is detailed below.

6.2.1 NEMS

Harris will provide network addresses (URLs) of NEMS OPS end points using the TBFM Publisher On-Ramping Form applicable for each ARTCC.

40

Page 47: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

APPENDIX A: METERING INFORMATION SERVICE XML SCHEMA DEFINITION (XSD)

MeteringInformationService.xsd

<?xml version="1.0" encoding="UTF-8"?><!-- @(#) schemas/src/main/resources/sdif/MeteringInformationService.xsd --><!-- Copyright 2011-2015, LOCKHEED MARTIN CORPORATION as an unpublished --><!-- work. All rights reserved. --><!-- This computer Software was developed with the sponsorship of the --><!-- U.S. Government under Contract No(s) --><!-- DTFAWA-10-C-00052 (TBFM) --><!-- which has a copyright license in accordance with AMS 3.5-13(c) (1). --><xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="urn:us:gov:dot:faa:atm:tfm:tbfmmeteringpublication" xmlns="urn:us:gov:dot:faa:atm:tfm:tbfmmeteringpublication">

<xs:include schemaLocation="../CAP.xsd"/>

<!-- Create an env type --><xs:element name="env" type="env"/>

</xs:schema>

41

Page 48: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

CAP.xsd<?xml version="1.0" encoding="UTF-8"?><xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:include schemaLocation="MessageBuildingBlocks.xsd"/> <!-- Aircraft Information Category (Optional) --> <xs:complexType name="AirType"> <xs:sequence> <!-- Flight Plan Information Group --> <xs:element name="flt" type="FltType" minOccurs="0"/> <!-- Tracking Information Group --> <xs:element name="trk" type="TrkType" minOccurs="0"/> <!-- The elements in the following sequence can occur multiple times in a message --> <xs:sequence minOccurs="0" maxOccurs="unbounded"> <!-- Meter Reference Point Assignments Group --> <xs:element name="mrp" type="MrpType" minOccurs="0"/> <!-- Estimated Time of Arrivals Group --> <xs:element name="eta" type="EtaType" minOccurs="0"/> <!-- Scheduled Time of Arrivals Group --> <xs:element name="sta" type="StaType" minOccurs="0"/> <!-- Scheduling Information Group --> <xs:element name="sch" type="SchType" minOccurs="0"/> </xs:sequence> </xs:sequence> <xs:attribute name="airType" type="airTypeAtt"/> <xs:attribute name="aid" type="AidType"/> <xs:attribute name="dap" type="DapType"/> <xs:attribute name="apt" type="AptType"/> <xs:attribute name="tmaId" type="tmaIdAtt"/> </xs:complexType> <!-- Configuration Information Category (Optional) --> <xs:complexType name="ConType"> <xs:sequence> <!-- Arrival Airport Configuration Group --> <xs:element name="aac" type="AacType" minOccurs="0"/> <!-- Airport Acceptance Rate Group --> <xs:element name="aar" type="AarType" minOccurs="0"/> <!-- TRACON Acceptance Rate Group --> <xs:element name="tar" type="TarType" minOccurs="0"/> <!-- Gate Acceptance Rate Group --> <xs:element name="gar" type="GarType" minOccurs="0"/> <!-- Meter Point Acceptance Rate Group --> <xs:element name="mar" type="MarType" minOccurs="0"/> <!-- Runway Acceptance Rate Group -->

42

Page 49: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

<xs:element name="rar" type="RarType" minOccurs="0"/> <!-- Super Stream Class Configuration Group --> <xs:element name="scc" type="SccType" minOccurs="0"/> <!-- Satellite Airport Configuration Group --> <xs:element name="sac" type="SacType" minOccurs="0"/> </xs:sequence> </xs:complexType> <!-- Other Information Category (Optional) --> <xs:complexType name="OthType"> <xs:sequence> <!-- TMA Metering Status Group --> <xs:element name="tmg" type="TmgType" minOccurs="0"/> <!-- TMA Interface Status Group --> <xs:element name="int" type="IntType" minOccurs="0"/> </xs:sequence> </xs:complexType> <!-- Adaptation Information Category (Optional) --> <xs:complexType name="AdpType"> <!-- the choices for the adp element are : trn by itself, cmps by itself or the sequence of elements.--> <xs:choice> <!-- TRACON Name --> <xs:element name="trn" type="TrnType" /> <xs:sequence> <!-- TRACON Name Group --> <xs:element name="tra" type="TraType" /> <!-- Gate Names Group --> <xs:element name="gans" type="GansType" minOccurs="0" /> <!-- Airport/Runway/Configuration Names Group --> <xs:element name="apns" type="ApnsType" minOccurs="0" /> <!-- Meter Reference Point Names Group --> <xs:element name="mrns" type="MrnsType" minOccurs="0" /> <!-- Stream Class Names Group --> <xs:element name="scns" type="ScnsType" minOccurs="0" /> </xs:sequence> </xs:choice> </xs:complexType> <!-- tma (Required) --> <xs:complexType name="TmaType"> <xs:sequence> <!-- Aircraft Information Category --> <xs:element name="air" type="AirType" minOccurs="0" /> <!-- Configuration Information Category --> <xs:element name="con" type="ConType" minOccurs="0" /> <!-- Other Information Category --> <xs:element name="oth" type="OthType" minOccurs="0" /> <!-- Adaptation Information Category --> <xs:element name="adp" type="AdpType" minOccurs="0" /> </xs:sequence> <xs:attribute name="msgId" type="msgIdAtt" /> <xs:attribute name="msgTime" type="TimeOrEmptyType" /> </xs:complexType> <!-- env (Required) --> <xs:complexType name="env"> <xs:sequence>

43

Page 50: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

<!-- TMA Information --> <xs:element name="tma" type="TmaType" /> </xs:sequence> <xs:attribute name="envSrce" type="envSrceAtt" /> <xs:attribute name="envTime" type="TimeOrEmptyType" /> <xs:attribute name="targetNamespace" type="xs:string" use="optional"/> </xs:complexType></xs:schema>

MessageBuildingBlocks.xsd<?xml version="1.0" encoding="UTF-8"?><!-- @(#) schemas/src/main/resources/MessageBuildingBlocks.xsd --><!-- Copyright 2011-2015, LOCKHEED MARTIN CORPORATION as an unpublished --><!-- work. All rights reserved. --><!-- This computer Software was developed with the sponsorship of the --><!-- U.S. Government under Contract No(s) --><!-- DTFAWA-10-C-00052 (TBFM) --><!-- which has a copyright license in accordance with AMS 3.5-13(c) (1). --><xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"> <!-- Simple Types --> <xs:simpleType name="AidType"> <xs:restriction base="xs:string"> <xs:pattern value="[A-Z][A-Z0-9]{1,6}"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="DapType"> <xs:restriction base="xs:string"> <xs:pattern value="[A-Z0-9][A-Z0-9_/]{2,11}"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="AptType"> <xs:restriction base="xs:string"> <xs:pattern value="[A-Z0-9]{3,9}"/> </xs:restriction> </xs:simpleType> <xs:complexType name="CcType"> <xs:sequence> <xs:element name="apt" type="AptType"/> <xs:element name="apreq" type="ApreqStatus"/> <xs:element name="sch" type="SchedulingMode"/> </xs:sequence>

44

Page 51: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

<xs:attribute name="ccType" type="airTypeAtt" use="required"/> </xs:complexType> <xs:complexType name="CcsType"> <xs:sequence> <xs:element name ="cc" type="CcType" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> <xs:simpleType name="ApreqStatus"> <xs:restriction base="xs:string"> <xs:enumeration value="ON"/> <xs:enumeration value="OFF"/> <xs:enumeration value="AUTO"/> <xs:enumeration value="SEMI"/> <xs:enumeration value="MANUAL"/> <xs:enumeration value="UNKNOWN"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="ApprovalMode"> <xs:restriction base="xs:string"> <xs:enumeration value="AUTO"/> <xs:enumeration value="SEMI"/> <xs:enumeration value="MANUAL"/> <xs:enumeration value="UNKNOWN"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="SchedulingMode"> <xs:restriction base="xs:string"> <xs:enumeration value="ACCEPT"/> <xs:enumeration value="FREEZE"/> <xs:enumeration value="UNKNOWN"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="TypType"> <xs:restriction base="xs:string"> <xs:pattern value="([A-Za-z0-9]{1,3}/)?[A-Z][A-Za-z0-9]{1,3}(/[A-Za-z0-9])?"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="BcnType"> <xs:restriction base="xs:string"> <xs:pattern value="[0-7]{4}|"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="AraRangeType"> <xs:restriction base="xs:integer"> <!-- Feet --> <xs:minInclusive value="-100000"/> <xs:maxInclusive value="100000"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="AraTextType"> <xs:restriction base="xs:string"> <!-- Visual Flight Rules, or On Top --> <xs:enumeration value="VFR"/> <xs:enumeration value="OTP"/> </xs:restriction>

45

Page 52: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

</xs:simpleType> <xs:simpleType name="AraType"> <xs:union memberTypes="AraRangeType AraTextType"/> </xs:simpleType> <xs:simpleType name="InaType"> <xs:restriction base="xs:string"> <xs:pattern value="[1-9][0-9]{2,5}|"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="F10Type"> <xs:restriction base="xs:string"> <xs:pattern value="[0-9A-Z./_]{6,940}"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="FpsType"> <xs:restriction base="xs:string"> <xs:enumeration value="FP_TYPE_INVALID"/> <xs:enumeration value="PROPOSED"/> <xs:enumeration value="ESTIMATED"/> <xs:enumeration value="DEPARTED"/> <xs:enumeration value="BLOCKED_SLOT"/> <xs:enumeration value="ACTIVE"/> <xs:enumeration value="LANDED"/> <xs:enumeration value="INVALID_FP_STATUS"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="AcsType"> <xs:restriction base="xs:string"> <xs:enumeration value="PROPOSED"/> <xs:enumeration value="ACTIVE"/> <xs:enumeration value="TRACKED"/> <xs:enumeration value="LOST"/> <xs:enumeration value="DROPPED"/> <xs:enumeration value="INACTIVE"/> <xs:enumeration value="LANDED"/> <xs:enumeration value="UNKNOWN_STATUS"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="EngType"> <xs:restriction base="xs:string"> <xs:enumeration value="PISTON"/> <xs:enumeration value="TURBO_PROP"/> <xs:enumeration value="JET"/> <xs:enumeration value="INVALID_ENGINE_TYPE"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="DepartureStatusType"> <xs:restriction base="xs:string"> <xs:enumeration value="NO_STATUS_TYPE"/> <xs:enumeration value="ACCEPT_ID"/> <xs:enumeration value="ACCEPT_AND_FREEZE_ID"/> <xs:enumeration value="UNSCHEDULE_ID"/>

46

Page 53: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

<xs:enumeration value="FIND_STA_ID"/> <xs:enumeration value="RESET_ID"/> <xs:enumeration value="REJECT_SCH_DEP_TIME"/> <xs:enumeration value="DP_SCH_REJECT"/> <xs:enumeration value="UNKNOWN"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="SpdType"> <xs:restriction base="xs:string"> <xs:pattern value="[0-9]{1,3}.[0-9]|[0-9].[0-9][0-9]|"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="CatType"> <xs:restriction base="xs:string"> <xs:enumeration value="AC_FP_CATEGORY_INVALID"/> <xs:enumeration value="DEPARTURE"/> <xs:enumeration value="ARRIVAL"/> <xs:enumeration value="OVERFLIGHT"/> <xs:enumeration value="SATELLITE_ARRIVAL"/> <xs:enumeration value="SATELLITE"/> <xs:enumeration value="DEPARTURE_ARRIVAL"/> <xs:enumeration value="SATELLITE_DEPARTURE"/> <xs:enumeration value="SATELLITE_TO_EXTERNAL"/> <xs:enumeration value="EXTERNAL_TO_SATELLITE"/> <xs:enumeration value="OPEN_SLOT"/> <xs:enumeration value="LANDED_ZN"/> <xs:enumeration value="LOST_TRK"/> <xs:enumeration value="COAST_TRK"/> <xs:enumeration value="ARTCC_TRK"/> <xs:enumeration value="DADS_TRK"/> <xs:enumeration value="ETMS_TRK"/> <xs:enumeration value="PAS_TRK"/> <xs:enumeration value="UNKNOWN_TRK"/> <xs:enumeration value="AMBIGUOUS_CATEGORY"/> <xs:enumeration value="INVALID_AC_FP_CATEGORY"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="CfxType"> <xs:restriction base="xs:string"> <xs:pattern value="[0-9A-Z/_]{2,12}"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="EstType"> <xs:restriction base="xs:string"> <xs:pattern value="FAA|EDC"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="TrwType"> <xs:restriction base="xs:string"> <xs:pattern value="[0-9]{1,2}[R|L|C]{0,1}|"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="AllowEmptyType"> <xs:restriction base="xs:string"> <xs:pattern value="|"/> </xs:restriction>

47

Page 54: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

</xs:simpleType> <xs:simpleType name="TimeOrEmptyType"> <xs:union memberTypes="xs:dateTime AllowEmptyType"/> </xs:simpleType> <xs:simpleType name="abc10Type"> <xs:restriction base="xs:string"> <xs:pattern value="[0-9A-Z./_+*]{6,940}"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="TcrType"> <xs:restriction base="xs:string"> <xs:pattern value="[0-9A-Za-z/0000 ./_+]+"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="TraType"> <xs:restriction base="xs:string"> <xs:pattern value="[A-Z][A-Z0-9]{2}|"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="FixGateArcCfgScnType"> <xs:restriction base="xs:string"> <xs:pattern value="[A-Za-z0-9_/.-]{1,48}|"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="RwyType"> <xs:restriction base="xs:string"> <xs:pattern value="[A-Z0-9_]{1,9}|"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="LatType"> <xs:restriction base="xs:string"> <xs:pattern value="[0-9]{5,6}[NS]"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="LonType"> <xs:restriction base="xs:string"> <xs:pattern value="[0-9]{6,7}[EW]"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="GspType"> <xs:restriction base="xs:string"> <xs:pattern value="[0-9]{1,3}"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="VspType"> <xs:restriction base="xs:string"> <xs:pattern value="[-\+][0-9]{1,5}\.[0-9]"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="AltType"> <xs:restriction base="xs:string"> <xs:pattern value="[1-9][0-9]{1,5}"/>

48

Page 55: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

</xs:restriction> </xs:simpleType> <xs:simpleType name="HdgType"> <xs:restriction base="xs:string"> <xs:pattern value="[1-9][0-9]{0,2}\.[0-9]"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="NoYesType"> <xs:restriction base="xs:string"> <xs:enumeration value="NO"/> <xs:enumeration value="YES"/> <xs:enumeration value="INVALID_NO_YES"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="AlsType"> <xs:restriction base="xs:string"> <xs:enumeration value="DESCENDING_ALTITUDE"/> <xs:enumeration value="LEVEL_ALTITUDE"/> <xs:enumeration value="ASCENDING_ALTITUDE"/> <xs:enumeration value="INVALID_ALTITUDE_STATUS_TYPE"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="EtaGenerationType"> <xs:restriction base="xs:string"> <xs:enumeration value="ETA_TYPE_INVALID" /> <xs:enumeration value="ETA_NODELAY" /> <xs:enumeration value="ETA_FREEZE_SUPPRESS" /> <xs:enumeration value="ETA_HOVER_AC" /> <xs:enumeration value="ETA_SCH_DEPART" /> <xs:enumeration value="ETA_SCH_DEPART_DELAY" /> <xs:enumeration value="ETA_SD_SUGGESTED" /> <xs:enumeration value="ETA_SD_SUGG_DELAY" /> <xs:enumeration value="ETA_OS_SUGGESTED" /> <xs:enumeration value="ETA_OS_SUGGEST_DELAY" /> <xs:enumeration value="ETA_TMC_SWAP" /> <xs:enumeration value="ETA_TMC_SWAP_DELAY" /> <xs:enumeration value="ETA_NAS_DELAY" /> <xs:enumeration value="ETA_HOVER_AC_DELAY" /> <xs:enumeration value="INVALID_ETA_GENERATION_TYPE" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="TusType"> <xs:restriction base="xs:string"> <xs:enumeration value="LEFT"/> <xs:enumeration value="NONE"/> <xs:enumeration value="RIGHT"/> <xs:enumeration value="UNKNOWN"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="RatType"> <xs:restriction base="xs:string"> <xs:pattern value="[0-9]{1,4}"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="SsdType"> <xs:restriction base="xs:string">

49

Page 56: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

<xs:pattern value="[0-9]{1,4}\.[0-9]"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="SsminType"> <xs:restriction base="xs:int"> <xs:minInclusive value="0"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="SstypType"> <xs:restriction base="xs:string"> <xs:enumeration value="SSC_MILES_IN_TRAIL"/> <xs:enumeration value="SSC_MINUTES_IN_TRAIL"/> <xs:enumeration value="INVALID_SSC_SEPARATION_TYPE"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="SendToCtrType"> <xs:restriction base="xs:string"> <xs:pattern value="Z[A-Z]{2}([,]Z[A-Z]{2}){0,7}"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="CtrType"> <xs:restriction base="xs:string"> <xs:pattern value="Z[A-Z]{2}"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="IftType"> <xs:restriction base="xs:string"> <xs:enumeration value="UNKNOWN"/> <xs:enumeration value="HOST"/> <xs:enumeration value="ARTS"/> <xs:enumeration value="STAR"/> <xs:enumeration value="WXIF"/> <xs:enumeration value="TFMS"/> <xs:enumeration value="ERAM"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="IfsType"> <xs:restriction base="xs:string"> <xs:pattern value="DN|UP"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="CftType"> <xs:restriction base="xs:string"> <xs:enumeration value="VIS"/> <xs:enumeration value="ILS"/> <xs:enumeration value="ILS/VIS"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="MrtType"> <xs:restriction base="xs:string"> <xs:enumeration value="MFX"/> <xs:enumeration value="MFA"/>

50

Page 57: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

<xs:enumeration value="OFX"/> <xs:enumeration value="OMA"/> <xs:enumeration value="OOA"/> <xs:enumeration value="O3A"/> <xs:enumeration value="O4A"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="AltHiLoType"> <xs:restriction base="xs:string"> <xs:pattern value="[0-9]{0,5}"/> </xs:restriction> </xs:simpleType> <!-- Attributes (names not capitalized) --> <xs:simpleType name="envSrceAtt"> <xs:restriction base="xs:string"> <xs:pattern value="TMA\.Z[A-Z]{2}\.FAA\.GOV"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="msgIdAtt"> <xs:restriction base="xs:string"> <xs:pattern value="[1-9][0-9]{0,10}"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="airTypeAtt"> <xs:restriction base="xs:string"> <xs:enumeration value="NEW"/> <xs:enumeration value="AMD"/> <xs:enumeration value="DEL"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="tmaIdAtt"> <xs:restriction base="xs:string"> <xs:pattern value="[A-Z][0-9]{5}"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="changeTypeAtt"> <xs:restriction base="xs:string"> <xs:enumeration value="NOW"/> <xs:enumeration value="CHG"/> <xs:enumeration value="DEL"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="tmgTypeAtt"> <xs:restriction base="xs:string"> <xs:enumeration value="NEW"/> <xs:enumeration value="CHG"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="mrpTypeAtt"> <xs:restriction base="xs:string"> <xs:enumeration value="NEW"/> <xs:enumeration value="AMD"/> <xs:enumeration value="NCH"/> <xs:enumeration value="DEL"/> </xs:restriction> </xs:simpleType>

51

Page 58: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

<!-- Schedule Time Window --> <xs:simpleType name="SchedTimeWindowType"> <xs:restriction base="xs:string"> <xs:pattern value="[0-9]{1,2}" /> </xs:restriction> </xs:simpleType> <!-- Alert Auto Acknowledgment --> <xs:simpleType name="AlertAutoAckType"> <xs:restriction base="xs:string"> <xs:pattern value="[0-9]{1,2}" /> </xs:restriction> </xs:simpleType> <!-- Delay Magnitude Threshold Alert --> <xs:simpleType name="DelayMagThresholdAlertType"> <xs:restriction base="xs:string"> <xs:pattern value="[0-9]{1,2}" /> </xs:restriction> </xs:simpleType> <!-- Departure Conformance Prior to SDT --> <xs:simpleType name="DepartConfPriorToSdtType"> <xs:restriction base="xs:string"> <xs:pattern value="[0-9]{1,2}" /> </xs:restriction> </xs:simpleType> <!-- Departure Conformance After SDT --> <xs:simpleType name="DepartConfAfterSdtType"> <xs:restriction base="xs:string"> <xs:pattern value="[0-9]{1,2}" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="msgOrgDestType"> <xs:restriction base="xs:string"> <xs:enumeration value="FROM_DOWN_DP" /> <xs:enumeration value="FROM_UP_DP" /> <xs:enumeration value="FOR_UP_TGUI" /> <xs:enumeration value="FOR_DOWN_TGUI" /> </xs:restriction> </xs:simpleType> <xs:simpleType name="PerformType"> <xs:restriction base="xs:string"> <xs:enumeration value="NO_PERFORM_TYPE"/> <xs:enumeration value="TBMFXCHG"/> <xs:enumeration value="TBMFXCHG_ALL"/> <xs:enumeration value="TBEFPA"/> <xs:enumeration value="TBEFPE"/> <xs:enumeration value="PERFORM_AMEND_MAX"/> <xs:enumeration value="TBTRKUPD"/> <xs:enumeration value="TBRUC"/> <xs:enumeration value="PERFORM_AMEND_COMPLETE"/> <xs:enumeration value="PERFORM_AMEND_END"/> <xs:enumeration value="PERFORM_STOP"/> <xs:enumeration value="TBEDFP"/>

52

Page 59: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

<xs:enumeration value="TBABI"/> <xs:enumeration value="PERFORM_BI_END"/> <xs:enumeration value="TBAIRCONG"/> <xs:enumeration value="PERFORM_CONG_END"/> <xs:enumeration value="TBRESCHD"/> <xs:enumeration value="PERFORM_RESCHD_END"/> <xs:enumeration value="TBMANSWP"/> <xs:enumeration value="PERFORM_MANSWP_END"/> <xs:enumeration value="TBACCEPTR"/> <xs:enumeration value="PERFORM_ACCEPTR_END"/> <xs:enumeration value="TBXMRECV"/> <xs:enumeration value="PERFORM_XMRECV_END"/> <xs:enumeration value="TBXMSEND"/> <xs:enumeration value="PERFORM_XMSEND_END"/> <xs:enumeration value="TBXMPTRK"/> <xs:enumeration value="PERFORM_XMPTRK_END"/> <xs:enumeration value="INVALID_PERFORM_TYPE"/> </xs:restriction> </xs:simpleType> <!-- air.xxx complex types --> <!-- flt --> <xs:complexType name="FltType"> <xs:sequence> <!-- Aircraft identification before amendment --> <xs:element name="old" type="AidType" minOccurs="0" maxOccurs="unbounded"/> <!-- Aircraft identification --> <xs:element name="aid" type="AidType" minOccurs="0"/> <!-- Departure airport/fix name--> <xs:element name="dap" type="DapType" minOccurs="0"/> <!-- Destination airport name--> <xs:element name="apt" type="AptType" minOccurs="0"/> <!-- Flight Plan Status --> <xs:element name="fps" type="FpsType" minOccurs="0"/> <!-- Aircraft Status --> <xs:element name="acs" type="AcsType" minOccurs="0"/> <!-- Aircraft type --> <xs:element name="typ" type="TypType" minOccurs="0"/> <!-- Engine type--> <xs:element name="eng" type="EngType" minOccurs="0"/> <!-- Beacon code --> <xs:element name="bcn" type="BcnType" minOccurs="0"/> <!-- Filed Speed --> <xs:element name="spd" type="SpdType" minOccurs="0"/> <!-- Assigned requested altitude --> <xs:element name="ara" type="AraType" minOccurs="0"/> <!-- Interim Altitude --> <xs:element name="ina" type="InaType" minOccurs="0"/> <!-- TRACON Runway Name --> <xs:element name="trw" type="TrwType" minOccurs="0"/> <!-- Departure Runway Name --> <xs:element name="drw" type="RwyType" minOccurs="0"/> <!-- Current Track Data Source --> <xs:element name="tds" type="TraType" minOccurs="0"/> <!-- Coordination Fix Name -->

53

Page 60: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

<xs:element name="cfx" type="CfxType" minOccurs="0"/> <!-- Coordination Time --> <xs:element name="ctm" type="TimeOrEmptyType" minOccurs="0"/> <!-- Estimated Departure Time --> <xs:element name="etd" type="TimeOrEmptyType" minOccurs="0"/> <!-- Scheduled Departure Time --> <xs:element name="std" type="TimeOrEmptyType" minOccurs="0"/> <!-- EDCT Time --> <xs:element name="etm" type="TimeOrEmptyType" minOccurs="0"/> <!-- EDCT Status --> <xs:element name="est" type="EstType" minOccurs="0"/> <!-- Field 10A Route --> <xs:element name="a10" type="abc10Type" minOccurs="0"/> <!-- Field 10B Route --> <xs:element name="b10" type="abc10Type" minOccurs="0"/> <!-- Field 10C Route --> <xs:element name="c10" type="abc10Type" minOccurs="0"/> <!-- TMA Converted Route --> <xs:element name="tcr" type="TcrType" minOccurs="0"/> </xs:sequence> </xs:complexType> <!-- trk --> <xs:complexType name="TrkType"> <xs:sequence> <!-- Latitude --> <xs:element name="lat" type="LatType"/> <!-- Longitude --> <xs:element name="lon" type="LonType"/> <!-- Ground Speed --> <xs:element name="gsp" type="GspType"/> <!-- Vertical Speed --> <xs:element name="vsp" type="VspType"/> <!-- Altitude --> <xs:element name="alt" type="AltType"/> <!-- Heading --> <xs:element name="hdg" type="HdgType"/> <!-- --> <xs:element name="tka" type="NoYesType"/> <!-- Track Coasting --> <xs:element name="tkc" type="NoYesType"/> <!-- Altitude Status --> <xs:element name="als" type="AlsType"/> <!-- Turn Status --> <xs:element name="tus" type="TusType"/> <!-- Reached Cruise Altitude --> <xs:element name="rca" type="NoYesType"/> <!-- Track Time --> <xs:element name="ttm" type="TimeOrEmptyType"/> </xs:sequence> </xs:complexType> <!-- mrp --> <xs:complexType name="MrpType">

54

Page 61: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

<xs:sequence> <!-- Tracon Name --> <xs:element name="tra" type="TraType"/> <!-- Meter Fix Name --> <xs:element name="mfx" type="FixGateArcCfgScnType" minOccurs="0"/> <!-- Gate Name --> <xs:element name="gat" type="FixGateArcCfgScnType" minOccurs="0"/> <!-- Display Fix Name --> <xs:element name="dfx" type="FixGateArcCfgScnType" minOccurs="0"/> <!-- Scheduling Fix Name --> <xs:element name="sfx" type="FixGateArcCfgScnType" minOccurs="0"/> <!-- Outer Meter ARc Name --> <xs:element name="oma" type="FixGateArcCfgScnType" minOccurs="0"/> <!-- Outer Outer Arc Name --> <xs:element name="ooa" type="FixGateArcCfgScnType" minOccurs="0"/> <!-- Outer Third Arc Name --> <xs:element name="o3a" type="FixGateArcCfgScnType" minOccurs="0"/> <!-- Outer Fourth Arc Name --> <xs:element name="o4a" type="FixGateArcCfgScnType" minOccurs="0"/> <!-- Arrival Runway Name --> <xs:element name="rwy" type="RwyType" minOccurs="0"/> <!-- Configuration Name --> <xs:element name="cfg" type="FixGateArcCfgScnType" minOccurs="0"/> <!-- Category --> <xs:element name="cat" type="CatType" minOccurs="0"/> <!-- Stream Class Name --> <xs:element name="scn" type="FixGateArcCfgScnType" minOccurs="0"/> </xs:sequence> <xs:attribute name="mrpType" type="mrpTypeAtt"/> </xs:complexType> <!-- sta --> <xs:complexType name="StaType"> <xs:sequence> <!-- Meter Fix Name --> <xs:element name="mfx" type="FixGateArcCfgScnType"/> <!-- sta at o4a --> <xs:element name="sta_o4a" type="TimeOrEmptyType" minOccurs="0"/> <!-- sta at o3a --> <xs:element name="sta_o3a" type="TimeOrEmptyType" minOccurs="0"/> <!-- sta at ooa --> <xs:element name="sta_ooa" type="TimeOrEmptyType" minOccurs="0"/> <!-- sta at oma --> <xs:element name="sta_oma" type="TimeOrEmptyType" minOccurs="0"/> <!-- sta at dfx --> <xs:element name="sta_dfx" type="TimeOrEmptyType" minOccurs="0"/> <!-- sta at sfx --> <xs:element name="sta_sfx" type="TimeOrEmptyType" minOccurs="0"/> <!-- sta at rwy --> <xs:element name="sta_rwy" type="TimeOrEmptyType" minOccurs="0"/> </xs:sequence> </xs:complexType> <!-- sch --> <xs:complexType name="SchType"> <xs:sequence> <!-- Meter Fix Name --> <xs:element name="mfx" type="FixGateArcCfgScnType"/>

55

Page 62: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

<!-- Scheduling Frozen --> <xs:element name="sfz" type="NoYesType" minOccurs="0"/> <!-- Scheudling Suspended --> <xs:element name="sus" type="NoYesType" minOccurs="0"/> <!-- Manually Scheduled --> <xs:element name="man" type="NoYesType" minOccurs="0"/> <!-- Runway Frozen --> <xs:element name="rfz" type="NoYesType" minOccurs="0"/> </xs:sequence> </xs:complexType> <xs:simpleType name="DlyType"> <xs:restriction base="xs:int"> <xs:pattern value="0|[1-9][0-9]{0,5}" /> </xs:restriction> </xs:simpleType> <!-- t2t_pdly --> <xs:complexType name="T2TPdlyType"> <xs:sequence> <xs:element name="dly" type="DlyType"/> <xs:element name="conv" type="NoYesType"/> <xs:element name="deta" type="TimeOrEmptyType"/> <xs:group ref="CSPIdentifierGroup"/> <xs:element name="msg_org_dst" type="msgOrgDestType" /> <xs:element name="send_to_ctr" type="SendToCtrType" /> <xs:element name="perform_type" type="PerformType" minOccurs="0"/> <xs:element name="perform_time" type="xs:double" minOccurs="0"/> </xs:sequence> </xs:complexType> <!-- t2t_ac_crossing_info --> <xs:complexType name="T2TAcCrossingInfoType"> <xs:sequence> <xs:group ref="CSPIdentifierGroup"/> <xs:element name="fix_type" type="FixCrossingType" minOccurs="0"/> <xs:element name="lat_crossing" type="LatType" minOccurs="0"/> <xs:element name="long_crossing" type="LonType" minOccurs="0"/> <xs:element name="altitude" type="AltType" minOccurs="0"/> <xs:element name="departure_fix" type="FixGateArcCfgScnType" minOccurs="0"/> <xs:element name="destination_fix" type="FixGateArcCfgScnType" minOccurs="0"/> <xs:element name="send_to_ctr" type="CtrType" minOccurs="0"/> <xs:element name="perform_type" type="PerformType" minOccurs="0"/> <xs:element name="perform_time" type="xs:double" minOccurs="0"/> </xs:sequence> </xs:complexType><!-- T2T Weighted ETA air/t2t_weta --> <xs:complexType name="T2TWetaType"> <xs:sequence> <!-- CSP Identifier --> <xs:element name="center" type="CtrType"/> <xs:element name="tracon" type="TraType"/> <xs:element name="gate" type="FixGateArcCfgScnType"/>

56

Page 63: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

<xs:element name="mfx" type="FixGateArcCfgScnType"/> <xs:element name="dp" type="FixGateArcCfgScnType"/> <!-- End CSP Identifier --> <xs:element name="weighted_eta" type="TimeOrEmptyType"/> <xs:element name="upstream_delay" type="TimeOrEmptyType"/> <xs:element name="ssc_id" type="FixGateArcCfgScnType"/> <xs:element name="mssd_id" type="FixGateArcCfgScnType"/> <xs:element name="adjusted_delay" type="DlyType"/> <xs:element name="adjusted_eta" type="TimeOrEmptyType"/> <xs:element name="adly_decayed" type="NoYesType"/> <xs:element name="msg_org_dst" type="msgOrgDestType"/> <xs:element name="send_to_ctr" type="SendToCtrType"/> <xs:element name="perform_type" type="PerformType" minOccurs="0"/> <xs:element name="perform_time" type="xs:double" minOccurs="0"/> </xs:sequence> </xs:complexType>

<xs:complexType name="T2TDciType"> <xs:sequence> <!-- CSP Identifier --> <xs:element name="mfx" type="FixGateArcCfgScnType" minOccurs="0" /> <xs:element name="center" type="CtrType" minOccurs="0" /> <xs:element name="tracon" type="TraType" minOccurs="0" /> <xs:element name="gate" type="FixGateArcCfgScnType" minOccurs="0" /> <xs:element name="dp" type="FixGateArcCfgScnType" minOccurs="0" /> <!-- End CSP Identifier --> <!-- Estimated track at CSP --> <xs:element name="eta" type="TimeOrEmptyType" /> <xs:element name="upstream_freeze_eta" type="TimeOrEmptyType" minOccurs="0" /> <xs:element name="lat_crossing" type="LatType" /> <xs:element name="long_crossing" type="LonType" /> <xs:element name="altitude" type="AltHiLoType" /> <xs:element name="ground_speed" type="GspType" /> <xs:element name="upstream_freeze_speed" type="GspType" minOccurs="0" /> <xs:element name="heading" type="HdgType" /> <xs:element name="altitude_status" type="AlsType" /> <!-- Altitude status --> <xs:element name="last_message" type="NoYesType" /> <xs:element name="use_current_speed" type="NoYesType" /> <!-- Use current speed --> <!-- end estimated track at CSP --> <xs:element name="eta_generation_type" type="EtaGenerationType" /> <xs:element name="boundary_pseudo_track" type="NoYesType" /> <xs:element name="send_to_ctr" type="SendToCtrType" /> <xs:element name="perform_type" type="PerformType" minOccurs="0"/> <xs:element name="perform_time" type="xs:double" minOccurs="0"/> </xs:sequence> </xs:complexType> <xs:complexType name="T2TDepartureStatusType"> <xs:sequence> <xs:element name="departure_status" type="DepartureStatusType"/> <xs:element name="send_to_ctr" type="SendToCtrType"/>

57

Page 64: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

</xs:sequence> </xs:complexType> <xs:complexType name="T2TSuggestedDepartureTimeType"> <xs:sequence> <xs:element name="suggested_time" type="TimeOrEmptyType"/> <xs:element name="send_to_ctr" type="SendToCtrType"/> </xs:sequence> </xs:complexType> <xs:complexType name="T2TScheduleDepartureType"> <xs:sequence> <xs:element name="departure_time" type="TimeOrEmptyType" minOccurs="0"/> <xs:element name="reset_etas" type="NoYesType"/> <xs:element name="status_type" type="DepartureStatusType"/> <xs:element name="center" type="CtrType" minOccurs="0"/> <xs:element name="tracon" type="TraType" minOccurs="0"/> <xs:element name="gate" type="FixGateArcCfgScnType" minOccurs="0"/> <xs:element name="mfx" type="FixGateArcCfgScnType" minOccurs="0"/> <xs:element name="dp" type="FixGateArcCfgScnType" minOccurs="0"/> <xs:element name="arrival_airport" type="AptType"/> <xs:element name="arrival_runway" type="RwyType"/> <xs:element name="departure_category" type="xs:string"/> <xs:element name="in_air_buffer" type="xs:int"/> <xs:element name="find_best_slot" type="NoYesType"/> <xs:element name="high_priority" type="NoYesType"/> <xs:element name="send_to_ctr" type="SendToCtrType"/> </xs:sequence> </xs:complexType> <!-- eta --> <xs:complexType name="EtaType"> <xs:sequence> <!-- Meter Fix Name --> <xs:element name="mfx" type="FixGateArcCfgScnType"/> <!-- eta at o4a --> <xs:element name="eta_o4a" type="TimeOrEmptyType" minOccurs="0"/> <!-- eta at o3a --> <xs:element name="eta_o3a" type="TimeOrEmptyType" minOccurs="0"/> <!-- eta at ooa --> <xs:element name="eta_ooa" type="TimeOrEmptyType" minOccurs="0"/> <!-- eta at oma --> <xs:element name="eta_oma" type="TimeOrEmptyType" minOccurs="0"/> <!-- eta at mfx --> <xs:element name="eta_mfx" type="TimeOrEmptyType" minOccurs="0"/> <!-- eta at dfx --> <xs:element name="eta_dfx" type="TimeOrEmptyType" minOccurs="0"/> <!-- eta at sfx --> <xs:element name="eta_sfx" type="TimeOrEmptyType" minOccurs="0"/> <!-- eta at rwy --> <xs:element name="eta_rwy" type="TimeOrEmptyType" minOccurs="0"/>

58

Page 65: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

</xs:sequence> </xs:complexType> <!-- t2t_adj_mp_assign --> <xs:complexType name="T2TAdjMPAssignType"> <xs:sequence> <xs:element name="center" type="CtrType" /> <!-- Center Name --> <xs:element name="tracon" type="TraType" /> <!-- Tracon Name --> <xs:element name="gate" type="FixGateArcCfgScnType" /> <!-- Gate Name --> <xs:element name="mfx" type="FixGateArcCfgScnType" /> <!-- Meter Fix Name --> <xs:element name="dp" type="FixGateArcCfgScnType" /> <!-- Display Point Name --> <xs:element name="mp_assigned" type="NoYesType" /> <!-- Meter Point is assigned --> <xs:element name="most_upstream_csp" type="NoYesType" /> <!-- Most upstream or downstream csp --> <xs:element name="send_to_ctr" type="SendToCtrType" /> <!-- Comma separated list of send to centers --> <xs:element name="perform_type" type="PerformType" minOccurs="0"/> <xs:element name="perform_time" type="xs:double" minOccurs="0"/> </xs:sequence> </xs:complexType>

<!-- con.xxx complex types --> <!-- aac --> <xs:complexType name="AacType"> <xs:sequence> <!-- Tracon Name --> <xs:element name="tra" type="TraType"/> <!-- Arrival Airport Name --> <xs:element name="apt" type="AptType"/> <!-- Configuration Change Time --> <xs:element name="tim" type="TimeOrEmptyType"/> <!-- Configuration Name --> <xs:element name="cfg" type="FixGateArcCfgScnType"/> </xs:sequence> <xs:attribute name="aacType" type="changeTypeAtt"/> </xs:complexType> <!-- aar --> <xs:complexType name="AarType"> <xs:sequence> <!-- Tracon Name --> <xs:element name="tra" type="TraType"/> <!-- Arrival Airport Name --> <xs:element name="apt" type="AptType"/> <!-- Airport Acceptance Rate Change Time --> <xs:element name="tim" type="TimeOrEmptyType"/> <!-- Airport Acceptance Rate --> <xs:element name="rat" type="RatType"/> </xs:sequence> <xs:attribute name="aarType" type="changeTypeAtt"/> </xs:complexType> <!-- ccd -->

59

Page 66: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

<xs:complexType name = "CcdType"> <xs:sequence> <xs:element name="tra" type="TraType"/> <xs:element name="tim" type="TimeOrEmptyType"/> <xs:element name="ssn" type="xs:short"/> <xs:element name="ccs" type="CcsType"/> </xs:sequence> <xs:attribute name="ccdType" type="changeTypeAtt" use="required"/> </xs:complexType> <!-- tar --> <xs:complexType name="TarType"> <xs:sequence> <!-- Tracon Name --> <xs:element name="tra" type="TraType"/> <!-- Tracon Acceptance Rate Change Time --> <xs:element name="tim" type="TimeOrEmptyType"/> <!-- Tracon Acceptance Rate --> <xs:element name="rat" type="RatType"/> </xs:sequence> <xs:attribute name="tarType" type="changeTypeAtt"/> </xs:complexType> <!-- gar --> <xs:complexType name="GarType"> <xs:sequence> <!-- Tracon Name --> <xs:element name="tra" type="TraType"/> <!-- Arrival Airport Name --> <xs:element name="apt" type="AptType"/> <!-- Gate Name --> <xs:element name="gat" type="FixGateArcCfgScnType"/> <!-- Gate Acceptance Rate Change Time --> <xs:element name="tim" type="TimeOrEmptyType"/> <!-- Gate Acceptance Rate --> <xs:element name="rat" type="RatType"/> </xs:sequence> <xs:attribute name="garType" type="changeTypeAtt"/> </xs:complexType> <!-- mar --> <xs:complexType name="MarType"> <xs:sequence> <!-- Tracon Name --> <xs:element name="tra" type="TraType"/> <!-- Arrival Airport Name --> <xs:element name="apt" type="AptType"/> <!-- Meter Fix Name --> <xs:element name="mfx" type="FixGateArcCfgScnType"/> <!-- Meter Point Acceptance Rate Change Time --> <xs:element name="tim" type="TimeOrEmptyType"/> <!-- Meter Point Acceptance Rate --> <xs:element name="rat" type="RatType"/> </xs:sequence> <xs:attribute name="marType" type="changeTypeAtt"/>

60

Page 67: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

</xs:complexType> <!-- rar --> <xs:complexType name="RarType"> <xs:sequence> <!-- Tracon Name --> <xs:element name="tra" type="TraType"/> <!-- Arrival Airport Name --> <xs:element name="apt" type="AptType"/> <!-- Arrival Runway Name --> <xs:element name="rwy" type="RwyType"/> <!-- Runway Acceptance Rate Change Time --> <xs:element name="tim" type="TimeOrEmptyType"/> <!-- Runway Acceptance Rate --> <xs:element name="rat" type="RatType"/> </xs:sequence> <xs:attribute name="rarType" type="changeTypeAtt"/> </xs:complexType> <!-- Build up to scc --> <!-- scls --> <xs:complexType name="SclType"> <xs:sequence> <xs:element name="scname" type="xs:string" /> <xs:element name="scmre" type="xs:string" /> </xs:sequence> <xs:attribute name="sclType" type="airTypeAtt"/> </xs:complexType> <!-- scls --> <xs:complexType name="SclsType"> <xs:sequence> <xs:element name="scl" type="SclType" minOccurs="0" maxOccurs="unbounded"/> <!-- Stream Class Name --> </xs:sequence> </xs:complexType> <!-- ssc --> <xs:complexType name="SscType"> <xs:sequence> <!-- SSC Number --> <xs:element name="ssn" type="xs:short"/> <!-- SSC Name --> <xs:element name="sscname" type="xs:string" minOccurs="0" /> <!-- SSC Separation Distance --> <xs:element name="ssd" type="SsdType" minOccurs="0"/> <!-- SSC Minutes In Trail --> <xs:element name="ssmin" type="SsminType" minOccurs="0"/> <!-- SSC Separation Type --> <xs:element name="sstyp" type="SstypType" minOccurs="0"/> <!-- --> <xs:element name="scls" type="SclsType" minOccurs="0"/> <!-- Constraint Configuration Data --> <xs:element name="ccs" type="CcsType" minOccurs="0"/> </xs:sequence> <xs:attribute name="sscType" type="airTypeAtt"/> </xs:complexType> <!-- sscs --> <xs:complexType name="SscsType">

61

Page 68: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

<xs:sequence> <xs:element name="ssc" type="SscType" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> <!-- scc --> <xs:complexType name="SccType"> <xs:sequence> <!-- Tracon Name --> <xs:element name="tra" type="TraType"/> <!-- SCC Flow Change Time --> <xs:element name="tim" type="TimeOrEmptyType"/> <!-- --> <xs:element name="sscs" type="SscsType"/> </xs:sequence> <xs:attribute name="sccType" type="changeTypeAtt"/> </xs:complexType> <!-- Build up to sac --> <!-- sap --> <xs:complexType name="SapType"> <xs:sequence> <!-- Satellite Airport Name --> <xs:element name="san" type="AptType"/> <!-- Satellite Airport Configuration Name --> <xs:element name="scf" type="FixGateArcCfgScnType"/> </xs:sequence> </xs:complexType> <!-- saps --> <xs:complexType name="SapsType"> <xs:sequence> <xs:element name="sap" type="SapType" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> <!-- sac --> <xs:complexType name="SacType"> <xs:sequence> <!-- Tracon Name --> <xs:element name="tra" type="TraType"/> <!-- Satellite Airport Configuration Change Time --> <xs:element name="tim" type="TimeOrEmptyType"/> <!-- --> <xs:element name="saps" type="SapsType"/> </xs:sequence> <xs:attribute name="sacType" type="changeTypeAtt"/> </xs:complexType> <xs:simpleType name="Timeframe"> <xs:restriction base="xs:string"> <xs:enumeration value="NOW"/> <xs:enumeration value="CHG"/> <xs:enumeration value="DEL"/> </xs:restriction>

62

Page 69: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

</xs:simpleType> <xs:complexType name="Time"> <xs:sequence> <xs:element name="offset" type="xs:string"/> <xs:element name="rate" type="xs:string"/> <xs:element name="real_sec" type="xs:string"/> <xs:element name="real_usec" type="xs:string"/> <xs:element name="mod_sec" type="xs:string"/> <xs:element name="mod_usec" type="xs:string"/> </xs:sequence> <xs:attribute name="timeType" type="Timeframe" use="required"/> </xs:complexType> <xs:simpleType name="BlockedType"> <xs:restriction base="xs:string"> <xs:enumeration value="NOW"/> <xs:enumeration value="ADD"/> <xs:enumeration value="DEL"/> </xs:restriction> </xs:simpleType> <xs:complexType name="BlockedInterval"> <xs:sequence> <xs:element minOccurs="0" name="tra" type="xs:string"/> <xs:element minOccurs="0" maxOccurs="unbounded" name="interval"> <xs:complexType > <xs:sequence> <xs:element minOccurs="0" name="type" type="xs:string"/> <xs:element minOccurs="0" name="airport" type="xs:string"/> <xs:element minOccurs="0" name="gate" type="xs:string"/> <xs:element minOccurs="0" name="meterfix" type="xs:string"/> <xs:element minOccurs="0" name="runway" type="xs:string"/> <xs:element minOccurs="0" name="start_time" type="xs:dateTime"/> <xs:element minOccurs="0" name="stop_time" type="xs:dateTime"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> <xs:attribute name ="blkType" type="BlockedType" use="required"/> </xs:complexType>

<!-- oth.xxx complex types --> <!-- tms --> <xs:complexType name="TmsType"> <xs:sequence> <!-- Metered Airport Name --> <xs:element name="apt" type="AptType"/> <xs:choice> <!-- Center Name --> <xs:element name="ctr" type="CtrType"/>

63

Page 70: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

<!-- Meter Point Name --> <xs:element name="mfx" type="FixGateArcCfgScnType"/> </xs:choice> <!-- Metering Active Status --> <xs:element name="mas" type="NoYesType"/> </xs:sequence> </xs:complexType> <xs:complexType name="TmssType"> <xs:sequence> <xs:element name="tms" type="TmsType" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> <xs:complexType name="TmgType"> <xs:sequence> <xs:element name="tra" type="TraType"/> <!-- Tracon Name --> <xs:element name="tmss" type="TmssType"/> <!-- --> </xs:sequence> <xs:attribute name="tmgType" type="tmgTypeAtt"/> </xs:complexType> <!-- int --> <xs:complexType name="IntType"> <xs:sequence> <!-- Interface Name --> <xs:element name="ifn" type="TraType" minOccurs="0"/> <!-- Interface Type --> <xs:element name="ift" type="IftType" minOccurs="0"/> <!-- Interface Status --> <xs:element name="ifs" type="IfsType" minOccurs="0"/> <!-- Interface Metering Status --> <xs:element name="ifm" type="IfsType" minOccurs="0"/> </xs:sequence> </xs:complexType> <!-- adp.xxx complex types --> <!-- trn --> <xs:complexType name="TrnType"> <xs:sequence> <!-- Tracon Name --> <xs:element name="nam" type="TraType"/> </xs:sequence> </xs:complexType> <!-- gan --> <xs:complexType name="GanType"> <xs:sequence> <!-- Gate name --> <xs:element name="nam" type="FixGateArcCfgScnType"/> </xs:sequence> </xs:complexType> <!-- gans --> <xs:complexType name="GansType"> <xs:sequence>

64

Page 71: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

<!-- --> <xs:element name="gan" type="GanType" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> <!-- Build up to apns --> <!-- rwn --> <xs:complexType name="RwnType"> <xs:sequence> <!-- Arrival Runway Name --> <xs:element name="nam" type="RwyType"/> </xs:sequence> </xs:complexType> <!-- rwns --> <xs:complexType name="RwnsType"> <xs:sequence> <xs:element name="rwn" type="RwnType" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> <!-- rwys --> <xs:complexType name="RwysType"> <xs:sequence> <!-- Arrival Runway Name --> <xs:element name="rwy" type="RwyType" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> <!-- cfn --> <xs:complexType name="CfnType"> <xs:sequence> <!-- Configuration Name --> <xs:element name="nam" type="FixGateArcCfgScnType" minOccurs="0"/> <!-- --> <xs:element name="cft" type="CftType" minOccurs="0"/> <!-- --> <xs:element name="rwys" type="RwysType" minOccurs="0"/> </xs:sequence> </xs:complexType> <!-- cfns --> <xs:complexType name="CfnsType"> <xs:sequence> <xs:element name="cfn" type="CfnType" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> <!-- apn --> <xs:complexType name="ApnType"> <xs:sequence> <!-- Arrival Airport Name --> <xs:element name="nam" type="AptType"/> <xs:sequence minOccurs="0"> <xs:element name="rwns" type="RwnsType"/> <xs:element name="cfns" type="CfnsType"/> </xs:sequence> </xs:sequence>

65

Page 72: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

</xs:complexType> <!-- apns --> <xs:complexType name="ApnsType"> <xs:sequence> <!-- Aircraft identification before amendment --> <xs:element name="apn" type="ApnType" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> <!-- chn --> <xs:complexType name="ChnType"> <xs:sequence> <xs:element name="nam" type="AptType" /> <!-- Child Airport Name --> <xs:element name="rwns" type="RwnsType" /> <xs:element name="cfns" type="CfnsType" /> </xs:sequence> </xs:complexType> <!-- chns --> <xs:complexType name="ChnsType"> <xs:sequence> <xs:element name="chn" type="ChnType" minOccurs="0" maxOccurs="unbounded" /> </xs:sequence> </xs:complexType> <!-- dpn --> <xs:complexType name="DpnType"> <xs:sequence> <xs:element name="nam" type="AptType" /> <!-- Departure Airport Name --> <xs:element name="rwns" type="RwnsType" /> <xs:element name="cfns" type="CfnsType" /> <xs:element name="chns" type="ChnsType" minOccurs="0" /> </xs:sequence> </xs:complexType> <!-- dpns --> <xs:complexType name="DpnsType"> <xs:sequence> <!-- Aircraft identification before amendment --> <xs:element name="dpn" type="DpnType" minOccurs="0" maxOccurs="unbounded" /> </xs:sequence> </xs:complexType> <!-- mrn --> <xs:complexType name="MrnType"> <xs:sequence> <!-- mrp Name --> <xs:element name="nam" type="FixGateArcCfgScnType"/> <!-- mrp Type --> <xs:element name="mrt" type="MrtType"/> <!-- Gate Name --> <xs:element name="gat" type="FixGateArcCfgScnType"/>

66

Page 73: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

<!-- Meter Fix Name --> <xs:element name="mfx" type="FixGateArcCfgScnType" minOccurs="0"/> <!-- Outer Meter Arc Name --> <xs:element name="oma" type="FixGateArcCfgScnType" minOccurs="0"/> <!-- Outer Outer Arc Name --> <xs:element name="ooa" type="FixGateArcCfgScnType" minOccurs="0"/> <!-- Outer Third Arc Name --> <xs:element name="o3a" type="FixGateArcCfgScnType" minOccurs="0"/> <!-- Outer Fourth Arc Name --> <xs:element name="o4a" type="FixGateArcCfgScnType" minOccurs="0"/> <!-- Latitude --> <xs:element name="lat" type="LatType"/> <!-- Longitude --> <xs:element name="lon" type="LonType"/> <!-- Radius --> <xs:element name="rad" type="SsdType" minOccurs="0"/> <!-- Left Arc Angle --> <xs:element name="lan" type="SsdType" minOccurs="0"/> <!-- Right Arc Angle --> <xs:element name="ran" type="SsdType" minOccurs="0"/> <!-- Altitude High --> <xs:element name="ahi" type="AltHiLoType" minOccurs="0"/> <!-- Altitude Low --> <xs:element name="alo" type="AltHiLoType" minOccurs="0"/> </xs:sequence> </xs:complexType> <!-- mrns --> <xs:complexType name="MrnsType"> <xs:sequence> <!-- --> <xs:element name="mrn" type="MrnType" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> <!-- scn --> <xs:complexType name="ScnType"> <xs:sequence> <!-- Stream Class Name --> <xs:element name="nam" type="FixGateArcCfgScnType"/> </xs:sequence> </xs:complexType> <!-- scns --> <xs:complexType name="ScnsType"> <xs:sequence> <!-- --> <xs:element name="scn" type="ScnType" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> <!-- stw --> <xs:complexType name="StwType"> <xs:sequence> <xs:element name="nam" type="SchedTimeWindowType" /> <!-- Schedule Time Window --> </xs:sequence> </xs:complexType>

67

Page 74: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

<!-- aak --> <xs:complexType name="AakType"> <xs:sequence> <xs:element name="nam" type="AlertAutoAckType" /> <!-- Alert Auto Acknowledgment --> </xs:sequence> </xs:complexType> <!-- dmta --> <xs:complexType name="DmtaType"> <xs:sequence> <!-- Delay Magnitude Threshold --> <xs:element name="nam" type="DelayMagThresholdAlertType" /> </xs:sequence> </xs:complexType> <!-- dpcs --> <xs:complexType name="DcpsType"> <xs:sequence> <!-- Departure Conformance Prior to SDT --> <xs:element name="nam" type="DepartConfPriorToSdtType" /> </xs:sequence> </xs:complexType> <!-- dcas --> <xs:complexType name="DcasType"> <xs:sequence> <!-- Departure Conformance After SDT --> <xs:element name="nam" type="DepartConfAfterSdtType" /> </xs:sequence> </xs:complexType> <!-- idac --> <xs:complexType name="IdacType"> <xs:sequence> <xs:element name="stw" type="StwType" /> <!-- --> <xs:element name="aak" type="AakType" /> <!-- --> <xs:element name="dmta" type="DmtaType" /> <!-- --> <xs:element name="dcps" type="DcpsType" /> <!-- --> <xs:element name="dcas" type="DcasType" /> <!-- --> </xs:sequence> </xs:complexType> <!-- Alert Type --> <xs:simpleType name="AlertType"> <xs:restriction base="xs:string"> <xs:enumeration value="DEP_WO_SDT" /> <xs:enumeration value="DEP_OUT_OF_SDT_WINDOW" /> <xs:enumeration value="UNKNOWN" /> </xs:restriction> </xs:simpleType> <!-- Alert Time --> <xs:complexType name="AlertTimeType"> <xs:sequence> <xs:element name="atm" type="xs:long" /> </xs:sequence> </xs:complexType>

68

Page 75: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

<!-- Build up to cmps --> <!-- Meter Point --> <xs:complexType name="MeterPointType"> <xs:sequence> <!-- Center Name --> <xs:element name="cen" type="CtrType"/> <!-- Tracon Name --> <xs:element name="tra" type="TraType"/> <!-- Gate Name --> <xs:element name="gat" type="FixGateArcCfgScnType"/> <!-- Meter Fix Name --> <xs:element name="mfx" type="FixGateArcCfgScnType"/> <!-- Type of meter point --> <xs:element name="type" type="CoupledMeterPointType"/> </xs:sequence> </xs:complexType> <!-- cmp --> <xs:complexType name="CmpType"> <xs:sequence> <!-- TCS Index value --> <xs:element name="tcs_index" type="TcsIndexType"/> <!-- Name of coupled pair --> <xs:element name="name" type="CoupledNameType"/> <!-- AMDT value --> <xs:element name="amdt" type="AmdtType"/> <!-- PBDM value --> <xs:element name="pbdm" type="PbdmType"/> <!-- Upstream meter point --> <xs:element name="upstream" type="MeterPointType"/> <!-- Downstream meter point --> <xs:element name="downstream" type="MeterPointType"/> </xs:sequence> </xs:complexType> <!-- cmps --> <xs:complexType name="CmpsType"> <xs:sequence> <xs:element name="cmp" type="CmpType" minOccurs="0" maxOccurs="unbounded"/> <!-- --> </xs:sequence> </xs:complexType> <xs:simpleType name="AmdtType"> <xs:restriction base="xs:string"> <!-- 0 to 99 --> <xs:pattern value="[0-9]{1,2}"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="CoupledNameType"> <xs:restriction base="xs:string"> <xs:pattern value="[A-Za-z0-9_]{1,15}"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="CoupledMeterPointType"> <xs:restriction base="xs:string"> <xs:enumeration value="COUPLED_MFX_TYPE"/>

69

Page 76: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision F (for Release 4.3.2) 3/9/2015

<xs:enumeration value="COUPLED_CMP_TYPE"/> <xs:enumeration value="COUPLED_XMP_TYPE"/> <xs:enumeration value="COUPLED_AMP_TYPE"/> <xs:enumeration value="INVALID_COUPLED_TYPE"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="PbdmType"> <xs:restriction base="xs:string"> <xs:pattern value="[0-9]{1,3}"/> <xs:pattern value="[1][0-3][0-9]{2}"/> <!-- 0 to 1440 --> <xs:pattern value="[1][4][0-4][0-9]"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="TcsIndexType"> <xs:restriction base="xs:int"> <xs:minInclusive value="1"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="FixCrossingType"> <xs:restriction base="xs:string"> <xs:enumeration value="CROSS_INV"/> <xs:enumeration value="CROSS_O4A"/> <xs:enumeration value="CROSS_O3A"/> <xs:enumeration value="CROSS_OOA"/> <xs:enumeration value="CROSS_OMA"/> <xs:enumeration value="CROSS_DPT"/> <xs:enumeration value="CROSS_SCH"/> <xs:enumeration value="CROSS_HDA"/> <xs:enumeration value="CROSS_UPSTRM_CSP"/> <xs:enumeration value="UNKNOWN_CROSSING_TYPE"/> </xs:restriction> </xs:simpleType> <xs:group name="CSPIdentifierGroup"> <xs:sequence> <xs:element name="center" type="CtrType" minOccurs="0"/> <xs:element name="tracon" type="TraType" minOccurs="0"/> <xs:element name="gate" type="FixGateArcCfgScnType" minOccurs="0"/> <xs:element name="mfx" type="FixGateArcCfgScnType" minOccurs="0"/> <xs:element name="dp" type="FixGateArcCfgScnType" minOccurs="0"/> </xs:sequence> </xs:group>

70

Page 77: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2014-0268 Rev E (4.2)

5/27/2014

APPENDIX B: METERING INFORMATION SERVICE XML DATA ELEMENT FORMAT DESCRIPTIONS

Name Short Name Element Description Format / Range

Old Aircraft ID <old> Aircraft’s original identification prior to any amendments [A-Z][A-Z0-9]{3-6}Aircraft ID <aid> Aircraft current identification [A-Z][A-Z0-9]{2,6}|Departure Airport/Fix Name

<dap> Aircraft’s Departure airport code or Fix name [A-Z0-9][A-Z0-9_/]{2,11}

Destination Airport Name

<apt> Aircraft’s destination airport code name [A-Z0-9]{3,9}

Flight Plan Status <fps> Aircraft’s Flight plan status PROPOSEDDEPARTEDESTIMATED

Aircraft Status <acs> Current Aircraft status, Aircraft could be in the following status: PROPOSED – Proposed ACTIVE - Departed/Estimated (no track) TRACKED - Actively tracking LOST - Temporary track loss DROPPED - Host RH received INACTIVE – Tracking has stopped LANDED - Landed

PROPOSEDACTIVETRACKEDLOSTDROPPEDINACTIVELANDED

Aircraft Type <typ> Aircraft type, See NAS-IR-8217 Field 03a/03c/03e([A-Za-z0-9]{1,3}/)?[A-Z][A-Za-z0-9]{1,3}(/[A-Za-z0-9])?

Engine Type <eng> Engine type of an Aircraft. Aircraft can be designated as Piston, Turbo Prop or Jet.

PISTONTURBO_PROPJET

Beacon code <bcn> Aircraft’s Beacon code [0-7]{4}|Aircraft’s filed flight plan speed

<spd> Speed that is filed within the Aircraft’s Flight plan indicating the speed the flight plans to fly (filed speed is in either knots or Mach number)

[0-9][0-9][0-9].[0-9]|[0-9].[0-9][0-9]"/>

A/C Assigned altitude <ara> Aircraft’s assigned requested altitude (feet) orVisual Flight Rules orOn Top

([1-9][0-9]{2,5})|VFR|OTP"

A/C Interim Altitude <ina> Aircraft’s interim altitude (feet) [1-9][0-9]{2,5}|

0

Page 78: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

A/C TRACON assigned Runway

<trw> Aircraft’s TRACON assigned runway, not used by TMA [0-9]{1,2}[R|L|C]{0,1}|

A/C Departure Runway <drw> Departure runway nameThis is the name from Host/ERAM

[0-9]{1,2}[A-Z]{0,2}|

A/C Track Data Source <tds> Current track data source [A-Z][A-Z0-9]{2}|Coordination fix from upstream center

<cfx> Coordination fix from most upstream Center [0-9A-Z/_]{2,12}

Coordination time from upstream center

<ctm> Coordination time from most upstream Center yyyy-mm-ddThh:mm:ssZ

Estimated time of departure

<etd> Estimated time of departure This is an estimate of when the aircraft actually departed, after the fact

yyyy-mm-ddThh:mm:ssZ

Scheduled time of departure

<std> Scheduled time of departure This is set only if the aircraft was manually scheduled by the TMC

yyyy-mm-ddThh:mm:ssZ

Estimated Departure Clearance Time

<etm> Estimated Departure Clearance Time This is the time from Host/TFMS

yyyy-mm-ddThh:mm:ssZ

Estimated Departure Clearance Status

<est> Estimated Departure Clearance Status FAA – Using FAA coordination time or STD EDC – Using EDCT time (if ETM non-zero)

FAA | EDC

Flight plan Field 10A route

<a10> Flight plan Field 10A route [0-9A-Z./_+]{6,940}

Flight plan Field 10B route (future)

<b10> Flight plan Field 10B route (future) [0-9A-Z./_+*]{6,940}

Flight plan Field 10C route (future)

<c10> Flight plan Field 10C route (future) [0-9A-Z./_+*]{6,940}

TMA converted route <tcr> TMA converted route [0-9A-Za-z/0000 ./_+]+

1

Page 79: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2014-0268 Rev E (4.2)

5/27/2014

<mrp> - Meter Reference Point Assignment Information Group

Name Short Name

Element Description Format / Range

TRACON name <tra> This is an system adapted TMA TRACON name or “EDC” name [A-Z][A-Z0-9]{2}|Meter Fix name <mfx> Meter fix name. Meter Fix is a generic term referring to a

waypoint, which is at a distance from the destination airport, at which full scheduling (constraint application and deconfliction) is performed within TBFM software.

[A-Za-z0-9_/.-]{1,48}|

Gate name <gat> Name of a Gate. A gate is a region in which arrival aircraft enter the TRACON. A feeder gate may contain one or more MREs. The typical TRACON has four feeder gates, one each to the North East, North West, South East and South West of the airport

[A-Za-z0-9_/.-]{1,48}|

Display point name <dfx> An optional arc where ETA and STA may be displayed. ETA and STA at the Display Point are based on a calculated schedule referenced to the Meter Point. (may be NULL)

[A-Za-z0-9_/.-]{1,48}|

Scheduling fix name <sfx> Name of a Scheduling Fix.It is a waypoint, which is at a distance from the destination airport, at which full scheduling (constraint application and deconfliction) is performed within TBFM software. Scheduling in TBFM is performed by the Dynamic Planner (DP). DP provides schedule deconfliction at two locations, at the runway or final approach fix and the scheduling fix. (may be NULL)

[A-Za-z0-9_/.-]{1,48}|

Outer meter arc name <oma> Name of an Outer Meter Arc. It is an arc defined in adaptation with both range and angular extent, referenced to a CTAS meter fix. When adapted, the outer meter arc is used to provide an ETA and STA referenced to the intersection of the aircraft route with the outer meter arc. (may be NULL)

[A-Za-z0-9_/.-]{1,48}|

Outer outer arc name <ooa> Name of an Outer Outer Arc.It is an arc defined in adaptation that is specified by an arc center point, a range and an angular extent. An Outer-outer arc is associated with one or more Outer meter arcs. When adapted, the Outer-outer arc is used to provide an ETA and STA referenced to the intersection of the aircraft route with the

[A-Za-z0-9_/.-]{1,48}|

2

Page 80: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

Outer-outer arc. (may be NULL)Outer third arc name <o3a> Name of an Outer Third Arc.

It is an arc defined in adaptation with both range and angular extent, referenced to an Outer-Outer Arc. When adapted, the Outer-Three Arc is used to provide an ETA and STA referenced to the intersection of the aircraft route with the Outer-Three Arc. (may be NULL)

[A-Za-z0-9_/.-]{1,48}|

Outer fourth arc name <o4a> Name of an Outer Fourth Arc. It is an arc defined in adaptation with both range and angular extent, referenced to an Outer-Three Arc. When adapted, the Outer-Four Arc is used to provide an ETA and STA referenced to the intersection of the aircraft route with the Outer-Four Arc. (may be NULL)

[A-Za-z0-9_/.-]{1,48}|

Assigned Runway <rwy> Runway assignment for arrival aircraft only [A-Z0-9]{3,4}|Configuration Name <cfg> This is an internal system-adapted configuration name. [A-Za-z0-9_/.-]{1,48}|Flight Plan category <cat> Flight plan category

NOTE: With the introduction of Multiple Meter Points (MPs) for both arrival and en route traffic, the <cat> will reflect that an arriving aircraft is an "ARRIVAL" even if it is assigned MPs. An aircraft is considered an "OVERFLIGHT" or similar category only if it is not an arrival.

DEPARTUREARRIVALOVERFLIGHTSATELLITESATELLITE_ARRIVALSATELLITE_DEPARTUREDEPARTURE_ARRIVALSATELLITE_TO_EXTERNALAMBIGUOUS_CATEGORY

Stream Class name <scn> Stream class is the set of aircraft of specific type(s) that will cross a particular feeder gate meter fix (e.g., all jets crossing LANDR). Attributes considered when assigning flights to a stream class; aircraft engine class, assigned CTAS meter fix, airport configuration anticipated for the time of landing at the arrival airport, departure fix, and filed altitude.

[A-Za-z0-9_/.-]{1,48}|

<trk> - Tracking Information Group

Name Short Name

Element Description Format / Range

Track time <ttm> Aircraft’s current Track time yyyy-mm-ddThh:mm:ssZ

3

Page 81: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2014-0268 Rev E (4.2)

5/27/2014

Latitude <lat> Aircraft’s current tracked Latitude [0-9]{5,6}[NS]Longitude <lon> Aircraft’s current tracked Longitude [0-9]{6,7}[EW]Altitude <alt> Aircraft’s current Altitude (feet) [1-9][0-9]{1,5}Ground speed <gsp> Aircraft’s current Ground speed (nmi/hour) [0-9]{1,3}Vertical speed (feet/minute)

<vsp> Aircraft’s current Vertical speed (feet/minute) [-\+][0-9]{1,5}\.[0-9]

Heading <hdg> Aircraft’s current Heading (degrees) [1-9][0-9]{0,2}\.[0-9]Track coasting flag <tkc> Aircraft’s Track coasting flag NO | YESAltitude status <als> Aircraft’s Altitude status (whether it’s descending, level or ascending) DESCENDING

LEVELASCENDING

Turn status <tus> Aircraft’s Turn status LEFTNONERIGHT

Reached cruise altitude flag

<rca> Reached cruise altitude flag NO | YES

<sch> - Scheduling Information Group

Name Short Name

Element Description Format / Range

Meter fix name <mfx> Meter fix name. Meter Fix is a generic term referring to a waypoint, which is at a distance from the destination airport, at which full scheduling (constraint application and deconfliction) is performed within TBFM software.

[A-Za-z0-9_/.-]{1,48}|

STA Frozen flag <sfz> STA frozen flagSTA freezes either when a flight traverses a freeze horizon or if manually frozen by a TMC. Once an STA is frozen for a flight, it is no longer subject to further change.

NO | YES

Scheduling suspended flag

<sus> Scheduling suspended flag Suspending a flight removes the aircraft from being scheduled by TBFM.

Some examples of the use of suspend are:

NO | YES

4

Page 82: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

To remove a MEDEVAC or emergency aircraft that will not be a part of the normal flow, if coordinated with TRACON.

To remove an open slot from the timeline. An unanticipated aircraft enters the airspace and it is suspended to

prevent it having to be de-conflicted

Manually scheduled flag

<man> Manually scheduled flag(Indicates a flight has been manually scheduled by a TMC)

NO | YES

Runway assignment frozen flag

<rfz> Runway assignment frozen flag (indicates when Aircraft’s runway assignment has been frozen and is not subject to further change).

NO | YES

<eta> - Estimated Time of Arrival Information Group

Name Short Name Element Description Format / RangeMeter fix name <mfx> Meter fix name. Meter Fix is a generic term referring to a waypoint,

which is at a distance from the destination airport, at which full scheduling (constraint application and deconfliction) is performed within TBFM software.

[A-Za-z0-9_/.-]{1,48}|

ETA at outer fourth arc <eta_o4a> Estimated time of arrival (ETA) at outer fourth arc. ETA is the time at which the aircraft is estimated to cross the MRE (e.g. runway threshold, MRE, FAF). The ETA is determined without any restrictions imposed by other aircraft or airspace constraints. A non-radar based ETA is derived from an aircraft’s flight plan. It is used until the aircraft is tracked by radar. A radar-based ETA is computed based on the aircraft’s current position and velocity estimates given by the surveillance processor, the expected route, speed, altitude profile of the aircraft to the threshold, and the projected wind. The ETA is the earliest time an aircraft would cross a fix or runway threshold if allowed to follow its assigned flight path without being impeded by separation constraints to other aircraft and with no weather or air traffic control restrictions are placed on the aircraft flight.

yyyy-mm-ddThh:mm:ssZ

ETA at outer third arc <eta_o3a> Estimated time of arrival at outer third arc (See ETA at outer fourth arc)

yyyy-mm-ddThh:mm:ssZ

ETA at outer outer arc <eta_ooa> Estimated time of arrival at outer outer arc (See ETA at outer fourth arc)

yyyy-mm-ddThh:mm:ssZ

5

Page 83: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2014-0268 Rev E (4.2)

5/27/2014

ETA at outer meter arc <eta_oma> Estimated time of arrival at outer meter arc (See ETA at outer fourth arc)

yyyy-mm-ddThh:mm:ssZ

ETA at meter fix <eta_mfx> Estimated time of arrival at meter fix (See ETA at outer fourth arc) yyyy-mm-ddThh:mm:ssZETA at display point <eta_dfx> Estimated time of arrival at display point (See ETA at outer fourth arc) yyyy-mm-ddThh:mm:ssZETA at scheduling fix <eta_sfx> Estimated time of arrival at scheduling fix (See ETA at outer fourth

arc)yyyy-mm-ddThh:mm:ssZ

ETA at runway <eta_rwy> Estimated time of arrival at runway (See ETA at outer fourth arc) yyyy-mm-ddThh:mm:ssZ

<sta> - Scheduled Time of Arrival Information Group

Element Description Format / RangeMeter fix name <mfx> Meter fix name. Meter Fix is a generic term referring to a waypoint,

which is at a distance from the destination airport, at which full scheduling (constraint application and deconfliction) is performed within TBFM software.

[A-Za-z0-9_/.-]{1,48}|

STA at outer fourth arc <sta_o4a> Scheduled time of arrival (STA) at outer fourth arc. An STA is the desired time that an aircraft should cross an MRE. It takes other flights, constraints and airspace configuration into account. An STA is the result of the TMA scheduler calculating an arrival time according to parameters such as spacing, aircraft performance, and weather.

yyyy-mm-ddThh:mm:ssZ

STA at outer third arc <sta_o3a> STA at outer third arc (See STA at outer fourth arc) yyyy-mm-ddThh:mm:ssZSTA at outer outer arc <sta_ooa> STA at outer outer arc (See STA at outer fourth arc) yyyy-mm-ddThh:mm:ssZSTA at outer meter arc <sta_oma> STA at outer meter arc (See STA at outer fourth arc) yyyy-mm-ddThh:mm:ssZSTA at display point <sta_dfx> STA at display point (See STA at outer fourth arc) yyyy-mm-ddThh:mm:ssZSTA at scheduling fix <sta_sfx> STA at scheduling fix (See STA at outer fourth arc) yyyy-mm-ddThh:mm:ssZSTA at runway <sta_rwy> STA at runway (See STA at outer fourth arc) yyyy-mm-ddThh:mm:ssZ

<con> - Configuration Information Category

<aac> - Arrival Airport Configuration Information Group

6

Element Description Format / RangeTRACON name <tra> This is a system adapted TRACON name or “EDC” name [A-Z][A-Z0-9]{2}Airport name <apt> Airport name [A-Z0-9]{3,9}Change time <tim> Time when change has taken effect. yyyy-mm-ddThh:mm:ssZConfiguration name <cfg> Name of the Arrival airport configuration. [A-Za-z0-9_/.-]{1,48}|

Page 84: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

<aar> - Arrival Airport Acceptance Rate Information Group

Name Short Name Element Description Format / RangeTRACON name <tra> This is a system adapted TRACON name or “EDC” name [A-Z][A-Z0-9]{2}Airport name <apt> Airport name [A-Z0-9]{3,9}Change time <tim> Time when change has taken effect. yyyy-mm-ddThh:mm:ssZAcceptance Rate <rat> Arrival Airport’s Acceptance rate (per hr) 3600=unrestricted

(This rate is manually set by the TMC)[0-9]{1,4}

<tar> - TRACON Acceptance Rate Information Group

Name Short Name Element Description Format / RangeTRACON name <tra> This is a system adapted TRACON name or “EDC” name [A-Z][A-Z0-9]{2}Change time <tim> Time when change has taken effect. yyyy-mm-ddThh:mm:ssZAcceptance Rate <rat> TRACON’s Acceptance rate (per hr) 3600=unrestricted

(This rate is manually set by the TMC)[0-9]{1,4}

<gar> - Gate Acceptance Rate Information Group

Name Short Name Element Description Format / RangeTRACON name <tra> This is a system adapted TRACON name or “EDC” name [A-Z][A-Z0-9]{2}Airport name <apt> Airport name [A-Z0-9]{3,9}Gate name <gat> Name of a Gate. A gate is a region in which arrival aircraft enter the

TRACON. A feeder gate may contain one or more MREs. The typical TRACON has four feeder gates, one each to the North East, North West, South East and South West of the airport

[A-Za-z0-9_/.-]{1,48}|

Change time <tim> Time when change has taken effect. yyyy-mm-ddThh:mm:ssZAcceptance Rate <rat> Gate’s Acceptance rate (per hr) 3600=unrestricted

(This rate is manually set by the TMC)[0-9]{1,4}

<mar> - Meter Fix Acceptance Rate Information Group

7

Page 85: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2014-0268 Rev E (4.2)

5/27/2014

Name Short Name Element Description Format / RangeTRACON name <tra> This is a system adapted TRACON name or “EDC” name [A-Z][A-Z0-9]{2}Airport name <apt> Airport name [A-Z0-9]{3,9}Meter fix name <mfx> Meter fix name. Meter Fix is a generic term referring to a waypoint,

which is at a distance from the destination airport, at which full scheduling (constraint application and deconfliction) is performed within TBFM software.

[A-Za-z0-9_/.-]{1,48}|

Change time <tim> Time when change has taken effect. yyyy-mm-ddThh:mm:ssZAcceptance Rate <rat> Meter Fix’s Acceptance rate (per hr) 3600=unrestricted

(This rate is manually set by the TMC)[0-9]{1-4}

<rar> - Runway Acceptance Rate Information Group

Name Short Name Element Description Format / RangeTRACON Name <tra> This is a system adapted TRACON name or “EDC” name [A-Z][A-Z0-9]{2}Airport Name <apt> Airport name [A-Z0-9]{3,9}Runway Name <rwy> Runway name [A-Z0-9]{3,4}|Change time <tim> Time when change has taken effect. yyyy-mm-ddThh:mm:ssZAcceptance rate <rat> Runway’s Acceptance rate (per hr) 3600=unrestricted

(This rate is manually set by the TMC)[0-9]{1-4}

<scc> - Super Stream Class Configuration Information Group

Name Short Name Element Description Format / RangeTRACON Name <tra> This is a system adapted TRACON name or “EDC” name [A-Z][A-Z0-9]{2}Change time <tim> Time when change has taken effect. yyyy-mm-ddThh:mm:ssZSuper Stream Class Number

<ssn> Super Sream Class number is an internal system number assigned by TBFM software. Super Stream Class is a set of one or more stream classes that have a combined miles-in-trail sepeartion constraint.

[0-9]{1,3}

Super Stream Class separation distance

<ssd> Super Stream class separation distance (in nautical miles. Super Stream class is a set of one or more stream classes that have a combined miles-in-trail sepeartion constraint.

[0-9]{1,4}\.[0-9]

8

Page 86: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

Stream Class name <scl> Stream class name. Stream class is a set of aircraft of specific type(s) that will cross a particular feeder gate meter fix (e.g., all jets crossing LANDR). Attributes considered when assigning flights to a stream class; aircraft engine class, assigned CTAS meter fix, airport configuration anticipated for the time of landing at the arrival airport, departure fix, and filed altitude.

[A-Z][A-Z0-9_/]{1,48}

<sac> - Satellite Airport Configuration Information Group

Name Short Name Element Description Format / RangeTRACON Name <tra> This is a system adapted TRACON name or “EDC” name [A-Z][A-Z0-9]{2}Change time <tim> Time when change has taken effect. yyyy-mm-ddThh:mm:ssZAirport name <san> Airport name [A-Z0-9]{3,5}Satelite Airport configuration name

<scf> This is a system adapted Satellite airport configuration name [A-Za-z0-9_/.-]{1,48}|

<oth> - Other Configuration Information Category

<tmg> - TMA Metering Status Information Group

Name Short Name Element Description Format / RangeTRACON Name <tra> This is a system adapted TRACON name or “EDC” name [A-Z][A-Z0-9]{2}Airport Name <apt> Airport Name [A-Z0-9]{3,9}Meter Point name <mfx> Meter point name (EDC EnRoute) Meter point is a term referring to an

actively scheduled (deconflicted) MRE that is usually adapted in en route airspace. Meter points are used in a number of TBFM system applications including the En route Departure Capability (EDC).

[A-Za-z0-9_/.-]{1,48}|

Center Name <ctr> Center name (TMA Arrival). This can be used to indicate whether Arrival Traffic is being metered at a particular airport.

Z[A-Z]{2}

Metering status <mas> This would indicated whether Airport/Meter Point enabled for metering NO – not enabled YES – enabled

NO | YES

9

Page 87: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2014-0268 Rev E (4.2)

5/27/2014

<int> - TMA Interface Status Information Group

Name Short Name Element Description Format / RangeInterface Name <ifn> TBFM System Interface name

Zxx – Host interface xxx – ARTS/STARS interface WIF – Weather interface TFM – TFMS interface

[A-Z][A-Z0-9]{2}

Interface Type <ift> Interface type HOST|ARTS|STAR|WXIF|TFMSInterface Status <ifs> Interface status

DN – down UP - up

DN | UP

Host Interface Metering status

<ifm> Host Interface metering enabled DN – not enabled UP - enabled

DN | UP

<adp> - Adaptation Information Category

<trn> - TRACON Name Information Group

Name Short Name Element Description Format / RangeTRACON name <nam> This is an system adapted TMA TRACON name or “EDC” name [A-Z][A-Z0-9]{2}|

<gan> - Gate Name Information Group

Name Short Name Element Description Format / RangeGate name <nam> Name of a Gate. A gate is a region in which arrival aircraft enter the

TRACON. A feeder gate may contain one or more MREs. The typical TRACON has four feeder gates, one each to the North East, North West, South East and South West of the airport

[A-Za-z0-9_/.-]{1,48}|

10

Page 88: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

<apn> - Airport Name Information Group

Name Short Name Element Description Format / RangeAirport Name <nam> Airport name [A-Z0-9]{3,9}

<rwn> - Runway Name Information

Name Short Name Element Description Format / RangeRunway Name <nam> System adapted Runway name for arrival airports [A-Z0-9]{3,4}|

<cfn> - Configuration Name Information

Name Short Name Element Description Format / RangeConfiguration Name <nam> System adapted Configuration name for arrival airports [A-Za-z0-9_/.-]{1,48}|Runway Name <rwy> System adapted Runway name for arrival airports [A-Z0-9]{3,4}|

<mrn> - Meter Reference Point Information Group

Name Short Name Element Description Format / RangeMeter Reference Point Name

<nam> Meter reference point name. It is any NAS or user-defined element, including arcs, points, and meter fixes.

[A-Za-z0-9_/.-]{1,48}|

Meter Reference Point type

<mrt> Meter reference point type MFX – Meter fix MFA – Meter fix arc OMA – Outer meter arc OOA – Outer outer arc O3A – Outer third arc

MFXMFAOMAOOAO3A

Gate Name <gat> Name of a Gate (if <mrt> is O4A, O3A, OOA, OMA or MFX/MFA)A gate is a region in which arrival aircraft enter the TRACON. A feeder gate may contain one or more MREs. The typical TRACON has four feeder gates, one each to the North East, North West, South East and South West of the airport

[A-Za-z0-9_/.-]{1,48}|

11

Page 89: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2014-0268 Rev E (4.2)

5/27/2014

Meter Fix Name <mfx> Name of a Meter fix (if <mrt> is O4A, O3A, OOA or OMA).Meter Fix is a generic term referring to a waypoint, which is at a distance from the destination airport, at which full scheduling (constraint application and deconfliction) is performed within TBFM software.

[A-Za-z0-9_/.-]{1,48}|

Outer Meter Arc Name <oma> Name of an Outer meter arc (if <mrt> is O4A, O3A or OOA).It is an arc defined in adaptation with both range and angular extent, referenced to a CTAS meter fix. When adapted, the outer meter arc is used to provide an ETA and STA referenced to the intersection of the aircraft route with the outer meter arc.

[A-Za-z0-9_/.-]{1,48}|

Outer Outer Arc Name <ooa> Name of an Outer outer arc (if <mrt> is O4A or O3A).It is an arc defined in adaptation that is specified by an arc center point, a range and an angular extent. An Outer-outer arc is associated with one or more Outer meter arcs. When adapted, the Outer-outer arc is used to provide an ETA and STA referenced to the intersection of the aircraft route with the Outer-outer arc.

[A-Za-z0-9_/.-]{1,48}|

Outer Third Arc Name <o3a> Name of an Outer third arc (if <mrt> is O4A).It is an arc defined in adaptation with both range and angular extent, referenced to an Outer-Outer Arc. When adapted, the Outer-Three Arc is used to provide an ETA and STA referenced to the intersection of the aircraft route with the Outer-Three Arc.

[A-Za-z0-9_/.-]{1,48}|

Outer Fourth Arc Name <o4a> Name of an Outer fourth arc.It is an arc defined in adaptation with both range and angular extent, referenced to an Outer-Three Arc. When adapted, the Outer-Four Arc is used to provide an ETA and STA referenced to the intersection of the aircraft route with the Outer-Four Arc.

[A-Za-z0-9_/.-]{1,48}|

Latitude of Meter Reference Point

<lat> Latitude of point or arc center [0-9]{5,6}[NS]

Longitude of Meter Reference Point

<lon> Longitude of point or arc center [0-9]{7}[E|W]

Radius of an Arc <rad> Radius of arc (nmi) (arc-only) [0-9]{1,4}\.[0-9]Left Arc Angle <lan> Left arc angle (degrees) (arc-only) [0-9]{1,4}\.[0-9]Right Arc Angle <ran> Right arc angle (degrees) (arc-only) [0-9]{1,4}\.[0-9]Ceiling Altitude of Meter Reference Point

<ahi> Ceiling Altitude of Meter Reference Point (in feet) [0-9]{0,5}

12

Page 90: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

Base Altitude of Meter Reference Point

<alo> Ceiling Altitude of Meter Reference Point (in feet) [0-9]{0,5}

<scn> - Stream Class Name Information Group

Name Short Name Element Description Format / RangeStream Class Name <nam> Name of a Stream Class.

Stream class is the set of aircraft of specific type(s) that will cross a particular feeder gate meter fix (e.g., all jets crossing LANDR). Attributes considered when assigning flights to a stream class; aircraft engine class, assigned CTAS meter fix, airport configuration anticipated for the time of landing at the arrival airport, departure fix, and filed altitude.

[A-Za-z0-9_/.-]{1,48}|

Name Short name Attribute Description Format / RangeEnvelope Source envSrce Envelope source e.g., TMA.ZBW.FAA.GOV TMA\.Z[A-Z]{2}\.FAA\.GOVEnvelope Transmission Time

envTime Envelope transmission time yyyy-mm-ddThh:mm:ssZ

Message Identifier msgId Message identifier which is unique per TBFM system [1-9][0-9]{0,10}Message Creation time msgTime Message creation time yyyy-mm-ddThh:mm:ssZAircraft Data Type airType Aircraft data type

NEW – new aircraft AMD – amend aircraft data DEL – delete aircraft

NEW | AMD | DEL

TBFM Unique Identifier tmaId TBFM unique identifier This is guaranteed to be unique between all TBFM, however, in the event of a system failure, after recovery, the TBFM identifier for any aircraft previously received will change. This identifier will not change except after a failure and recovery of TBFM.

[A-Z][0-9]{5}

Meter Reference Point Change type

mrpType Meter reference point change type NEW – new MRP assignment AMD – change existing MRP assignment NCH – no change (ALW=mrp requested) DEL – delete MRP assignment

NEW | AMD | NCH | DEL

13

Page 91: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2014-0268 Rev E (4.2)

5/27/2014

Metering Status change type

tmgType Metering status change type NEW – new complete metering status list CHG – change one or more existing metering status list entries

NEW | CHG

Arrival Airport Configuration Change type

aacType Arrival airport configuration change type NOW – configuration now in effect CHG – change future configuration DEL – delete future configuration

NOW | CHG | DEL

Airport Acceptance Rate Change type

aarType Airport acceptance rate change type NOW – rate now in effect CHG – change future rate DEL – delete future rate

NOW | CHG | DEL

TRACON Acceptance rate change type

tarType TRACON acceptance rate change type (same as aarType)

NOW | CHG | DEL

Gate Acceptance Rate change type

garType Gate acceptance rate change type (same as aarType)

NOW | CHG | DEL

Meter Fix Acceptance Rate Change type

marType Meter fix acceptance rate change type (same as aarType)

NOW | CHG | DEL

Runway Acceptance rate change type

rarType Runway acceptance rate change type (same as aarType)

NOW | CHG | DEL

Stream Class Configuration Change type

sccType SCC configuration change type NOW – configuration now in effect CHG – change future configuration DEL – delete future configuration

NOW | CHG | DEL

Satellite Airport Configuration Change type

sacType Satellite airport configuration change type NOW – configuration now in effect CHG – change future configuration DEL – delete future configuration

NOW | CHG | DEL

14

Page 92: SWIM (NEMS) ICD · Web viewThe Air Route Traffic Control Center (ARTCC) based decision support tool TBFM is used to optimize the flow of aircraft into capacity-constrained areas and

DTFAWA-10-C-00052 FAA-TBFM-2015-0043TBFM Metering Information Service JMSDD

Revision G (for Release 4.3.2) 3/9/2015

15