Skip to content

Commit

Permalink
docs: update pilot-testing readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@raimundo-henriques
raimundo-henriques committed Oct 2, 2024
1 parent 60cb034 commit a533749
Showing 1 changed file with 81 additions and 51 deletions.
132 changes: 81 additions & 51 deletions pilot-testing/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Pilot Testing
# Pilot and Real-World Testing

You are looking at documentation created for the iLEAP Project Piloting Phase.
You are looking at documentation created for the iLEAP Project Piloting and Real-World testing Phases.
The Piloting Phase is a 3-month period where the iLEAP Tech Specs are tested by Implementers in a real-world-like settings.
The Real-World Testing Phase will follow it and it is a 3-month period where the iLEAP Tech Specs are used in real-world settings.

The goal of the Piloting Phase is to ensure that the iLEAP Tech Specs are ready for real-world usage by Shippers, LSPs, and Carriers, etc.
The goal of the Piloting and Real-World Testing Phases is to ensure that the iLEAP Tech Specs are ready for real-world usage by Shippers, LSPs, and Carriers, etc.

This document provides an overview of the Piloting Phase, the timeline, key activities, and how to implement the iLEAP Tech Specs.
This document provides an overview of the Piloting and Real-World Testing Phases, the timeline, key activities, and how to implement the iLEAP Tech Specs.

Further instructions on how to implement and contribute to iLEAP can be found [here](https://sinefoundation.notion.site/iLEAP-Adoption-Guide-d036010d2c7547d99204ea87d79c060f?pvs=74)

# Terminology

Expand Down Expand Up @@ -34,35 +36,63 @@ We want to bring visibility into logistics emissions based on the ISO14083 and t
We identified as necessary for this:

1. the establishment of a community of Shippers, LSPs, Carriers, and software providers
2. the publication of the [iLEAP Tech Specs](https://sine-fdn.github.io/ileap-extension/) that everyone can implement, defining the necessary means for seamless data exchange (”interoperability”) among participants of the community
2. the publication of the [iLEAP Tech Specs](https://sine-fdn.github.io/ileap-extension/) that everyone can implement, defining the necessary means for seamless data exchange (”interoperability”) among participants of the community
3. [Piloting](#piloting-of-ileap) of above specification by the community to make the iLEAP Tech Specs ready for real-world usage

# Piloting of iLEAP

## Timeline / Roadmap

| When | What |
| --- | --- |
| May 7th, 2024 | Kick-Off of iLEAP Piloting |
| When | What |
| ------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| May 7th, 2024 | Kick-Off of iLEAP Piloting |
| Bi-weekly<br/> (ongoing until end of July) | Check-In of Implementers to give feedback and to coordinate with ongoing activities among each other;<br/> SINE + SFC will continously update the iLEAP Tech Specs as needed. |
| End of July | iLEAP Piloting finishes |
| Mid August | Incorporation of all feedback from iLEAP Piloting and subsequent publication of the “beta version” of the iLEAP Tech Specs |
| End of July | iLEAP Piloting finishes |
| Mid August | Incorporation of all feedback from iLEAP Piloting and subsequent publication of the “beta version” of the iLEAP Tech Specs |

## Key Activities

With "iLEAP Piloting" we mean three key activities:

1. Continuous implementation of the iLEAP Tech Specs by Implementers
1. Continuous implementation of the iLEAP Tech Specs by Implementers
2. Continuous interoperability testing between independent solutions / software implementing the iLEAP Tech Specs through logistics stakeholders (Shippers, LSPs, Carriers, etc.)
3. Collecting and incorporating feedback from above community to update the iLEAP Tech Specs

TL;DR: **iLEAP Piloting will begin in May 2024 and it will last for 3 months**
TL;DR: **iLEAP Piloting began in May 2024 and it lasted for 3 months**

## Interoperability Testing

Piloting will focus on testing the data flows between different parties (see below section on [Transactions](#transactions) for the technical details).
Piloting focused on testing the data flows between different parties (see below section on [Transactions](#transactions) for the technical details).

SFC + SINE will
SFC + SINE will

1. perform matchmaking between the parties to form complete chains, e.g. covering a carrier, LSP, and Shipper; etc.
2. support you if you have any (technical) Qs, etc.
3. provide you with technical information necessary for software development etc.

# Real-World Testing of iLEAP

| When | What |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| October, 2024 | Kick-Off of iLEAP Real-World Testing |
| Bi-weekly<br/> (ongoing) | Check-In of Implementers to give feedback and to coordinate with ongoing activities among each other;<br/> SINE + SFC will continously update the iLEAP Tech Specs as needed. |
| January, 2025 | iLEAP Real-World Testing finishes and iLEAP Tech Specs v1 are published |

## Key Activities

The Real-World Testing Phase will be a continuation of the Piloting:

1. Continuous implementation of the iLEAP Tech Specs by Implementers
2. Continuous interoperability testing between independent solutions / software implementing the iLEAP Tech Specs through logistics stakeholders (Shippers, LSPs, Carriers, etc.)
3. Collecting and incorporating feedback from above community to update the iLEAP Tech Specs

TL;DR: **iLEAP Real-World Testing Phase starts in October 2024 and will last for 3 months**

## Interoperability Testing

Piloting focused on testing the data flows between different parties (see below section on [Transactions](#transactions) for the technical details).

SFC + SINE will

1. perform matchmaking between the parties to form complete chains, e.g. covering a carrier, LSP, and Shipper; etc.
2. support you if you have any (technical) Qs, etc.
Expand All @@ -86,7 +116,7 @@ The data model defines how to encode data related to ISO14083 plus activity data

**Protocol**

It defines how the different IT Systems are supposed to exchange information among each other.
It defines how the different IT Systems are supposed to exchange information among each other.

To avoid redundant work, we agreed to use the protocol defined in the PACT Technical Specifications. This “PACT Protocol” is already implemented by a multitude of solutions providers. By relying on this protocol, interoperability with Shippers shall be asserted while minimizing the overall work for all participants.

Expand All @@ -95,80 +125,80 @@ To avoid redundant work, we agreed to use the protocol defined in the PACT Techn
The iLEAP Tech Specs define 3 transactions in [this chapter](https://sine-fdn.github.io/ileap-extension/#txns) (see below for an infographic):

1. **TCE Data Exchange**

This typically happens between e.g. a LSP and a Shipper.

Likewise, Carriers can also make TCE data available to an LSP (or a Shipper) if they are able to calculate TCEs (already).
If they are not, Carriers *can* make actual activity data available (see Transaction 3). If a carrier does not make such data available, the GLEC Framework defines additional options to calculate emission factors then – which can be either done by a Shipper, or typically through an LSP.
If they are not, Carriers *can* make actual activity data available (see Transaction 3). If a carrier does not make such data available, the GLEC Framework defines additional options to calculate emission factors then – which can be either done by a Shipper, or typically through an LSP.

In the latter case, the LSP can then make TCE data available to a shipper as already mentioned.
2. **TOC Data Exchange**
TCEs refer to TOCs to disclose emission intensities at a cluster-level (see ISO14083, GLEC Framework for further details). The TCE data model explicitly references TOCs but do not contain them.
That is, if a Shipper is interested in the TOC definition, related emissions intensities, etc. , the Shipper *can* request TOC data from its business partners.
Again, a TOC *can* be made available by any party (Carrier, LSP, etc.) from a technical standpoint.

2. **TOC and HOC Data Exchange**

TCEs refer to TOCs or HOCs to disclose emission intensities at a cluster-level (see ISO14083, GLEC Framework for further details). The TCE data model explicitly references TOCs or HOCs but do not contain them.

That is, if a Shipper is interested in the TOC or HOC definition, related emissions intensities, etc. , the Shipper *can* request TOC or HOC data from its business partners.

Again, a TOC or HOC *can* be made available by any party (Carrier, LSP, etc.) from a technical standpoint.

3. **Transport Activity Data Exchange**

Transport Activity Data Exchange allows e.g. a Carrier lacking the capabilities to calculate TCE or TOC-level data to disclose Activity Data to an LSP or Shipper.
Activity Data here is data that discloses distance, weight, and other attributes related to the energy (carrier) used etc. so that the party receiving Activity Data can derive emission and other values from it.

Activity Data here is data that discloses distance, weight, and other attributes related to the energy (carrier) used etc. so that the party receiving Activity Data can derive emission and other values from it.


![Data Transactions Covered in iLEAP](./Data_Transactions.png)

# Implementating the iLEAP Tech Specs

As an implementer of the iLEAP Tech Specs, you need to implement the PACT Technical Specification plus the iLEAP Data Model and iLEAP HTTP API. Several pointers with details are [given below](#implementation-roadmap). In addition to what you can find in this document, the iLEAP Tech Specs are more specific (and thorough) in what you need to implement. Take a look at [this chapter](https://sine-fdn.github.io/ileap-extension/#http-rest-api) for details.
As an implementer of the iLEAP Tech Specs, you need to implement the PACT Technical Specification plus the iLEAP Data Model and iLEAP HTTP API. Several pointers with details are [given below](#implementation-roadmap). In addition to what you can find in this document, the iLEAP Tech Specs are more specific (and thorough) in what you need to implement. Take a look at [this chapter](https://sine-fdn.github.io/ileap-extension/#http-rest-api) for details.

### Implementation Roadmap

As an implementer, you need to perform the following (as detailed [here](https://sine-fdn.github.io/ileap-extension/#http-rest-api)):

1. Implement the PACT Tech Specs covering the basic Data Model and HTTP API (see above for resources on this)
2. Implement the iLEAP Tech Specs:
1. Implementing the [TCE](https://wbcsd.github.io/tr/2024/data-exchange-protocol-20240410/) and [TOC](https://sine-fdn.github.io/ileap-extension/#dt-toc) Data Types and the ability to embed this information into the PACT Data Model. The latter is specified in the iLEAP Tech Specs Chapter “[Pathfinder Integration](https://sine-fdn.github.io/ileap-extension/#pcf-mapping)”. Examples are given in the [examples chapter](https://sine-fdn.github.io/ileap-extension/#appendix-a).
2. Implementing the exchange of [Transport Activity Data (TAD) Data Type](https://sine-fdn.github.io/ileap-extension/#dt-tad) plus related [HTTP API for the exchange of Transport Activity Data](https://sine-fdn.github.io/ileap-extension/#action-tad).
1. Implementing the [TCE](https://wbcsd.github.io/tr/2024/data-exchange-protocol-20240410/), [TOC](https://sine-fdn.github.io/ileap-extension/#dt-toc), and [HOC](https://sine-fdn.github.io/ileap-extension/#dt-hoc) Data Types and the ability to embed this information into the PACT Data Model. The latter is specified in the iLEAP Tech Specs Chapter “[Pathfinder Integration](https://sine-fdn.github.io/ileap-extension/#pcf-mapping)”. Examples are given in the [examples chapter](https://sine-fdn.github.io/ileap-extension/#appendix-a).
2. Implementing the exchange of [Transport Activity Data (TAD) Data Type](https://sine-fdn.github.io/ileap-extension/#dt-tad) plus related [HTTP API for the exchange of Transport Activity Data](https://sine-fdn.github.io/ileap-extension/#action-tad).

### Technical Support Material

Introduction documentation for the PACT Tech Specs can be found here:
Introduction documentation for the PACT Tech Specs can be found here:

[PACT Initiative Developer Documentation](https://wbcsd.github.io/introduction/)

The actual PACT Technical Specifications, written similarly to the iLEAP Tech Specs, can be found here:
The actual PACT Technical Specifications, written similarly to the iLEAP Tech Specs, can be found here:

[Technical Specifications for PCF Data Exchange (2.2.0)](https://wbcsd.github.io/tr/2024/data-exchange-protocol-20240410/)

As mentioned above, the iLEAP Tech Specs are defined here (and will be updated subsequently during piloting):

[iLEAP Technical Specifications (Version 0.1.0)](https://sine-fdn.github.io/ileap-extension/)

### Demo Endpoint
### iLEAP Demo API

In addition, there is a public demo endpoint which you can use for your own internal software-testing and development works: [https://api.ileap.sine.dev/](https://api.ileap.sine.dev/swagger-ui/index.html)
In addition, there is a public demo endpoint which you can use for your own internal software-testing and development works: [https://api.ileap.sine.dev/](https://api.ileap.sine.dev)
You can authenticate against above api using the following credentials:

<dl>
<dt>Username</dt>
<dd>`hello`</dd>
<dt>Password</dt>
<dd>`pathfinder`</dd>
</dl>
| client_id | client_secret | Data |
| ----------------------------- | ------------- | -------------------------------------------------------------- |
| `hello` | `pathfinder` | Global access to all sample data |
| `transport_service_user` | `ileap` | User is a (demo) shipper. Access to ShipmentFootprints and TAD |
| `transport_service_organizer` | `ileap` | User is (demo) LSP. Access to TOCs, HOCs, and TAD |
| `random_data` | `random_data` | Access to randomly generated iLEAP data |

Furthermore, you can find a Swagger UI related to above here: [https://api.ileap.sine.dev/swagger-ui/index.html](https://api.ileap.sine.dev/swagger-ui/index.html)

### Automated Conformance Testing
### ACT (Automated Conformance Testing)

SINE is implementing ACT, an Automated Conformance Testing tool that will allow you to test your implementation against the iLEAP Tech Specs.

SINE is implementing software to automate interoperability testing so that implementers can integrate this into their regular Continuous Integration & Development (CI/CD) processes.
The Web version of ACT is available at [https://act.sine.dev](https://act.sine.dev). We also aim to provide the possibility of integrating ACT in your CI/CD pipeline. Please find more information [here](https://github.com/sine-fdn/act).

Please get in touch with [Martin](mailto:[email protected]) or [Raimundo](mailto:[email protected]) for details.
Please note that ACT is currently in its beta phase. If you have any questions or feedback, please get in touch with [Martin](mailto:[email protected]) or [Raimundo](mailto:[email protected]).

### Demo Data

<aside>
💡 Will be provided by SINE and SFC shortly.
</aside>
Please use SINE's demo API to access the demo data (both sample data and randomly generated).

0 comments on commit a533749

Please sign in to comment.