Skip to content

Commit c574d85

Browse files
zeitgeistzeitgeist
authored
Merge pull request #99 from sine-fdn/pact-integration
feat: initial proposal on how to improve integration chapter
2 parents 867a4f1 + 6b04241 commit c574d85

File tree

1 file changed

+196
-17
lines changed

1 file changed

+196
-17
lines changed

‎specs/index.bs

+196-17
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
<pre class='metadata'>
2+
<<<<<<< HEAD
23
Title: iLEAP Technical Specifications (Version 0.2.1-20240903)
4+
=======
5+
Title: iLEAP Technical Specifications (Version 0.2.1-20240930)
6+
>>>>>>> e086402 (chore: add changelog entry)
37
Shortname: ileap-extension
48
Status: LD
59
Status Text: Draft Technical Specification
@@ -1910,7 +1914,7 @@ With response parameters
19101914
The Data types defined in [[#data-model]] are specific to [[!ISO14083]] and the [[!GLEC]] Framework.
19111915

19121916
This section specifies the integration of the data types <{ShipmentFootprint}>, <{TOC}>, and <{HOC}> into the PACT Data Model ([[!PACTDX]] Chapter 4).
1913-
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]]).
1917+
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]]).
19141918
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]].
19151919
The list below contains the properties that were omitted for this reason.
19161920

@@ -2003,34 +2007,59 @@ Note: Section [[#appendix-b-sf-example]] contains an example.
20032007

20042008
<tr>
20052009
<td>CarbonFootprint
2006-
<td>`pCfExcludingBiogenic`
2010+
<td>`productMassPerDeclaredUnit`
20072011
<td>
2008-
MUST be set to the total logistics emissions of the shipment, excluding biogenic emissions,
2009-
calculated by taking the sum of the <{TCE/co2eWTW}> over all TCEs (<{ShipmentFootprint/tces}>).
2012+
This property is OPTIONAL in the [[!PACTDX]] data Model but will become MANDATORY in v3.
2013+
2014+
MUST equal the mass of the shipment (<{ShipmentFootprint/mass}>).
20102015

2016+
<tr>
2017+
<td>CarbonFootprint
2018+
<td>`pCfExcludingBiogenic`
2019+
<td>
2020+
MUST be set to the total logistics emissions of the shipment calculated by taking the sum of the <{TCE/co2eWTW}>
2021+
over all TCEs (<{ShipmentFootprint/tces}>).
20112022

2023+
Advisement: Version 4 of the GLEC Framework will provide guidance on biogenic emissions. Updates to this property
2024+
will be made after its release.
20122025
<tr>
20132026
<td>CarbonFootprint
20142027
<td>`pCfIncludingBiogenic`
20152028
<td>
20162029
This property is OPTIONAL in the [[!PACTDX]] data Model.
20172030

2018-
It SHOULD be set to the total logistics emissions of the shipment,
2019-
including biogenic emissions, calculated by taking the sum of the <{TCE/co2eWTW}> over all TCEs (<{ShipmentFootprint/tces}>).
2031+
It SHOULD be kept undefined.
20202032

2033+
Advisement: Version 4 of the GLEC Framework will provide guidance on biogenic emissions. Updates to this property
2034+
will be made after its release.
20212035
<tr>
20222036
<td>CarbonFootprint
20232037
<td>`fossilGhgEmissions`
20242038
<td>
20252039
see the specification for `pCfExcludingBiogenic` in this table
20262040

2041+
<tr>
2042+
<td>CarbonFootprint
2043+
<td>`fossilCarbonContent`
2044+
<td>
2045+
see the specification for `pCfExcludingBiogenic` in this table
2046+
2047+
<tr>
2048+
<td>CarbonFootprint
2049+
<td>`biogenicCarbonContent`
2050+
<td>
2051+
SHOULD be set to `"0"`
2052+
2053+
Advisement: Version 4 of the GLEC Framework will provide guidance on biogenic emissions. Updates to this property
2054+
will be made after its release.
2055+
20272056
<tr>
20282057
<td>CarbonFootprint
20292058
<td>`packagingEmissionsIncluded`
20302059
<td>
20312060
see [[!PACTDX]] for further details
20322061

2033-
Issue: this property is pending input from the tech workshop(s)
2062+
MUST be set to `false`.
20342063

20352064
<tr>
20362065
<td>CarbonFootprint
@@ -2044,6 +2073,36 @@ Note: Section [[#appendix-b-sf-example]] contains an example.
20442073
<figcaption>Mapping of PACT Data Model properties to <{ShipmentFootprint}> properties</figcaption>
20452074
</figure>
20462075

2076+
The `ProductFootprint` mandatory properties
2077+
[id](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-id),
2078+
[specVersion](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-specversion),
2079+
[version](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-version),
2080+
[status](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-status),
2081+
[companyName](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-companyname),
2082+
[companyIds](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-companyids),
2083+
[productDescription](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-productdescription),
2084+
and
2085+
[productNameCompany](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-productnamecompany)
2086+
cannot be derived from the `ShipmentFootprint` and MUST be provided by the data owner. Please follow
2087+
the links above for further details.
2088+
2089+
The `CarbonFootprint` mandatory properties
2090+
[characterizationFactors](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-characterizationfactors),
2091+
[ipccCharacterizationFactorsSources](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-ipcccharacterizationfactorssources),
2092+
[crossSectoralStandardsUsed](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-crosssectoralstandardsused),
2093+
[crossSectoralStandars](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-crosssectoralstandards),
2094+
[boundaryProcessesDescription](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-boundaryprocessesdescription),
2095+
[referencePeriodStart](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-referenceperiodstart),
2096+
[referencePeriodEnd](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-referenceperiodend),
2097+
[exemptedEmissionsPercent](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-exemptedemissionspercent),
2098+
and
2099+
[exemptedEmissionsDescription](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-exemptedemissionsdescription)
2100+
cannot be derived from the `ShipmentFootprint` and MUST be provided by the data owner. Please follow
2101+
the links above for further details.
2102+
2103+
Any optional property that is not explicitly mentioned above MAY remain unset. All mandatory
2104+
properties that cannot be derived from `ShipmentFootprint` CAN be populated in a best-effort manner.
2105+
20472106
### TOC ### {#pcf-mapping-toc}
20482107

20492108
Note: This chapter refers to the PACT Data Model. See [[!PACTDX]] Chapter 4 for further details.
@@ -2097,27 +2156,55 @@ Note: Section [[#appendix-b-toc-example]] contains an example.
20972156
<td>
20982157
SHOULD be set to `"1"` so that the ProductFootprint represents the emissions per ton kilometer of the TOC.
20992158

2159+
2160+
<tr>
2161+
<td>CarbonFootprint
2162+
<td>`productMassPerDeclaredUnit`
2163+
<td>
2164+
This property is OPTIONAL in the [[!PACTDX]] data Model but will become MANDATORY in v3.
2165+
2166+
MUST be set to `"1"`.
2167+
21002168
<tr>
21012169
<td>CarbonFootprint
21022170
<td>`pCfExcludingBiogenic`
21032171
<td>
2104-
MUST be set to the logistics emissions intensity of the TOC, excluding biogenic emissions,
2105-
defined in <{TOC/co2eIntensityWTW}>.
2172+
MUST be set to the logistics emissions intensity of the TOC defined in <{TOC/co2eIntensityWTW}>.
2173+
2174+
Advisement: Version 4 of the GLEC Framework will provide guidance on biogenic emissions. Updates to this property
2175+
will be made after its release.
21062176

21072177
<tr>
21082178
<td>CarbonFootprint
21092179
<td>`pCfIncludingBiogenic`
21102180
<td>
21112181
This property is OPTIONAL in the [[!PACTDX]] data Model.
21122182

2113-
It SHOULD be set to the logistics emissions intensity of the TOC,
2114-
including biogenic emissions, found in <{TOC/co2eIntensityWTW}>.
2183+
It SHOULD be kept undefined.
2184+
2185+
Advisement: Version 4 of the GLEC Framework will provide guidance on biogenic emissions. Updates to this property
2186+
will be made after its release.
21152187

21162188
<tr>
21172189
<td>CarbonFootprint
21182190
<td>`fossilGhgEmissions`
21192191
<td>
2120-
see the specification for `pCfExcludingBiogenic` in this table
2192+
Note: see the specification for `pCfIncludingBiogenic` in this table
2193+
2194+
<tr>
2195+
<td>CarbonFootprint
2196+
<td>`fossilCarbonContent`
2197+
<td>
2198+
Note: see the specification for `pCfIncludingBiogenic` in this table
2199+
2200+
<tr>
2201+
<td>CarbonFootprint
2202+
<td>`biogenicCarbonContent`
2203+
<td>
2204+
SHOULD be set to `"0"` (zero encoded as a string)
2205+
2206+
Advisement: Version 4 of the GLEC Framework will provide guidance on biogenic emissions. Updates to this property
2207+
will be made after its release.
21212208

21222209
<tr>
21232210
<td>CarbonFootprint
@@ -2138,6 +2225,37 @@ Note: Section [[#appendix-b-toc-example]] contains an example.
21382225
<figcaption>Mapping of PACT Data Model properties to <{TOC}> properties</figcaption>
21392226
</figure>
21402227

2228+
2229+
The `ProductFootprint` mandatory properties
2230+
[id](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-id),
2231+
[specVersion](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-specversion),
2232+
[version](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-version),
2233+
[status](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-status),
2234+
[companyName](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-companyname),
2235+
[companyIds](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-companyids),
2236+
[productDescription](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-productdescription),
2237+
and
2238+
[productNameCompany](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-productnamecompany)
2239+
cannot be derived from the `TOC` and MUST be provided by the data owner. Please follow the links
2240+
above for further details.
2241+
2242+
The `CarbonFootprint` mandatory properties
2243+
[characterizationFactors](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-characterizationfactors),
2244+
[ipccCharacterizationFactorsSources](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-ipcccharacterizationfactorssources),
2245+
[crossSectoralStandardsUsed](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-crosssectoralstandardsused),
2246+
[crossSectoralStandars](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-crosssectoralstandards),
2247+
[boundaryProcessesDescription](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-boundaryprocessesdescription),
2248+
[referencePeriodStart](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-referenceperiodstart),
2249+
[referencePeriodEnd](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-referenceperiodend),
2250+
[exemptedEmissionsPercent](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-exemptedemissionspercent),
2251+
and
2252+
[exemptedEmissionsDescription](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-exemptedemissionsdescription)
2253+
cannot be derived from the `TOC` and MUST be provided by the data owner. Please follow
2254+
the links above for further details.
2255+
2256+
Any optional property that is not explicitly mentioned above MAY remain unset. All mandatory
2257+
properties that cannot be derived from `TOC` CAN be populated in a best-effort manner.
2258+
21412259
### HOC ### {#pcf-mapping-hoc}
21422260

21432261
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.
21912309
<td>
21922310
MUST be set to `"1000"` so that the ProductFootprint represents the emissions of the HOC per tonne leaving the hub.
21932311

2312+
<tr>
2313+
<td>CarbonFootprint
2314+
<td>`productMassPerDeclaredUnit`
2315+
<td>
2316+
This property is OPTIONAL in the [[!PACTDX]] data Model but will become MANDATORY in v3.
2317+
2318+
MUST be set to `"1000"`.
2319+
21942320
<tr>
21952321
<td>CarbonFootprint
21962322
<td>`pCfExcludingBiogenic`
21972323
<td>
2198-
MUST be set to the logistics emissions intensity of the HOC, excluding biogenic emissions,
2199-
defined in <{HOC/co2eIntensityWTW}>.
2324+
MUST be set to the logistics emissions intensity of the HOC defined in <{HOC/co2eIntensityWTW}>.
22002325

22012326
Note: The average weight of a container can be considered as 10 tonnes per `TEU`. For light containers, an
22022327
estimate of 6 tonnes per `TEU` is appropriate, while heavy containers can be assumed to average 14.5 tonnes
22032328
per `TEU`.
22042329

2330+
Advisement: Version 4 of the GLEC Framework will provide guidance on biogenic emissions. Updates to this property
2331+
will be made after its release.
2332+
22052333
<tr>
22062334
<td>CarbonFootprint
22072335
<td>`pCfIncludingBiogenic`
22082336
<td>
22092337
This property is OPTIONAL in the [[!PACTDX]] data Model.
22102338

2211-
It SHOULD be set to the logistics emissions intensity of the HOC,
2212-
including biogenic emissions, found in <{HOC/co2eIntensityWTW}>.
2339+
It SHOULD be kept undefined.
2340+
2341+
Advisement: Version 4 of the GLEC Framework will provide guidance on biogenic emissions. Updates to this property
2342+
will be made after its release.
22132343

22142344
<tr>
22152345
<td>CarbonFootprint
22162346
<td>`fossilGhgEmissions`
22172347
<td>
2218-
see the specification for `pCfExcludingBiogenic` in this table
2348+
Note: see the specification for `pCfExcludingBiogenic` in this table
2349+
2350+
<tr>
2351+
<td>CarbonFootprint
2352+
<td>`fossilCarbonContent`
2353+
<td>
2354+
Note: see the specification for `pCfExcludingBiogenic` in this table
2355+
2356+
<tr>
2357+
<td>CarbonFootprint
2358+
<td>`biogenicCarbonContent`
2359+
<td>
2360+
SHOULD be set to `"0"` (zero encoded as a string)
2361+
2362+
Advisement: Version 4 of the GLEC Framework will provide guidance on biogenic emissions. Updates to this property
2363+
will be made after its release.
22192364

22202365
<tr>
22212366
<td>CarbonFootprint
@@ -2237,8 +2382,42 @@ Note: Section [[#appendix-b-hoc-example]] contains an example.
22372382
</figure>
22382383

22392384

2385+
The `ProductFootprint` mandatory properties
2386+
[id](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-id),
2387+
[specVersion](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-specversion),
2388+
[version](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-version),
2389+
[status](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-status),
2390+
[companyName](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-companyname),
2391+
[companyIds](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-companyids),
2392+
[productDescription](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-productdescription),
2393+
and
2394+
[productNameCompany](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-productfootprint-productnamecompany)
2395+
cannot be derived from the `HOC` and MUST be provided by the data owner. Please follow
2396+
the links above for further details.
2397+
2398+
The `CarbonFootprint` mandatory properties
2399+
[characterizationFactors](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-characterizationfactors),
2400+
[ipccCharacterizationFactorsSources](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-ipcccharacterizationfactorssources),
2401+
[crossSectoralStandardsUsed](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-crosssectoralstandardsused),
2402+
[crossSectoralStandars](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-crosssectoralstandards),
2403+
[boundaryProcessesDescription](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-boundaryprocessesdescription),
2404+
[referencePeriodStart](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-referenceperiodstart),
2405+
[referencePeriodEnd](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-referenceperiodend),
2406+
[exemptedEmissionsPercent](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-exemptedemissionspercent),
2407+
and
2408+
[exemptedEmissionsDescription](https://wbcsd.github.io/data-exchange-protocol/v2/#element-attrdef-carbonfootprint-exemptedemissionsdescription)
2409+
cannot be derived from the `HOC` and MUST be provided by the data owner. Please follow
2410+
the links above for further details.
2411+
2412+
Any optional property that is not explicitly mentioned above MAY remain unset. All mandatory
2413+
properties that cannot be derived from `HOC` CAN be populated in a best-effort manner.
2414+
22402415
# Appendix A: Changelog # {#changelog}
22412416

2417+
## Version 0.2.1-20240930 (2024-09-30) ## {#version-20240930}
2418+
2419+
- provide better guidance on [[#pcf-mapping]]
2420+
22422421
## Version 0.2.1-20240903 (2024-09-03) ## {#version-20240903}
22432422

22442423
- make application of <{Location/iata}> and <{Location/uic}> more explicit

0 commit comments

Comments
 (0)