XFWB Mapping

XFWB purpose¶

XFWB message, and its predecessor FWB Message based on CIMP standard, is used to transmit complete Air Waybill data in accordance with IATA Cargo Services Conference Manual Resolution 600a. In reality we see multiple usage of the (X)FWB message that derive a bit from its original purpose. It can be the transmission of additional information (OCI for instance) or the update of goods description and weight/dimensions by a GHA. This page will focus on the main usage.

XFWB Mapping¶

Proposed mechanism¶

XFWB data fields are mostly a mix of Waybill, WaybillLineItem, Shipment, Pieces and TransportMovement data in ONE Record realm.

Usage of WaybillLineItem object¶

The WaybillLineItem object was introduced to properly share rate data as required in the Air Waybill. The WaybillLineItem has a n-to-1 relationship with a Waybill object and represents the different line items on the paper waybill with all their specifities based on the type of rating used. In order to stick to reality as much as possible, some data at line item level are taken from Pieces and LoadingUnits directly (dimensions, volume, ...). The WaybillLineItem object itself shall only contain rate specific data.

It is important to note that the WaybillLineItem has been added only in the context of sharing Air Waybill data. When looking at Operations, digital twins shall be used (Piece, Item, Product, etc.)

TransportMovement information¶

XFWB movement and routing details are mapped to TransportMovement objects. The proper linkage, starting from the Waybill is to to go through the Booking object which refers to the contractual engagements between a carrier and the freight forwarder. The various TransportMovement(s) planned for the transportation of the goods need to be linked to the Booking as an ActivitySequence.

Usage of OtherCharge object¶

The OtherCharge object is used to record all charges, it refers to <ram:ApplicableLogisticsAllowanceCharge> grouping in XFWB message. Code List 1.2 "Other Charge Code" is used to properly identify the charges associated with the Prepaid/Collect indicator.

Totals are not directly recorded in ONE Record as they can be directly calculated based on the existing data (e.g. filtering by type of charge and prepaid/collect indicator).

Other specific mapping guidelines¶

DensityGroupCode field will be linked to Distribution phase as the feedback received from the industry shows that it's not an operational data but used for the Sales & Booking process part. It is then found on the BookingShipment object if required.
Special Service Request and Other Shipping Instructions code fields are not in ONE Record as there is no evidence of an actual referential and standard used for those. Moreover it seems stakeholders use SSR or OSI for the same purposes. Thus we have merged into textualHandlingInstructions property in ONE Record.
In the ApplicableRating grouping, the TypeCode field is set to F (Facial) by default as it is the only value used with CXML.
In the ApplicalbeFreightRateServiceCharge grouping, the AppliedAmount is not directly mapped as it is a total that needs to be derived from either the Rate or the multiplication of Rate and Chargeable weight depending on the type of charge. Refer to CSC Resolution 600a for further explanations.

Mapping of Security Declaration (eCSD) information¶

In legacy messaging standards the Security Declaration information is shared via the OCI segment. While it remains valid the SecurityDeclaration object has been specifically designed in ONE Record to contain all eCSD information. It is recommended to use the SecurityDeclaration to provide eCSD information with ONE Record, it implies that in the mapping process the OCI eCSD part should be mapped to SecurityDeclaration object.

For more details on eCSD mapping, please refer to the dedicated page on Data Model section.

CIMP Mapping example¶

Simple scenario¶

A simple scenario has been chosen to display the JSON-LD equivalent of a FWB subset. The example showcases: - A FWB with 6 pieces, total weight 120kg, chargeable weight 180kg (rate percentage of 1.5), total volume 0.31 cubic meter. - 4 Pieces have 80/40/20 dimensions - 2 Pieces have 60/30/15 dimensions - 2 HS codes are defined: 123456 and 987543 - Special handling code NSC (Not Screened) is used

The FWB extracts looks the following:

FWB/17
020-12345675BRULAX/T6K120.0MC0.31
...
RTD/1/P6/K120.0/CQ/W120.0/R1.50/T180.00
/2/NG/ELECTRICALS
/3/NG/NOT RESTRICTED
/4/ND/K80.0/CMT80-40-20/4
/5/ND/K40.0/CMT60-30-15/2
/6/NV/MC0.31
/7/NH/123456
/8/NH/987543
...
SPH/NSC

The JSON-LD equivalent looks the following:

href="#__codelineno-1-1">{ "@context": { "cargo": "https://onerecord.iata.org/ns/cargo#" }, "@graph": [ { "@id": "https://example.org/Waybill", "@type": "cargo:Waybill", "cargo:waybillLineItems": { "@type": "cargo:WaybillLineItem", "cargo:chargeableWeight": { "@type": "cargo:Value", "cargo:numericalValue": 120, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#KGM" } }, "cargo:rateGrossWeight": { "@type": "cargo:Value", "cargo:numericalValue": 120, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#KGM" } }, "cargo:rateClassCode": { "@id": "https://onerecord.iata.org/ns/code-lists/RateClassCode#Q" }, "cargo:ratePercentage":{ "@type": "cargo:Value", "cargo:numericalValue": 1.5, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#P1" } }, "cargo:rateVolume": { "@type": "Value", "numericalValue": 0.31, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#MTQ" } } }, "cargo:lineItemPackages": [ { "@type": "cargo:LineItemPackage", "cargo:packageWeight": { "@type": "cargo:Value", "cargo:numericalValue": 80, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#KGM" } }, "cargo:pieceReferences": [ { "@id": "https://example.org/Piece-1", "@type": "cargo:Piece", "cargo:skeletonIndicator": true, "cargo:goodsDescription": "ELECTRICALS NOT RESTRICTED", "cargo:specialHandlingCodes": { "@id": "https://onerecord.iata.org/ns/code-lists/SpecialHandlingCode#NSC" }, "cargo:dimensions": { "@type": "cargo:Dimensions", "cargo:height": { "@type": "Value", "numericalValue": 80, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#CMT" } }, "length": { "@type": "Value", "numericalValue": 40, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#CMT" } }, "cargo:width": { "@type": "Value", "cargo:numericalValue": 20, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#CMT" } } }, "cargo:contentProducts": [ { "@id": "https://example.org/Product-1" }, { "@id": "https://example.org/Product-2" } ] }, { "@id": "https://example.org/Piece-2", "@type": "cargo:Piece", "cargo:skeletonIndicator": true, "cargo:goodsDescription": "ELECTRICALS NOT RESTRICTED", "cargo:specialHandlingCodes": { "@id": "https://onerecord.iata.org/ns/code-lists/SpecialHandlingCode#NSC" }, "cargo:dimensions": { "@type": "cargo:Dimensions", "cargo:height": { "@type": "Value", "numericalValue": 80, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#CMT" } }, "length": { "@type": "Value", "numericalValue": 40, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#CMT" } }, "cargo:width": { "@type": "Value", "cargo:numericalValue": 20, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#CMT" } } }, "cargo:contentProducts": [ { "@id": "https://example.org/Product-1" }, { "@id": "https://example.org/Product-2" } ] }, { "@id": "https://example.org/Piece-3", "@type": "cargo:Piece", "cargo:skeletonIndicator": true, "cargo:goodsDescription": "ELECTRICALS NOT RESTRICTED", "cargo:specialHandlingCodes": { "@id": "https://onerecord.iata.org/ns/code-lists/SpecialHandlingCode#NSC" }, "cargo:dimensions": { "@type": "cargo:Dimensions", "cargo:height": { "@type": "Value", "numericalValue": 80, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#CMT" } }, "length": { "@type": "Value", "numericalValue": 40, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#CMT" } }, "cargo:width": { "@type": "Value", "cargo:numericalValue": 20, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#CMT" } } }, "cargo:contentProducts": [ { "@id": "https://example.org/Product-1" }, { "@id": "https://example.org/Product-2" } ] }, { "@id": "https://example.org/Piece-4", "@type": "cargo:Piece", "cargo:skeletonIndicator": true, "cargo:goodsDescription": "ELECTRICALS NOT RESTRICTED", "cargo:specialHandlingCodes": { "@id": "https://onerecord.iata.org/ns/code-lists/SpecialHandlingCode#NSC" }, "cargo:dimensions": { "@type": "cargo:Dimensions", "cargo:height": { "@type": "Value", "numericalValue": 80, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#CMT" } }, "length": { "@type": "Value", "numericalValue": 40, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#CMT" } }, "cargo:width": { "@type": "Value", "cargo:numericalValue": 20, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#CMT" } } }, "cargo:contentProducts": [ { "@id": "https://example.org/Product-1" }, { "@id": "https://example.org/Product-2" } ] } ] }, { "@type": "cargo:LineItemPackage", "cargo:packageWeight": { "@type": "cargo:Value", "cargo:numericalValue": 40, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#KGM" } }, "cargo:pieceReferences": [ { "@id": "https://example.org/Piece-5", "@type": "cargo:Piece", "cargo:skeletonIndicator": true, "cargo:goodsDescription": "ELECTRICALS NOT RESTRICTED", "cargo:specialHandlingCodes": { "@id": "https://onerecord.iata.org/ns/code-lists/SpecialHandlingCode#NSC" }, "cargo:dimensions": { "@type": "cargo:Dimensions", "cargo:height": { "@type": "Value", "numericalValue": 60, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#CMT" } }, "length": { "@type": "Value", "numericalValue": 30, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#CMT" } }, "cargo:width": { "@type": "Value", "cargo:numericalValue": 15, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#CMT" } } }, "cargo:contentProducts": [ { "@id": "https://example.org/Product-1" }, { "@id": "https://example.org/Product-2" } ] }, { "@id": "https://example.org/Piece-6", "@type": "cargo:Piece", "cargo:skeletonIndicator": true, "cargo:goodsDescription": "ELECTRICALS NOT RESTRICTED", "cargo:specialHandlingCodes": { "@id": "https://onerecord.iata.org/ns/code-lists/SpecialHandlingCode#NSC" }, "cargo:dimensions": { "@type": "cargo:Dimensions", "cargo:height": { "@type": "Value", "numericalValue": 60, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#CMT" } }, "length": { "@type": "Value", "numericalValue": 30, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#CMT" } }, "cargo:width": { "@type": "Value", "cargo:numericalValue": 15, "cargo:unit": { "@id": "https://vocabulary.uncefact.org/UnitMeasureCode#CMT" } } }, "cargo:contentProducts": [ { "@id": "https://example.org/Product-1" }, { "@id": "https://example.org/Product-2" } ] } ] } ] }, "cargo:shipment": { "@id": "https://example.org/Shipment", "@type": "cargo:shipment", "cargo:pieces": [ { "@id": "https://example.org/Piece-1" }, { "@id": "https://example.org/Piece-2" }, { "@id": "https://example.org/Piece-3" }, { "@id": "https://example.org/Piece-4" }, { "@id": "https://example.org/Piece-5" }, { "@id": "https://example.org/Piece-6" } ] } }, { "@id": "https://example.org/Product-1", "@type": "cargo:Product", "cargo:hsCode": { "@id": "https://example.org/ns/HSCode#123456" } }, { "@id": "https://example.org/Product-2", "@type": "cargo:Product", "cargo:hsCode": { "@id": "https://example.org/ns/HSCode#987543" } } ] }