Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added the Explorer Path to the DPP-Verification tutorial for the Tractus-X Community Days #457

Merged
merged 12 commits into from
Dec 4, 2024
Merged
2 changes: 1 addition & 1 deletion .github/workflows/trufflehog.yml
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ jobs:
with:
path: ./ # Scan the entire repository
base: "${{ github.event.repository.default_branch }}" # Set base branch for comparison (pull requests)
extra_args: --filter-entropy=4 --results=verified,unknown --debug
extra_args: --filter-entropy=4 --results=verified,unknown --debug --only-verified

- name: Scan Results Status
if: steps.trufflehog.outcome == 'failure'
Expand Down
1 change: 1 addition & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,6 @@ The following people have contributed to this repository:
* Muhammad Saud Khan, CGI, https://github.com/saudkhan116
* Mathias Brunkow Moser, CGI, https://github.com/matbmoser
* Diogo Parracho, CGI, https://github.com/dsrparracho
* Erik Lebedkin, CGI, https://github.com/ELebedkin

Please add yourself to this list, if you contribute to the content.
18 changes: 9 additions & 9 deletions DEPENDENCIES_BACKEND
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
maven/mavencentral/ch.qos.logback/logback-classic/1.5.7, EPL-1.0 AND LGPL-2.1-only, approved, #15279
maven/mavencentral/ch.qos.logback/logback-core/1.5.7, EPL-1.0 AND LGPL-2.1-only, approved, #15210
maven/mavencentral/com.fasterxml.jackson.core/jackson-annotations/2.17.2, Apache-2.0, approved, #13672
maven/mavencentral/com.fasterxml.jackson.core/jackson-core/2.17.2, , approved, #13665
maven/mavencentral/com.fasterxml.jackson.core/jackson-core/2.17.2, Apache-2.0 AND MIT, approved, #13665
maven/mavencentral/com.fasterxml.jackson.core/jackson-databind/2.17.2, Apache-2.0, approved, #13671
maven/mavencentral/com.fasterxml.jackson.dataformat/jackson-dataformat-yaml/2.17.2, Apache-2.0, approved, #13669
maven/mavencentral/com.fasterxml.jackson.datatype/jackson-datatype-jdk8/2.17.2, Apache-2.0, approved, #15117
maven/mavencentral/com.fasterxml.jackson.datatype/jackson-datatype-jsr310/2.17.2, Apache-2.0, approved, #14160
maven/mavencentral/com.fasterxml.jackson.module/jackson-module-parameter-names/2.17.2, Apache-2.0, approved, #15122
maven/mavencentral/com.github.stephenc.jcip/jcip-annotations/1.0-1, Apache-2.0, approved, CQ21949
maven/mavencentral/com.google.code.findbugs/jsr305/3.0.2, CC-BY-2.5, approved, #15220
maven/mavencentral/com.google.code.findbugs/jsr305/3.0.2, Apache-2.0 and CC-BY-2.5, approved, #15220
maven/mavencentral/com.google.code.gson/gson/2.11.0, Apache-2.0, approved, #14820
maven/mavencentral/com.google.errorprone/error_prone_annotations/2.26.1, Apache-2.0, approved, #13657
maven/mavencentral/com.google.guava/failureaccess/1.0.2, Apache-2.0, approved, CQ22654
Expand Down Expand Up @@ -88,15 +88,15 @@ maven/mavencentral/org.springdoc/springdoc-openapi-starter-webmvc-ui/2.5.0, Apac
maven/mavencentral/org.springframework.boot/spring-boot-autoconfigure/3.3.3, Apache-2.0, approved, clearlydefined
maven/mavencentral/org.springframework.boot/spring-boot-starter-data-rest/3.3.3, Apache-2.0, approved, clearlydefined
maven/mavencentral/org.springframework.boot/spring-boot-starter-json/3.3.3, Apache-2.0, approved, clearlydefined
maven/mavencentral/org.springframework.boot/spring-boot-starter-logging/3.3.3, Apache-2.0, approved, clearlydefined
maven/mavencentral/org.springframework.boot/spring-boot-starter-logging/3.3.3, Apache-2.0, approved, #16886
maven/mavencentral/org.springframework.boot/spring-boot-starter-oauth2-client/3.3.3, Apache-2.0, approved, clearlydefined
maven/mavencentral/org.springframework.boot/spring-boot-starter-reactor-netty/3.3.3, Apache-2.0, approved, clearlydefined
maven/mavencentral/org.springframework.boot/spring-boot-starter-security/3.0.2, Apache-2.0, approved, #7329
maven/mavencentral/org.springframework.boot/spring-boot-starter-tomcat/3.3.3, Apache-2.0, approved, clearlydefined
maven/mavencentral/org.springframework.boot/spring-boot-starter-web/3.3.3, Apache-2.0, approved, clearlydefined
maven/mavencentral/org.springframework.boot/spring-boot-starter-web/3.3.3, Apache-2.0, approved, #16893
maven/mavencentral/org.springframework.boot/spring-boot-starter-webflux/3.3.3, Apache-2.0, approved, clearlydefined
maven/mavencentral/org.springframework.boot/spring-boot-starter/3.3.3, Apache-2.0, approved, clearlydefined
maven/mavencentral/org.springframework.boot/spring-boot/3.3.3, Apache-2.0, approved, clearlydefined
maven/mavencentral/org.springframework.boot/spring-boot-starter/3.3.3, Apache-2.0, approved, #16895
maven/mavencentral/org.springframework.boot/spring-boot/3.3.3, Apache-2.0, approved, #16883
maven/mavencentral/org.springframework.cloud/spring-cloud-commons/3.1.5, Apache-2.0, approved, #4726
maven/mavencentral/org.springframework.cloud/spring-cloud-context/3.1.5, Apache-2.0, approved, #4722
maven/mavencentral/org.springframework.cloud/spring-cloud-starter-bootstrap/3.1.5, Apache-2.0, approved, clearlydefined
Expand All @@ -109,9 +109,9 @@ maven/mavencentral/org.springframework.plugin/spring-plugin-core/3.0.0, Apache-2
maven/mavencentral/org.springframework.security/spring-security-config/6.3.3, Apache-2.0, approved, clearlydefined
maven/mavencentral/org.springframework.security/spring-security-core/6.3.3, Apache-2.0, approved, clearlydefined
maven/mavencentral/org.springframework.security/spring-security-crypto/6.3.3, Apache-2.0, approved, clearlydefined
maven/mavencentral/org.springframework.security/spring-security-oauth2-client/6.3.3, Apache-2.0, approved, clearlydefined
maven/mavencentral/org.springframework.security/spring-security-oauth2-core/6.3.3, Apache-2.0, approved, clearlydefined
maven/mavencentral/org.springframework.security/spring-security-oauth2-jose/6.3.3, Apache-2.0, approved, clearlydefined
maven/mavencentral/org.springframework.security/spring-security-oauth2-client/6.3.3, Apache-2.0, approved, #16891
maven/mavencentral/org.springframework.security/spring-security-oauth2-core/6.3.3, Apache-2.0, approved, #16892
maven/mavencentral/org.springframework.security/spring-security-oauth2-jose/6.3.3, Apache-2.0, approved, #16884
maven/mavencentral/org.springframework.security/spring-security-rsa/1.0.11.RELEASE, Apache-2.0, approved, CQ20647
maven/mavencentral/org.springframework.security/spring-security-web/6.3.3, Apache-2.0, approved, clearlydefined
maven/mavencentral/org.springframework.session/spring-session-core/3.3.2, Apache-2.0, approved, #15119
Expand Down
52 changes: 41 additions & 11 deletions dpp-tutorial/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ SPDX-License-Identifier: CC-BY-4.0
#######################################################################
-->

<div align=right><img height=200 src="../docs/media/dpp-tx-logo.png"/>&nbsp;&nbsp;<h1>Tractus-X​ Digital Product Passport​ Workstream​</h1><h4>Second Tractus-X Community Days - 16, 17 May 2024 - Stuttgart</h4></div>
<div align=right><img height=200 src="../docs/media/dpp-tx-logo.png"/>&nbsp;&nbsp;<h1>Tractus-X​ Digital Product Passport​ Workstream​</h1><h4>Third Tractus-X Community Days - 5,6 December 2024 - Stuttgart</h4></div>


## Description
Expand Down Expand Up @@ -55,30 +55,61 @@ You are one of the suppliers from Company-X. To maintain your client, you are re

Split into groups of five individuals, ensuring each group receives a sheet of paper containing a distinct Part from the [test-data](./resources/test-data/carParts.json).


> [!Caution]
> Please dont change the given templates for digital twin, only change the provided placeholders

For the tutorial, two distinct paths are available: the Explorer Path and the Builders Path, each tailored to different groups:

<div style="display: flex; justify-content: center; align-items: center; gap: 10px;">
<a href="./explorer-path.md">
<img src="./resources/screenshots/explorers.png" alt="explorers path" style="width: 30%;">
</a>
<a href="./builder-path.md">
<img src="./resources/screenshots/builders.png" alt="builders path" style="width: 30%;">
</a>
</div>

### 1. Explorer Path:

This path is ideal for individuals who aim to gain a high-level understanding of the overall logic and processes. It’s particularly suitable for business partners, decision-makers, or anyone interested in a functional overview.

- In this path, you will download pre-prepared requests, modify them, and execute them using Insomnia.
- This approach focuses on simplicity and provides an accessible introduction to the workflow.

&rarr; The Explorer Path can be accessed [here](./explorer-path.md)

### 2. Builders Path

This path is designed for technically inclined participants who want to dive deeper into the details.

- Clone the repository, follow the instructions in the ReadMe.md file, and navigate through various steps.
- Execute the HTTP requests directly via the terminal (Windows/Mac/Linux).
- This approach offers an in-depth exploration of the technical communication.

&rarr; The Builders Path can be accessed [here](./builder-path.md)

## Overview

## Phase 1: Data Provision

In this Phase, you as a provider will create a Digital Product Passport of a spectific Part of the Arena-X Car. For this phase, you can use your own computer through Visual Studio Code / Notepad ++ or a given Virtual Machine.
In this Phase, you as a provider will create a Digital Product Passport of a specific Part of the Arena-X Car. For this phase, you can use your own computer through Visual Studio Code / Notepad ++ or a given Virtual Machine.

##### Duration: 45 mins

The following steps provide a concise overview of the entire tutorial process, which you will primarily complete using the explorers or the developer path

#### Step 1 - Create a Digital Product Passport (DPP)

In this step, you'll create the Digital Product Passport (DPP) by utilizing data from the Product Carbon Footprint and specifications of a specific car part from the Arena.

* Follow the tutorial on [How to create Aspect Model](./aspect-model.md)

#### Step 2 - Create a Digital Twin integrating the generated DPP as a submodel

In this step, you will create a Digital Twin of your provided Car part.

* Follow the tutorial on [How to create a Digital Twin](./digital-twin-provision.md)

#### Step 3 - Generate the QR Code

From this point onward, follow the steps regardless of the path you chose earlier.

* Follow the tutorial on [How to generate a QR code](./qr-code.md)

#### Step 4 - Print the QR-Code
Expand Down Expand Up @@ -169,10 +200,10 @@ Congratulations! You have completed the E2E Journey for Digital Product Pass
| How to Guides | Link |
| -------- | ----- |
| How to deploy DPP Application | [deployment.md](./deployment.md) |
| How to create Aspect Model | [aspect-model.md](./aspect-model.md) |
| How to create a Digital Twin | [digital-twin-provision](.digital-twin-provision.md) |
| How to generate a QR code | [qr-code.md](./qr-code.md) |
| DPP Data Consumption | [data-consumption.md](./data-consumption.md) |
| Explorer Path | [explorer-path](./explorer-path.md) |
| Builder Path | [builder-path](./builder-path.md) |

## NOTICE

Expand All @@ -182,5 +213,4 @@ This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses
- SPDX-FileCopyrightText: 2024 BMW AG
- SPDX-FileCopyrightText: 2024 CGI Deutschland B.V. & Co. KG
- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/digital-product-pass

- Source URL: https://github.com/eclipse-tractusx/digital-product-pass
137 changes: 0 additions & 137 deletions dpp-tutorial/aspect-model.md

This file was deleted.

Loading
Loading