EFB XML Documentation missing information

Version: SDK release 1.6.4

Frequency: /Consistently

Severity: Low

Context: Documentation

Similar MSFS 2020 issue: not applicable

Bug description:

EFB XML documentation is correct but lacks some important detail

  • Pls indicate where the Wyp ID attribute and where the Wyp ICAO is used
    i.e. is the ID or the ICAO running through the GPS as waypoint ID ?

  • Sequence or order of element appearance in XML

Pls indicate the expected order e.g.

Descriptive elements as provided in the document (any order required?)
Then Departure if any
Then a number (is there a maximum we should know?) of Wyps flown in THAT sequence if any
Then Arrival if any
Then Approach if any
and then nothing anymore…

  • While User Wyps must be unique is it then allowed to have Non User type wyps appearing more than once in the same plan and they are tracked in the order of appearance?

  • Pls mention that airways have to be expanded and that there is no such thing as an airway in the EFB file format (else one is looking for it)
    I am suggesting this as the example EFB screen shows Airway selection and there is no airway mentioned in the EFB format and the legacy one had it:

  • Include a valid User Waypoint as example

I think this is a very good suggestion. A sharable PLN file in a solid format has always been essential for our successful large community multiplayer VFR flights.

Two specific practical ideas:

  • the docs should include User waypoints in the SDK examples. Maybe surprisingly these are the most important type for our 3000-player VFR group.
  • the SDK should include working examples of a complete PLN file for both XML formats exercising every permitted element.
  • FWIW I think it’s a mistake having one PLN format documented in one part of the SDK and the other almost identical format documented in an unconnected page.
1 Like

Yes, as was the case with the 2020 PLN format.

It’s an XML document; being XML there is no such thing as an order.

This is not correct. You can supply an element. For example, here’s HNK J49 BIGEO:

<ATCWaypoint id="HNK">
  <ATCWaypointType>VOR</ATCWaypointType>
  <ICAO>
    <ICAORegion>K6</ICAORegion>
    <ICAOIdent>HNK</ICAOIdent>
  </ICAO>
</ATCWaypoint>
<ATCWaypoint id="BIGEO">
  <ATCWaypointType>Intersection</ATCWaypointType>
  <ATCAirway>J49</ATCAirway>
  <ICAO>
    <ICAORegion>K6</ICAORegion>
    <ICAOIdent>BIGEO</ICAOIdent>
  </ICAO>
</ATCWaypoint>

Thanks,
Matt

Sometimes there is such a thing when defining the structure in an XSD..

Compositor Description
Sequence The child elements in the XML document MUST appear in the order they are declared in the XSD schema.
Choice Only one of the child elements described in the XSD schema can appear in the XML document.
All The child elements described in the XSD schema can appear in the XML document in any order. But then the cardinality can only be 1

If one wants to describe the Flightplan with multiple ATCWaypoint elements one must use Sequence where the order matters.
Hence my question…

For the Airway, I was looking into

as asked for and the element is written as:

It can have the following sub-elements:

  1. <ATCWaypointType>

  2. <ICAO>

so in the EFB plan there is no ATCAirway specified - either it cannot be or the documentation is still not quite right. You decide :slight_smile:

1 Like

All elements can appear in any order. ATCWaypoint will be assumed to be in the order they are in the file, but they need not be consecutive, and can have any number of elements between each one.

It is missing from the documentation.

Thanks,
Matt

1 Like

MSFS flightplans totally depend on the PLN having an order for the waypoints so the PLN is actually a sequential file. These files are critically important in VFR multiplayer to the extent we have addons that ensure the same PLN file is distributed and loaded by all players multiple times a week with up to 50 players per flight. If MSFS starts ignoring the order of the waypoints we won’t be able to use PLN to represent VFR flights at all.

1 Like

Thanks,

Matt