diff --git a/specs/index.bs b/specs/index.bs index 7c6504b..7be04be 100644 --- a/specs/index.bs +++ b/specs/index.bs @@ -1,5 +1,9 @@
+<<<<<<< HEAD Title: iLEAP Technical Specifications (Version 0.2.1-20240903) +======= +Title: iLEAP Technical Specifications (Version 0.2.1-20240930) +>>>>>>> e086402 (chore: add changelog entry) Shortname: ileap-extension Status: LD Status Text: Draft Technical Specification @@ -1910,7 +1914,7 @@ With response parameters The Data types defined in [[#data-model]] are specific to [[!ISO14083]] and the [[!GLEC]] Framework. This section specifies the integration of the data types <{ShipmentFootprint}>, <{TOC}>, and <{HOC}> into the PACT Data Model ([[!PACTDX]] Chapter 4). -The integration of the data types <{ShipmentFootprint}> and <{TOC}> is achieved by storing them as extensions to the PACT Data Model (see [[!DATA-MODEL-EXTENSIONS]]). +The integration of the data types <{ShipmentFootprint}>, <{TOC}>, and <{HOC}> is achieved by storing them as extensions to the PACT Data Model (see [[!DATA-MODEL-EXTENSIONS]]). Therefore, all properties defined in the latter are also properties of the former. As a result, some properties relevant to logistics do not need to be defined in the [[#data-model]]. The list below contains the properties that were omitted for this reason. @@ -2003,34 +2007,59 @@ Note: Section [[#appendix-b-sf-example]] contains an example.CarbonFootprint - `pCfExcludingBiogenic` + `productMassPerDeclaredUnit` - MUST be set to the total logistics emissions of the shipment, excluding biogenic emissions, - calculated by taking the sum of the <{TCE/co2eWTW}> over all TCEs (<{ShipmentFootprint/tces}>). + This property is OPTIONAL in the [[!PACTDX]] data Model but will become MANDATORY in v3. + + MUST equal the mass of the shipment (<{ShipmentFootprint/mass}>). + + CarbonFootprint + `pCfExcludingBiogenic` + + MUST be set to the total logistics emissions of the shipment calculated by taking the sum of the <{TCE/co2eWTW}> + over all TCEs (<{ShipmentFootprint/tces}>). + Advisement: Version 4 of the GLEC Framework will provide guidance on biogenic emissions. Updates to this property + will be made after its release. CarbonFootprint `pCfIncludingBiogenic` This property is OPTIONAL in the [[!PACTDX]] data Model. - It SHOULD be set to the total logistics emissions of the shipment, - including biogenic emissions, calculated by taking the sum of the <{TCE/co2eWTW}> over all TCEs (<{ShipmentFootprint/tces}>). + It SHOULD be kept undefined. + Advisement: Version 4 of the GLEC Framework will provide guidance on biogenic emissions. Updates to this property + will be made after its release. CarbonFootprint `fossilGhgEmissions` see the specification for `pCfExcludingBiogenic` in this table + + CarbonFootprint + `fossilCarbonContent` + + see the specification for `pCfExcludingBiogenic` in this table + + + CarbonFootprint + `biogenicCarbonContent` + + SHOULD be set to `"0"` + + Advisement: Version 4 of the GLEC Framework will provide guidance on biogenic emissions. Updates to this property + will be made after its release. + CarbonFootprint `packagingEmissionsIncluded` see [[!PACTDX]] for further details - Issue: this property is pending input from the tech workshop(s) + MUST be set to `false`. CarbonFootprint @@ -2044,6 +2073,36 @@ Note: Section [[#appendix-b-sf-example]] contains an example. Mapping of PACT Data Model properties to <{ShipmentFootprint}> properties +The `ProductFootprint` mandatory properties +[id](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-id), +[specVersion](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-specversion), +[version](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-version), +[status](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-status), +[companyName](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-companyname), +[companyIds](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-companyids), +[productDescription](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-productdescription), +and +[productNameCompany](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-productnamecompany) +cannot be derived from the `ShipmentFootprint` and MUST be provided by the data owner. Please follow +the links above for further details. + +The `CarbonFootprint` mandatory properties +[characterizationFactors](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-characterizationfactors), +[ipccCharacterizationFactorsSources](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-ipcccharacterizationfactorssources), +[crossSectoralStandardsUsed](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-crosssectoralstandardsused), +[crossSectoralStandars](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-crosssectoralstandards), +[boundaryProcessesDescription](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-boundaryprocessesdescription), +[referencePeriodStart](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-referenceperiodstart), +[referencePeriodEnd](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-referenceperiodend), +[exemptedEmissionsPercent](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-exemptedemissionspercent), +and +[exemptedEmissionsDescription](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-exemptedemissionsdescription) +cannot be derived from the `ShipmentFootprint` and MUST be provided by the data owner. Please follow +the links above for further details. + +Any optional property that is not explicitly mentioned above MAY remain unset. All mandatory +properties that cannot be derived from `ShipmentFootprint` CAN be populated in a best-effort manner. + ### TOC ### {#pcf-mapping-toc} Note: This chapter refers to the PACT Data Model. See [[!PACTDX]] Chapter 4 for further details. @@ -2097,12 +2156,23 @@ Note: Section [[#appendix-b-toc-example]] contains an example.SHOULD be set to `"1"` so that the ProductFootprint represents the emissions per ton kilometer of the TOC. + + + CarbonFootprint + `productMassPerDeclaredUnit` + + This property is OPTIONAL in the [[!PACTDX]] data Model but will become MANDATORY in v3. + + MUST be set to `"1"`. + CarbonFootprint `pCfExcludingBiogenic` - MUST be set to the logistics emissions intensity of the TOC, excluding biogenic emissions, - defined in <{TOC/co2eIntensityWTW}>. + MUST be set to the logistics emissions intensity of the TOC defined in <{TOC/co2eIntensityWTW}>. + + Advisement: Version 4 of the GLEC Framework will provide guidance on biogenic emissions. Updates to this property + will be made after its release. CarbonFootprint @@ -2110,14 +2180,31 @@ Note: Section [[#appendix-b-toc-example]] contains an example. This property is OPTIONAL in the [[!PACTDX]] data Model. - It SHOULD be set to the logistics emissions intensity of the TOC, - including biogenic emissions, found in <{TOC/co2eIntensityWTW}>. + It SHOULD be kept undefined. + + Advisement: Version 4 of the GLEC Framework will provide guidance on biogenic emissions. Updates to this property + will be made after its release. CarbonFootprint `fossilGhgEmissions` - see the specification for `pCfExcludingBiogenic` in this table + Note: see the specification for `pCfIncludingBiogenic` in this table + + + CarbonFootprint + `fossilCarbonContent` + + Note: see the specification for `pCfIncludingBiogenic` in this table + + + CarbonFootprint + `biogenicCarbonContent` + + SHOULD be set to `"0"` (zero encoded as a string) + + Advisement: Version 4 of the GLEC Framework will provide guidance on biogenic emissions. Updates to this property + will be made after its release. CarbonFootprint @@ -2138,6 +2225,37 @@ Note: Section [[#appendix-b-toc-example]] contains an example. Mapping of PACT Data Model properties to <{TOC}> properties + +The `ProductFootprint` mandatory properties +[id](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-id), +[specVersion](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-specversion), +[version](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-version), +[status](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-status), +[companyName](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-companyname), +[companyIds](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-companyids), +[productDescription](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-productdescription), +and +[productNameCompany](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-productnamecompany) +cannot be derived from the `TOC` and MUST be provided by the data owner. Please follow the links +above for further details. + +The `CarbonFootprint` mandatory properties +[characterizationFactors](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-characterizationfactors), +[ipccCharacterizationFactorsSources](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-ipcccharacterizationfactorssources), +[crossSectoralStandardsUsed](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-crosssectoralstandardsused), +[crossSectoralStandars](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-crosssectoralstandards), +[boundaryProcessesDescription](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-boundaryprocessesdescription), +[referencePeriodStart](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-referenceperiodstart), +[referencePeriodEnd](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-referenceperiodend), +[exemptedEmissionsPercent](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-exemptedemissionspercent), +and +[exemptedEmissionsDescription](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-exemptedemissionsdescription) +cannot be derived from the `TOC` and MUST be provided by the data owner. Please follow +the links above for further details. + +Any optional property that is not explicitly mentioned above MAY remain unset. All mandatory +properties that cannot be derived from `TOC` CAN be populated in a best-effort manner. + ### HOC ### {#pcf-mapping-hoc} Note: This chapter refers to the PACT Data Model. See [[!PACTDX]] Chapter 4 for further details. @@ -2191,31 +2309,58 @@ Note: Section [[#appendix-b-hoc-example]] contains an example.MUST be set to `"1000"` so that the ProductFootprint represents the emissions of the HOC per tonne leaving the hub. + + CarbonFootprint + `productMassPerDeclaredUnit` + + This property is OPTIONAL in the [[!PACTDX]] data Model but will become MANDATORY in v3. + + MUST be set to `"1000"`. + CarbonFootprint `pCfExcludingBiogenic` - MUST be set to the logistics emissions intensity of the HOC, excluding biogenic emissions, - defined in <{HOC/co2eIntensityWTW}>. + MUST be set to the logistics emissions intensity of the HOC defined in <{HOC/co2eIntensityWTW}>. Note: The average weight of a container can be considered as 10 tonnes per `TEU`. For light containers, an estimate of 6 tonnes per `TEU` is appropriate, while heavy containers can be assumed to average 14.5 tonnes per `TEU`. + Advisement: Version 4 of the GLEC Framework will provide guidance on biogenic emissions. Updates to this property + will be made after its release. + CarbonFootprint `pCfIncludingBiogenic` This property is OPTIONAL in the [[!PACTDX]] data Model. - It SHOULD be set to the logistics emissions intensity of the HOC, - including biogenic emissions, found in <{HOC/co2eIntensityWTW}>. + It SHOULD be kept undefined. + + Advisement: Version 4 of the GLEC Framework will provide guidance on biogenic emissions. Updates to this property + will be made after its release. CarbonFootprint `fossilGhgEmissions` - see the specification for `pCfExcludingBiogenic` in this table + Note: see the specification for `pCfExcludingBiogenic` in this table + + + CarbonFootprint + `fossilCarbonContent` + + Note: see the specification for `pCfExcludingBiogenic` in this table + + + CarbonFootprint + `biogenicCarbonContent` + + SHOULD be set to `"0"` (zero encoded as a string) + + Advisement: Version 4 of the GLEC Framework will provide guidance on biogenic emissions. Updates to this property + will be made after its release. CarbonFootprint @@ -2237,8 +2382,42 @@ Note: Section [[#appendix-b-hoc-example]] contains an example. +The `ProductFootprint` mandatory properties +[id](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-id), +[specVersion](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-specversion), +[version](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-version), +[status](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-status), +[companyName](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-companyname), +[companyIds](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-companyids), +[productDescription](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-productdescription), +and +[productNameCompany](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-productnamecompany) +cannot be derived from the `HOC` and MUST be provided by the data owner. Please follow +the links above for further details. + +The `CarbonFootprint` mandatory properties +[characterizationFactors](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-characterizationfactors), +[ipccCharacterizationFactorsSources](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-ipcccharacterizationfactorssources), +[crossSectoralStandardsUsed](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-crosssectoralstandardsused), +[crossSectoralStandars](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-crosssectoralstandards), +[boundaryProcessesDescription](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-boundaryprocessesdescription), +[referencePeriodStart](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-referenceperiodstart), +[referencePeriodEnd](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-referenceperiodend), +[exemptedEmissionsPercent](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-exemptedemissionspercent), +and +[exemptedEmissionsDescription](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-exemptedemissionsdescription) +cannot be derived from the `HOC` and MUST be provided by the data owner. Please follow +the links above for further details. + +Any optional property that is not explicitly mentioned above MAY remain unset. All mandatory +properties that cannot be derived from `HOC` CAN be populated in a best-effort manner. + # Appendix A: Changelog # {#changelog} +## Version 0.2.1-20240930 (2024-09-30) ## {#version-20240930} + +- provide better guidance on [[#pcf-mapping]] + ## Version 0.2.1-20240903 (2024-09-03) ## {#version-20240903} - make application of <{Location/iata}> and <{Location/uic}> more explicit