Jetxbit | Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== DFP Message Templates ======

===== General =====

Keywords are used inside the {$ and} delimiters, for example, FLH.CODE.

[[gn:examples_message_templates_dfp|Examples of DFP message templates]]

==== IMPORTANT ====

All message types created using message templates are processed (generated) by the template generator ([[|Source/TemplateGenerator]]).

If template-based messages are assigned the same message types as the [[|supported standard message types]], they will be processed both according to the [[|standard message processing rules]] and according to the template rules defined in the configuration.

{{:gn:templmsg.png?direct|Message types}}

For example, if a template-based message is assigned the MVT message type, it will be processed by both mechanisms.

===== Header section =====

FLHS.DATE – Flight dates, separated by commas

===== Route section =====

''Information is listed inside the SCHEDULE … $SCHEDULE block''

Output modes:

  * FL — by flight legs
  * AP — by airports

^Flight            ||
| FLH              | Flight as defined in the database                                                                                                           |
| FLH.IATA[.<sep>] | Flight with the IATA code. `<sep>` specifies the separator between the code and the flight number. Separator is ignored for call signs.     |
| FLH.ICAO[.<sep>] | Flight with the ICAO code. `<sep>` specifies the separator between the code and the flight number. Separator is ignored for call signs.     |
| FLH.INT[.<sep>]  | Flight with the internal code. `<sep>` specifies the separator between the code and the flight number. Separator is ignored for call signs. |
| FLH.CODE         | Flight code                                                                                                                                 |
| FLH.CODE.IATA    | IATA flight code                                                                                                                            |
| FLH.CODE.ICAO    | ICAO flight code                                                                                                                            |
| FLH.CODE.INT     | CTS flight code                                                                                                                             |
| FLH.NAME         | Flight number                                                                                                                               |
^Carrier           ||
| CARRIER.NAME.RU  | Name                                                                                                                                        |
| CARRIER.NAME.EN  | English name                                                                                                                                |
| CARRIER.IATA     | IATA code                                                                                                                                   |
| CARRIER.ICAO     | ICAO code                                                                                                                                   |
| CARRIER.INT      | CTS code                                                                                                                                    |
^Route (FL mode)   ||
| DEP.NAME.RU      | Departure airport name (Russian)                                                                                                            |
| DEP.ICAO         | Departure airport ICAO code                                                                                                                 |
| DEP.IATA         | Departure airport IATA code                                                                                                                 |
| DEP.INT          | Departure airport internal code                                                                                                             |
| DEP.TERM         | Departure terminal (IATA code)                                                                                                              |
| ARR.NAME.RU      | Arrival airport name (Russian)                                                                                                              |
| ARR.ICAO         | Arrival airport ICAO code                                                                                                                   |
| ARR.IATA         | Arrival airport IATA code                                                                                                                   |
| ARR.INT          | Arrival airport internal code                                                                                                               |
| ARR.TERM         | Arrival terminal (IATA code)                                                                                                                |
^Airport (AP mode) ||
| AP.NAME.RU       | Airport name (Russian)                                                                                                                      |
| AP.ICAO          | Airport ICAO code                                                                                                                           |
| AP.IATA          | Airport IATA code                                                                                                                           |
| AP.INT           | Airport internal code                                                                                                                       |
| VAR.AP.[name]    | Constants filtered by airport                                                                                                               |
^Aircraft          ||
| AC.REG           | AC reg.                                                                                                                                     |
| AC.TYPE.NAME     | AC type (English)                                                                                                                           |
| AC.TYPE.ICAO     | AC type ICAO code                                                                                                                           |
| AC.TYPE.IATA     | AC type IATA code                                                                                                                           |
| AC.MTOW.LBS      | Maximum takeoff weight (lb)                                                                                                                 |
| AC.MTOW.T        | Maximum takeoff weight (t)                                                                                                                  |
| AC.MTOW.KG       | Maximum takeoff weight (kg)                                                                                                                 |
| AC.CONF          | Aircraft configuration, e.g. 12C278Y, 189Y, 220                                                                                             |
^Times             ||
| STD[.TimeType].[[tg:message_templates_date_format|Format]]|Scheduled departure time. 'TimeType' accepts the following values: <empty> or 'Z' – UTC, 'L' – local time at the departure airport. \\ Scheduled Time of Departure|
|ETD.[[tg:message_templates_date_format|Format]] | Estimated departure time. \\ Estimated Time of Departure (wheels up) |
|ATD.[[tg:message_templates_date_format|Format]] | Actual departure time. \\ Actual Time of Departure |
|AOBT.[[tg:message_templates_date_format|Format]]| Actual off-block time. \\ Actual Off-Block Time    |
|STA[.TimeType].[[tg:message_templates_date_format|Format]]|Scheduled arrival time. 'TimeType' accepts the following values: <empty>` or 'Z' – UTC, 'L' – local time at the departure airport. \\ Scheduled Time of Arrival|
|ETA.[[tg:message_templates_date_format|Format]] | Estimated arrival time. \\ Estimated Time of Arrival (touch down) |
|ATA.[[tg:message_templates_date_format|Format]] | Actual arrival time. \\ Actual Time of Arrival (touch down) |
|AONBT.[[tg:message_templates_date_format|Format]] | Actual on-block time. \\ Actual On-Block Time |
^Delay ||
| DL.DEP.NAME | Departure delay description |
| DL.DEP.CODE |Departure delay code |
| DL.DEP.TIME.[[tg:message_templates_time_format|Format]] | Delay time (ETD/ATD − STD)|
^Special flight type||
|LITER.NAME | Name |
|LITER.CODE | Code |
^Preliminary information ||
^Crew ||
| PRE.CREW.TTL | Total number of crew members (flight crew + cabin crew) |
| PRE.CREW.CPT | Number of flight crew members |
| PRE.CREW.CAB | Number of cabin crew members |
^Passengers ||
| PRE.PAX.TTL | Total |
| PRE.PAX.TTL.B | Total, Business Class |
| PRE.PAX.TTL.Y | Total, Economy Class |
| PRE.PAX.TLS | Total occupied seats (blocked + booked) |
| PRE.PAX.TLS.B | Total occupied seats (blocked + booked), Business Class |
| PRE.PAX.TLS.Y | Total occupied seats (blocked + booked), Economy Class |
| PRE.PAX.BSN | Business Class |
| PRE.PAX.ADT | Adult passengers |
| PRE.PAX.CHD | Children (2–12 years) |
| PRE.PAX.INF |Infants (under 2 years) |
^Cargo ||
| PRE.CARGO.TTL | Baggage + Mail + Cargo |
| PRE.CARGO.BG | Baggage |
| PRE.CARGO.ML | Mail |
| PRE.CARGO.CG | Cargo |
^Fuel ||
| PRE.FUEL | Fuel from the preliminary data, rounded up to the next 100 kg |
| PRE.FUEL.UPLIFT | Fuel on board (FOB) from the OFP — FOB at the final point of the route (actual/estimated) from the previous OFP |
| PRE.FUEL.TAKEOFF | Fuel from the preliminary data (PRE.FUEL) − OFP taxi-out fuel |
| PRE.FUEL.ONBOARD | Fuel on board from the OFP. //Deprecated. Use OFP.FOB instead.// |
| PRE.FUEL.TAXIOUT | //Deprecated. Use OFP.TAXI.FUEL instead.// |
^Weight ||
| PRE.DOW | Dry operating weight. \\ DOW = aircraft structural weight + operating load for domestic flights from the [[|Aircraft directory]] + crew weight. \\ Crew weight = number of crew members in [[|Operational Information]] × [[|Crew Weight]] from the directory. |
| PRE.PLD | Payload = number of passengers from the [[|preliminary information]] × [[Passenger Weight]] + baggage + mail + cargo |
| PRE.ZFW | Zero fuel weight. PLD + DOW |
^Information from OFP ||
| OFP.FOB | Fuel on board (FOB) |
| OFP.FOBR | FOB at the final point of the route (actual/estimated) from the previous OFP |
| OFP.TOF | Fuel on board − taxi fuel |
| OFP.PLD | Payload |
| OFP.DOW | Dry operating weight |
| OFP.ZFW | ZeroFuelWeightMax |
| OFP.MTOW | TakeoffWeightMax |
| OFP.ETOW | TakeoffWeightEstimate |
| OFP.MLDW | LandingWeightMax |
| OFP.ELDW | LandingWeightEstimate |
| OFP.TRIP.FUEL | Trip fuel |
| OFP.TRIP.TIME.[[tg:message_templates_time_format|Format]] | Trip time |
| OFP.TAXI.FUEL | Taxi fuel |
^Crew information $CREW … $CREW ||
| CREW.ORDER | Sequence number (flight/cabin) |
| CREW.FIRSTNAME.ENG | First name (English) |
| CREW.SURNAME.ENG | Last name (English) |
| CREW.SEX | Gender (M/F) |
| CREW.CHAIR.CODE.ENG | Seat code |
| CREW.BIRTHDAY.[[tg:message_templates_date_format|Format]] | Date of birth in the specified [[tg:message_templates_date_format|format]] |
| CREW.ID.NUMBER | [[|ID card]] number |
| CREW.PS.NUMBER | [[|Passport]] number |
| CREW.PS.ISSUE | [[|Passport]] issue date |
| CREW.PS.EXP | [[|Passport]] expiry date |
| CREW.PHONE | Crew member phone number |
| CREW.NAT.ENG | Nationality |
| CREW.NAT.CODE2 |Nationality (2-letter code) |
| CREW.NAT.CODE3 | Nationality (3-letter code) |
^Count ||
| CREW.COUNT | Total |
| CREW.COUNT.CPT | Flight crew |
| CREW.COUNT.CAB | Cabin crew |
| CREW.COUNT.TCH | Technical personnel |
| CREW.COUNT.PAX | Positioning as passengers |
^Phone numbers ||
| CREW.PHONE.CPT | Flight crew |
| CREW.PHONE.CAB | Cabin crew |
| CREW.PHONE.TCH | Technical personnel |
| CREW.PHONE | All phone numbers |
^Email ||
| CREW.EMAIL.CPT | Flight crew |
| CREW.EMAIL.CAB | Cabin crew |
| CREW.EMAIL.TCH | Technical personnel |
| CREW.EMAIL | All email addresses |
^Permit information $PERMITS ... $PERMITS ||
| COUNTRY.CODE | Country code |
| COUNTRY.NAME | Country name |
| NUMBER | Permit number |
^Remarks ||
| RMK.FLIGHTNUMBER | Flight number remark |
| RMK.FLIGHTCODE | Carrier code remark |
| RMK.FLIGHT | Additional flight information in DFP |
| RMK.LEG|Additional leg information |

===== Text Constants =====

VAR.[name][|default_value]

VAR.ARRIVE.[name] – [[|Constants]] filtered by the arrival [[|airport]].

VAR.DEPART.[name] – [[|Constants]] filtered by the departure [[|airport]].

If <default_value> is not specified, the constant is replaced with an empty string.

{$UPPER ... $UPPER} converts text to uppercase.

{$LOWER ... $LOWER} converts text to lowercase.


===== Miscellaneous =====

^User (Users directory) ||
| USER.NAME                                       | Full name             |
| USER.EMAIL                                      |Email address          |
| USER.PHONE                                      |Phone number           |
^Time ||
| NOW.[[tg:message_templates_date_format|Format]] | Current date and time |


===== Address section =====

Macros are specified inside the {$ } construct.

| ADR.CARRIER               | Addresses from the address book filtered by carrier                                                      |
| ADR.ARRIVE.[group name]   | Addresses from the address book filtered by arrival airport                                              |
| ADR.DEPART.[group name]   | Addresses from the address book filtered by departure airport. An [address group] may also be specified. |
| ADR.NAV                   | Addresses from the Area Control Centers directory taken from the latest FPL                              |
| ADR.FPL                   | Addresses from the latest FPL                                                                            |
| ADR.[group name]          | Addresses from the address book filtered by [address group]                                              |
| <del>{$ADR.ACOWNER}</del> | <del>Addresses from the address book filtered by aircraft owner. Not used.</del>                         |

Parameters enclosed in square brackets ''[ ]'' are optional.

----

===== See also =====

[[|Message Processing]] |
[[|Supported Message Types]] |
[[|Message Templates (directory)]] |
[[|Catering Service Messages]] |
[[|Text Constants]] |
[[|tg:Source/TemplateGenerator]]