Skip to content

Commit c982fba

Browse files
raimundo-henriquesraimundo-henriques
authored
Merge pull request #29 from sine-fdn/toc
feat: populate section on TOC integration in PACT data model
2 parents 88c4eba + d6f8b97 commit c982fba

File tree

1 file changed

+162
-6
lines changed

1 file changed

+162
-6
lines changed

‎specs/index.bs

+162-6
Original file line numberDiff line numberDiff line change
@@ -1733,13 +1733,13 @@ The list below contains the properties that were omitted for this reason.
17331733

17341734
### ServiceFootprint ### {#pcf-mapping-sf}
17351735

1736-
Note: This chaper refers to the PACT Data Model. See [[!PACTDX]] Chapter 4 for further details.
1736+
Note: This chapter refers to the PACT Data Model. See [[!PACTDX]] Chapter 4 for further details.
17371737

17381738
A ServiceFootprint CAN be integrated into the Pathfinder Data Model ([[!PACTDX]]) by storing a <{ShipmentFootprint}> as an extension (see [[!DATA-MODEL-EXTENSIONS]]) in a `ProductFootprint`.
17391739

1740-
For interoperability reasons, additional attributes of such a `ProductFootprint` SHOULD be derived from the <{ShipmentFootprint}>. This is specified in the table below.
1740+
For interoperability reasons, additional attributes of such a `ProductFootprint` SHOULD be derived from the <{ShipmentFootprint}>. This is specified in the [table](#pact-sf-mapping-table) below.
17411741

1742-
Note: Chapter [[#appendix-a-sf-example]] contains an example.
1742+
Note: Section [[#appendix-a-sf-example]] contains an example.
17431743

17441744
<figure id="pact-sf-mapping-table">
17451745
<table class="data">
@@ -1829,10 +1829,103 @@ Note: Chapter [[#appendix-a-sf-example]] contains an example.
18291829

18301830
### TOC ### {#pcf-mapping-toc}
18311831

1832-
Issue: this sections is still work in progress
1832+
Note: This chapter refers to the PACT Data Model. See [[!PACTDX]] Chapter 4 for further details.
1833+
1834+
A TOC CAN be integrated into the Pathfinder Data Model ([[!PACTDX]]) by storing a <{TOC}> as an
1835+
extension (see [[!DATA-MODEL-EXTENSIONS]]) in a `ProductFootprint`.
1836+
1837+
For interoperability reasons, several attributes of a `ProductFootprint` MUST be derived from the
1838+
<{TOC}>. This is specified in the [table](#pact-toc-mapping-table) below.
1839+
1840+
Note: Section [[#appendix-a-toc-example]] contains an example.
1841+
1842+
<figure id="pact-toc-mapping-table">
1843+
<table class="data">
1844+
<thead>
1845+
<tr>
1846+
<th>PACT Data Type
1847+
<th>Property
1848+
<th>Value Derivation
1849+
<tbody>
1850+
<tr>
1851+
<td>ProductFootprint
1852+
<td>`productIds`
1853+
<td>
1854+
MUST contain the TOC ID <{TOC/tocId}>, encoded as
1855+
: `urn:pathfinder:product:customcode:vendor-assigned:<toc id>`
1856+
:: in case the [=transport service organizer=] has assigned a toc id, or
1857+
: `urn:pathfinder:product:customcode:buyer-assigned:<toc id>`
1858+
:: in case the [=transport service user=] has assigned a toc id
1859+
1860+
Note: `productIds` can contain multiple entries. If multiple or different
1861+
toc ids are assigned to a single TOC, `productIds` CAN contain
1862+
all of them.
1863+
<tr>
1864+
<td>ProductFootprint
1865+
<td>`productCategoryCpc`
1866+
<td>
1867+
MUST be set to the CPC code of logistics services (`83117`).
1868+
1869+
<tr>
1870+
<td>CarbonFootprint
1871+
<td>`declaredUnit`
1872+
<td>
1873+
MUST be set to `ton kilometer` conforming with the Pathfinder Tech Specs.
1874+
1875+
See [[!PACTDX]] Chapter 4 for further details.
1876+
1877+
<tr>
1878+
<td>CarbonFootprint
1879+
<td>`unitaryProductAmount`
1880+
<td>
1881+
SHOULD be set to `"1"` so that the ProductFootprint represents the emissions per ton kilometer of the TOC.
1882+
1883+
<tr>
1884+
<td>CarbonFootprint
1885+
<td>`pCfExcludingBiogenic`
1886+
<td>
1887+
MUST be set to the logistics emissions intensity of the TOC, excluding biogenic emissions,
1888+
defined in <{TOC/co2eIntensityWTW }>.
1889+
1890+
<tr>
1891+
<td>CarbonFootprint
1892+
<td>`pCfIncludingBiogenic`
1893+
<td>
1894+
This property is OPTIONAL in the [[!PACTDX]] data Model.
1895+
1896+
It SHOULD be set to the logistics emissions intensity of the TOC,
1897+
including biogenic emissions, found in <{TOC/co2eIntensityWTW}>.
1898+
1899+
<tr>
1900+
<td>CarbonFootprint
1901+
<td>`fossilGhgEmissions`
1902+
<td>
1903+
see the specification for `pCfExcludingBiogenic` in this table
1904+
1905+
<tr>
1906+
<td>CarbonFootprint
1907+
<td>`packagingEmissionsIncluded`
1908+
<td>
1909+
see [[!PACTDX]] for further details
1910+
1911+
MUST be set to `false`.
1912+
1913+
<tr>
1914+
<td>CarbonFootprint
1915+
<td>`primaryDataShare`
1916+
<td>
1917+
The relative share of logistics emissions for which primary data has been used for the calculation.
1918+
1919+
See [[!PACTDX]] and the Pathfinder Framework ([[!PATHFINDER-FRAMEWORK]]) for further details.
1920+
</table>
1921+
<figcaption>Mapping of PACT Data Model properties to <{TOC}> properties</figcaption>
1922+
</figure>
18331923

18341924
# Appendix A: Example PCFs with iLEAP Data embedded # {#appendix-a}
18351925

1926+
Advisement: In both examples, the value of `dataSchema` is currently placeholder and should not be
1927+
taken as a link to the actual data schema. This will be updated as soon as possible.
1928+
18361929
## ShipmentFootprint example ## {#appendix-a-sf-example}
18371930

18381931
A Product Footprint with a <{ShipmentFootprint}> highlighted:
@@ -1860,7 +1953,7 @@ A Product Footprint with a <{ShipmentFootprint}> highlighted:
18601953
"fossilCarbonContent": "0.0",
18611954
"biogenicCarbonContent": "0.0",
18621955
"characterizationFactors": "AR6",
1863-
"ipccCharacterizationFactors": ["AR6"],
1956+
"ipccCharacterizationFactorsSources": ["AR6"],
18641957
"crossSectoralStandardsUsed": [ "GHG Protocol Product standard" ],
18651958
"productOrSectorSpecificRules": [],
18661959
"boundaryProcessesDescription": "SFC GLEC Framework-conforming (W2W CO2e emissions)",
@@ -1875,7 +1968,7 @@ A Product Footprint with a <{ShipmentFootprint}> highlighted:
18751968
"extensions": [
18761969
{
18771970
"specVersion": "2.0.0",
1878-
"dataSchema": "https://catalog.carbon-transparency.com/sfc-ileap/0.0.1/tce.json",
1971+
"dataSchema": "https://api.ileap.sine.dev/openapi.json",
18791972
"data": {
18801973
"mass": "87",
18811974
"shipmentId": "1237890",
@@ -1900,7 +1993,70 @@ A Product Footprint with a <{ShipmentFootprint}> highlighted:
19001993
</pre>
19011994
</div>
19021995

1996+
## TOC example ## {#appendix-a-toc-example}
19031997

1998+
A Product Footprint with a <{TOC}> highlighted:
1999+
2000+
<div class=example>
2001+
<pre highlight='json' line-highlight="37-54" line-numbers>
2002+
{
2003+
"id": "f3c04ec8-b33a-43b1-9fa7-d6a448fd60af",
2004+
"specVersion": "2.0.0",
2005+
"version": 0,
2006+
"created": "2022-05-22T21:47:32Z",
2007+
"status": "Active",
2008+
"companyName": "Super Duper Transport Co.",
2009+
"companyIds": [ "urn:epc:id:sgln:4063973.00000.8" ],
2010+
"productDescription": "Logistics emissions related to TOC with ID 4561230",
2011+
"productIds": [ "urn:pathfinder:product:customcode:vendor-assigned:4561230" ],
2012+
"productCategoryCpc": "83117",
2013+
"productNameCompany": "TOC with ID 4561230",
2014+
"comment": "",
2015+
"pcf": {
2016+
"declaredUnit": "ton kilometer",
2017+
"unitaryProductAmount": "1",
2018+
"pCfExcludingBiogenic": "3.6801",
2019+
"fossilGhgEmissions": "3.6801",
2020+
"fossilCarbonContent": "0.0",
2021+
"biogenicCarbonContent": "0.0",
2022+
"characterizationFactors": "AR6",
2023+
"ipccCharacterizationFactorsSources": ["AR6"],
2024+
"crossSectoralStandardsUsed": [ "GHG Protocol Product standard" ],
2025+
"productOrSectorSpecificRules": [],
2026+
"boundaryProcessesDescription": "SFC GLEC Framework-conforming (W2W CO2e emissions)",
2027+
"referencePeriodStart": "2021-01-01T00:00:00Z",
2028+
"referencePeriodEnd": "2022-01-01T00:00:00Z",
2029+
"secondaryEmissionFactorSources": [ { "name": "Ecoinvent", "version": "3.9.1" } ],
2030+
"exemptedEmissionsPercent": 0.0,
2031+
"exemptedEmissionsDescription": "",
2032+
"packagingEmissionsIncluded": false,
2033+
"primaryDataShare": 56.12
2034+
},
2035+
"extensions": [
2036+
{
2037+
"specVersion": "2.0.0",
2038+
"dataSchema": "https://api.ileap.sine.dev/openapi.json",
2039+
"data": {
2040+
"tocId": "4561230",
2041+
"isVerified": true,
2042+
"isAccredited": true,
2043+
"mode": "Road",
2044+
"temperatureControl": "refrigerated",
2045+
"truckLoadingSequence": "FTL",
2046+
"energyCarriers": [
2047+
"energyCarrier": "Diesel",
2048+
"co2eIntensityWTW": "3.6801",
2049+
"co2eIntensityTTW": "3.2801"
2050+
],
2051+
"co2eIntensityWTW": "3.6801",
2052+
"co2eIntensityTTW": "3.2801",
2053+
"co2eIntensityThroughput": "tkm",
2054+
}
2055+
}
2056+
]
2057+
}
2058+
</pre>
2059+
</div>
19042060

19052061
<pre class=biblio>
19062062
{

0 commit comments

Comments
 (0)