Deliverable 10.9: Early Adopters Interactive Training Manual Summary

This project has received funding from the European Union’s H2020 Programme under Grant Agreement No. 958448 WP10. Communication and Dissemination Task 10.6 Early Adopters Group Communications, Trainings and Closed Testing Deliverable 10.9 Early Adopters Interactive Training Manual Summary Ref. Ares(2025)4399702 - 02/06/2025 2 DISCLAIMER The opinion stated in this report reflects the opinion of the authors and not the opinion of the European Commission. All intellectual property rights are owned by CIRCTHREAD consortium members and are protected by the applicable laws. Reproduction is not authorised without prior written agreement. The commercial use of any information contained in this document may require a license from the owner of that information. ACKNOWLEDGEMENT This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement Nº 958448. 3 Project Data Project Acronym CircThread Project Title Building the Digital Thread for Circular Economy Product, Resource & Service Management Grant Agreement number 958448 Call identifier H2020-LCCI-2020-EASME-twostage Topic identifier CE-SC5-31-2020 Develop, implement and assess a circular economy-oriented product information management system for complex products from cradle to cradle Funding Scheme IA - Innovation action Project duration 48 months (From 1 June 2021) Coordinator FUNDACION CARTIF Website https:// CircThread.eu Deliverable Document Sheet Deliverable No. 10.9 Deliverable title Early Adopters Interactive Training Manual Description Linked to T10.9 WP No. WP10 Related task T10.6 – In the final year of the project based on the Active Stakeholders will be invited to become early adopters of the CircThread Platform, based on more intensive communications, platform usage trainings, and providing closed testing of the platform services. The task will deliver: i) Early Adopters group engagement, ii) live use case demonstrations organised by pilot cluster leads (CAR, WEEE (ERIO), SIM) in line with T7.2-T7.4 activities so as to showcase CircThread technologies to at least 300 stakeholders including 150 SMEs, 50 LE, 30 RTOs, 50 non-profits and 20 NGO’s, and attract interest in early adoption of the CircThread Platform, iii) Early adopters group trainings with at least 5 separate trainings to at least 30 out of 100 early adopters, vi) Closed Testing of the Platform by early adopters following the training sessions. Lead Beneficiary 9 - ECOW Author(s) Rembrandt Koppelaar (ECOW), Umut Mascioglu (Ekodenge) Contributor(s) Emre Yontem (ECOW), Yigit Yayalar (Ekodenge) Type R Dissemination L. Public Language English – GB Due Date 31/05/2025 Submission Date 03/06/2025 4 Version Action Owner Date V.0.1 Draft Table of Contents ECOW 5/05/2025 V.0.2 First draft of all chapters ECOW 23/05/2025 V.0.3 Internal Review & copy-edit ECOW + EKOD 27/05/2025 V.0.4 Updated Version ECOW 28/05/2025 V.0.5 Review for submission COMET + CARTIF 30/05/2025 V.1.0 Submitted deliverable ECOW + CARTIF 03/06/2025 5 TABLE OF CONTENTS Contents Executive Summary ............................................................................................................................ 7 1 Introduction .................................................................................................................................. 8 1.1 Context ........................................................................................................................................ 8 1.2 Audience ..................................................................................................................................... 8 1.3 Structure ..................................................................................................................................... 8 2 User Guidance for Training .................................................................................................... 9 2.1 Overview of guidance provided .......................................................................................... 9 2.2 General Platform Menu ....................................................................................................... 11 2.3 Profile Page Tutorial ............................................................................................................. 12 2.4 Product Models Tutorial...................................................................................................... 13 2.5 Platform Services Tutorial .................................................................................................. 14 2.6 Services Page Tutorial .......................................................................................................... 15 2.7 Product model page Tutorial.............................................................................................. 16 2.8 Search Page Tutorial ............................................................................................................. 17 2.9 Platform services admin page Tutorial ........................................................................... 18 2.10 Platform organisations admin page Tutorial ................................................................ 19 2.11 Platform providers admin page Tutorial ........................................................................ 20 2.12 Platform life cycle roles admin page Tutorial ............................................................... 21 3 API documentation for Software Developers ............................................................. 22 3.1 Overview of the documentation ....................................................................................... 22 3.2 Authorisation API documentation ................................................................................... 24 3.3 Product Model API documentation ................................................................................. 25 3.4 Services API documentation .............................................................................................. 30 4 Conclusions and Next steps ................................................................................................ 31 4.1 Conclusions .............................................................................................................................. 31 4.2 Next steps ................................................................................................................................. 31 6 TABLE OF FIGURES Figure 1. Menu items of the CircThread Platform that are publicly visible .............................. 9 Figure 2. Training sections in the CircThread Platform ................................................................ 10 Figure 3. Menu items screenshot of the CircThread Platform ................................................... 11 Figure 4. Overview of user profile page .............................................................................................. 12 Figure 5. Product Model Registration Page ...................................................................................... 13 Figure 6. Available platform services page ........................................................................................ 14 Figure 7. Overview of the GRETA service endpoints integrated in the CircThread Platform for orchestration ......................................................................................................................................... 15 Figure 8. Product Model Information Navigation Screen Example .......................................... 16 Figure 9. Product Model Search Page Screen ................................................................................... 17 Figure 10. Service registration screen for adding new services to a CircThread Platform Instance .......................................................................................................................................................... 18 Figure 11. Overview of role setting to organisations ..................................................................... 19 Figure 12. Overview of Digital product Passport provider registration screen ................... 20 Figure 13. Role assignment screen in the CircThread Platform ................................................. 21 Figure 14. Menu items of the CircThread Platform that are publicly visible ......................... 22 Figure 15. Overview of API Documentation Page .......................................................................... 23 Figure 16. Screen providing training for the API access token endpoint for IT platform authorisation ................................................................................................................................................ 24 Figure 17. Screen providing training for the password change endpoint accessible after authorisation ................................................................................................................................................ 24 Figure 18. Screen providing training for adding a new Product Model into the platform using a POST API endpoint. ..................................................................................................................... 25 Figure 19. Screen for updating a Product Model already existing in the platform using a PUT API endpoint. ...................................................................................................................................... 26 Figure 20. Screen for deleting a product model with the right authorisation using a DELETE API endpoint. ................................................................................................................................................ 27 Figure 21. Screen for returning a list of product models of a specific organisation using a GET API endpoint. ...................................................................................................................................... 28 Figure 22. Screen for returning all information for a product models using a GET API endpoint. ........................................................................................................................................................ 28 Figure 23. Screen for searching a list of product models agnostic of an organisation using a GET API endpoint. ...................................................................................................................................... 29 Figure 24. Screen for finding detailed information about a product model assuming its UUID is known using a GET API endpoint. ......................................................................................... 29 Figure 25. Screen for finding registered services on the CircThread Platform instance using a GET API Endpoint ........................................................................................................................ 30 Figure 26. Screen for finding a specific registered service assuming its ID is known using a GET API Endpoint ....................................................................................................................................... 30 7 EXECUTIVE SUMMARY CircThread seeks to make appliances like boilers and washing machines sustainable. To achieve this, we want to swiftly increase appliance lifespan, repairability and reuse. And ensure that products are properly recycled when they are no longer repairable. We are working on this challenge with more than 30 organisations, thanks to grant funding from the European Union under the H2020 programme. To solve this challenge, the consortium has developed a software platform for sharing critical information across the product life cycle of products. Tested in pilots for electrical appliances, the platform has been finalised and can equally be utilised for other sectors pending the integration of respective Digital Product Passport services and business logic. To enable information sharing based on traceability and digital decision support management between product designers, manufacturers, retailers, citizens, consumer organisations, repairers, collectors, producer responsibility organisations, and recyclers. Providing the potential to improve our ability to make better lifespan improvement, reuse and recycling decisions. The deliverable provides an overview of the training manual developed that is embedded in the CircThread Platform, released as an open platform at the end of the project, available through GitHub. The training manual encompasses all the developed areas of the platform as a self-serve explanation of all areas. It also includes API documentation for the integration of software services by developers. 8 1 INTRODUCTION 1.1 Context This deliverable serves to provide an overview of the training manual and API documentation at the end of the project, providing instructions for self-serve purposes. The manual information is also part of trainings organised during the project and in future deployments of the platform under the Circular Intelligence Association. 1.2 Audience This report is usable for a train the trainers approach for CircThread partners and for the management team of the CircThread Association beyond the project (Circular Intelligence Association). It also serves to inform the EU Research Executive Agency and the project reviewers of the works carried out. 1.3 Structure The deliverable is structured in three more chapters: • Chapter 2 describes the user guidance for training on the platform usage. • Chapter 3 describes the API documentation that was developed for software developers. • Chapter 4 provides for conclusions and next steps. 9 2 USER GUIDANCE FOR TRAINING 2.1 Overview of guidance provided The CircThread Platform provides guidance available through the public menu on how to utilise the platform. Guidance for the training manual is available through the button ‘Tutorial Documentation’ in the top menu bar (see Figure 1). Figure 1. Menu items of the CircThread Platform that are publicly visible. The area in the CircThread Platform provides for 11 training sections that outline how to navigate and use the CircThread Platform (see figure 2). These sections cover the following topics: • General Platform • Profile Page Tutorial • Product Models Tutorial • Platform Services Tutorial • Services Page Tutorial • Product model page Tutorial • Search Page Tutorial • Platform services admin page Tutorial • Platform organisations admin page Tutorial • Platform providers admin page Tutorial • Platform roles admin page Tutorial In the next section each of these self-serve training pages are outlined with their content. 16 2.7 Product model page Tutorial The page provides an overall description of how information about product models are viewed and information can be navigated. Providing an overview description, accompanied by a visualisation of the product model description page (See Figure 8 below). The current description is as follows: Both logged and non-logged in visitors can see this page. Product model pages provide the information regarding the product model record. If the product model has been externally added, users are given the option to redirect back to the digital product passport provider's page and to make passport queries. Users are provided with the option to view available services and the Meta Data Catalogue options. Figure 8. Product Model Information Navigation Screen Example. 17 2.8 Search Page Tutorial The page provides an overall description of how to search for product models registered in the platform. Providing an overview description, accompanied by a visualisation of the product model search screen (See Figure 9 below). The current description is as follows: Both logged and non-logged in visitors can see this page. You can search for any product model that has been saved on CircThread, these also include the ones that have been externally added via registered providers. The search function will look for the keyword entered in all of the properties of the product model records. You can also directly enter your keyword to the browser in the following format /search/{keyword}, which will return any relevant product model. You can also make a search on Tracid via passport code of a digital product passport, if the search doesn't fail, you can copy and download the search response. There are also several features available on the search table. The user may choose to view the product model, use the MetaData Catalogue feature, which is a work in progress, or if the product model was added externally, create an event request to the providers API endpoint by completing the pop-up. Figure 9. Product Model Search Page Screen. 18 2.9 Platform services admin page Tutorial The page provides an overall description of how platform services are managed by administrators in the platform after logging in. Providing an overview description, accompanied by a visualisation of services integration screen (See Figure 10 below). The current description is as follows: Only accounts with 'Admin' privileges can view the services page. You can add software services to be integrated into CircThread. These could be in the form of Iframe or API. You can also select to declare if the service needs authentication to be operable and must provide a relevant authentication url. Platform roles can also be assigned to these services so that users from organisations with the matching roles can use them. You can also simply delete a service by editing its status to 'DISABLED' and saving. If the software service is an API, you can also add method types and method endpoints, but parameters must be entered with the following format 'endpoint/{paramater}'. Figure 10. Service registration screen for adding new services to a CircThread Platform Instance. 19 2.10 Platform organisations admin page Tutorial The page provides an overall description of how organisations and their users and their roles are managed by administrators on the CircThread Platform after logging in. Providing an overview description, accompanied by a visualisation of changing users and assigning roles (See Figure 11 below). The current description is as follows: Only accounts with 'Admin' privileges can view the organisations page. You can add, edit and delete organisations within CircThread, you can also add or remove users to these organisations. Please keep in mind that you can't add the same user to other organisations. Roles can be assigned to organisations, which will be reflected on its users. Each organisation will have two keys, 'API Key' and 'API Secret'. These can be used to add external digital product passports to CircThread on a product model level. In order to achieve this, the external platform must be added as a provider in CircThread and on the external platform you must have the software functionality to use these keys to send your data to CircThread. Figure 11. Overview of role setting to organisations. 20 2.11 Platform providers admin page Tutorial The page provides an overall description of how Digital Product Passport providers are registered by a platform administrator after logging in. Providing an overview description, accompanied by a visualisation of the registration screen (See Figure 12 below). The current description is as follows: Only accounts with 'Admin' privileges can view the providers page. You can add, edit and delete providers on this page. These providers represent external platforms that can add their digital product passport information on the product model level into CircThread. The endpoint and API endpoint variables are necessary for certain features. The endpoint variable is used to redirect users to the original digital passport page if chosen, so an example full link would be: '{provider endpoint}{passport code of product model}'. The API endpoint is needed to utilize the event adding feature in the search screen. Figure 12. Overview of Digital product Passport provider registration screen. 21 2.12 Platform life cycle roles admin page Tutorial The page provides an overall description of how life cycle roles are adjusted by organisations after logging in. Providing an overview description, accompanied by a visualisation of the role assignment screen (See Figure 13 below). The current description is as follows: Only accounts with 'Admin' privileges can view the roles page. You can create roles and edit the names of existing roles within the platform in this page. These will be pushed to the Keycloak IDM running at the platform's server. In addition, you may also assign specific roles to services to enable roles-based utility to the registered services within the platform. Figure 13. Role assignment screen in the CircThread Platform. 22 3 API DOCUMENTATION FOR SOFTWARE DEVELOPERS 3.1 Overview of the documentation The CircThread Platform provides guidance available through the public menu for developers on how to automate information flows between services orchestrated through the CircThread Platform. Guidance for developers is available through the button ‘API Documentation’ in the top menu bar (see Figure 14). Figure 14. Menu items of the CircThread Platform that are publicly visible. The area in the CircThread Platform provides for 3 sections with at present 11 horizontal API GET, POST, DELETE and PUT endpoints that provide the basis for using the CircThread Platform for automating product information management (see figure 15). These sections cover the following topics: • Authorisation, including login and password changes. • Product Model, including product model additions, updating, retrieving, searching, and deletion. • Services, including retrieval of available services information. 23 Figure 15. Overview of API Documentation Page. 24 3.2 Authorisation API documentation The authorisation API documentation provides for two API endpoints to manage IT platform authorisation and password resets. The first endpoint provides for the creation of access tokens with user credentials, for automating IT access to the platform using a backend service setup (See Figure 16). The second endpoint provides for the possibility after obtaining an access token to reset and change a password for a group of users (see Figure 17). Figure 16. Screen providing training for the API access token endpoint for IT platform authorisation. Figure 17. Screen providing training for the password change endpoint accessible after authorisation. 25 3.3 Product Model API documentation The Product Model API section provides the means to manage product models in an automated manner from a manufacturer IT system that is connected to the CircThread Platform. To this end product models can be added, updated and deleted by an authorised operator (see Figure 18 to 20) with POST, PUT and DELETE API Endpoints. The user can also automate information searches at product model identification level, as well as to retrieve the information about a registered product model, using GET API endpoints in different approaches. This includes general searches, searches based on a specific product model identifier, or searches based on an organisation using a broad set of API endpoints (see Figure 20 to 25). Figure 18. Screen providing training for adding a new Product Model into the platform using a POST API endpoint.