Skip to content

Commit

Permalink
Merge branch 'docs/dpp-tutorial' of https://github.com/eclipse-tractu…
Browse files Browse the repository at this point in the history 
…sx/digital-product-pass into docs/dpp-tutorial
  • Loading branch information
@saudkhan116
saudkhan116 committed May 16, 2024
2 parents 23ccdc7 + d344631 commit 917bb2f
Show file tree
Hide file tree
Showing 5 changed files with 607 additions and 90 deletions.
115 changes: 83 additions & 32 deletions dpp-tutorial/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,31 +55,41 @@ You are one of the suppliers from Company-X. To maintain your client, you are re

## Preparation

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

## Phase 1: Data Provision
Group name is defined like this:

```
dpp-<your number=page number right bit)-<sessionNumber>-partName
```

> [!NOTE]
> Session number will be provided by the coaches! There are three sessions, values from [1-3].
## Phase 1: Deployment

> [!NOTE]
> The deployment of the [Digital Product Passport application](./deployment.md) is not within the scope of the Workshop, as it has already been deployed for you.
## Phase 2: 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.

##### Duration: 45 mins

#### Step 1 - Create a Digital Product Pass
#### 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.
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 Guide"

#### Step 2 - Hosting JSON Using Postman
* Follow the tutorial on [How to create Aspect Model](./aspect-model.md)

* Create a new POST request in Postman. Paste the JSON content into the body section, and send the request to the given URL to host the JSON file.

#### Step 3 - Create a Digital Twin integrating the generated DPP as a submodel
#### 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"
* Follow the tutorial on [How to create a Digital Twin](./digital-twin-provision)

#### Step 4 - Upload the Digital Twin in the Digital Twin Registry
#### Step 3 - Upload the Digital Twin in the Digital Twin Registry

Provide the Digital Twin and its relations in the Digital Twin Registry.

Expand All @@ -88,42 +98,41 @@ Provide the Digital Twin and its relations in the Digital Twin Registry.
* Manufacturer Part ID
* Submodel Reference

#### Step 5 - Generate the QR Code
#### Step 4 - Generate the QR Code

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

#### Step 6 - Print the QR-Code
#### Step 5 - Print the QR-Code

Print the QR Code from the nearby printer and paste it in the specific Part in the Arena -X. Ensure that the QR code is securely attached and easily scannable. Test the scanning functionality to verify that the encoded information can be retrieved accurately.

Great! The data provisioning process has been successfully set up. It is now ready for data exchange within the dataspace. This means that all necessary configurations and integrations have been completed, ensuring efficient data sharing.

## Phase 2: Data Consumption

##### Duration: 45 mins

#### Step 1 - Digital Product Pass Application Deployment

* Access the virual Machine (VM) and follow the instructions from the workstream.
## Phase 3: Data Consumption

* Namespace creation - Each group will be allocated a Namespace.
In this phase, you as a consumer, will access the Digital Product Pass (DPP) consumer application and retrieve data from the network by either scanning a QR code or entering an ID.

* Deploy the application using Helm Charts
##### Duration: 45 mins

* Verify and access the deployment using your computer
#### Step 1 - Consumption - Access DPP Application

#### Step 2 - Consumption - Access application using Smartphone using IP address and Ports
* Follow the tutorial on [DPP Data Consumption](./data-consumption.md)

* Access the application using the provided credentials
* You can access the application by using URL and the credentials.

* Scan the QR code of your respective part.
* Scan the available QR Codes on the Car parts or provide the ID.

* Upon scanning, you will obtain the passport.
* Upon scanning, you will obtain the passport of the part.

* Access the UI of the passport to view its details.
* Access the UI of the passport to view its details.

#### Step 3 - Creating the Final Digital Product Passport (DPP) for the Whole Car
* Look for the Product Carbon Footprint (PCF) information for each of the specific car part

* Calculate and add up the PCF values of all individual parts to obtain the aggregate Carbon Footprint value for the entire car.

#### Step 2 - Creating the Final Digital Product Passport (DPP) for the Whole Car

* Scan the QR codes from various parts of the car and record the Product Carbon Footprint (PCF) value of each specific part.
* Scan the available QR codes from various parts of the car and record the Product Carbon Footprint (PCF) value of each specific part.

* #### Compile the following information to create the DPP:

Expand All @@ -132,5 +141,47 @@ Print the QR Code from the nearby printer and paste it in the specific Part in t
* ID: Assign a unique identifier for the car.
* Aggregate Value: Calculate and add up the PCF values of all individual parts to obtain the aggregate carbon footprint value for the entire car.

For creating the Car passport use [this template](./resources/digital-twins/car-dt-template.json)

1º - Generate a new UUID4 in this [uuid generator page](https://www.uuidgenerator.net/version4) and copy it to the "id" and "global asset id" part.

2º - Paste it on "globalAssetId" with this format `urn:uuid:<your uuid>`

3º - As "id" add with this schema: `urn:uuid:<your group name>`

4º - Create Part Instance Id of your choice and add to `specificAssetIds["name=partInstanceId"].value

>[!IMPORTANT]
> Remember the part instance id for proving the QR code
5º -> For `manufacturerPartId` use MPI0012

6º -> Add the submodel as specified in the [digital-twin-provision](. digital-twin-provision) guide to the twin.

7º -> Upload your payload to the data service as specified in the [digital-twin-provision](. digital-twin-provision) guide.

8º -> Generate a QR code as specified in the [qr code guide](./qr-code.md)

9º -> Scan it and access it with the app.

10º -> Add your QR code to the board!

## Links of interest

| 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) |
| How to generate a QR code | [qr-code.md](./qr-code.md) |
| DPP Data Consumption | [data-consumption.md](./data-consumption.md) |

## NOTICE

This work is licensed under the [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode).

- SPDX-License-Identifier: CC-BY-4.0
- SPDX-FileCopyrightText: 2023, 2024 BMW AG
- SPDX-FileCopyrightText: 2023, 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
3 changes: 1 addition & 2 deletions dpp-tutorial/aspect-model.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,6 @@ Example:

![PCF](./resources/screenshots/pcf-update.png)


#### Where to substitute the data?

Follow this paths to find where the information is located.
Expand All @@ -122,7 +121,7 @@ Follow this paths to find where the information is located.
|Hazard Materials | critical.left (add elements to list) |
| Guarantee | lifespan (Add value and unit for garantee) |

Congratulations! You have successfully created your own digital product pass!
Congratulations! You have successfully created your own digital product pass!

> [!TIP]
> You can add more relavant data and personalized information at the digital product pass, follow the template and modify the data as you wish!
Expand Down
31 changes: 13 additions & 18 deletions dpp-tutorial/data-consumption.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,25 +22,24 @@
SPDX-License-Identifier: Apache-2.0
-->


# DPP Consumption Guide

This guide provides a simple way of accessing the digital product pass consumer application and retrieving data from the network scanning a QR code or introducing an ID.

DATA CONSUMER DPP APP ___________________
| ___________________ __________________ | | |
| ___________________ __________________ | | |
| | | | | | --> | |
| | DPP Frontend | <---> | DPP Backend | | | DATA PROVIDER |
| |___________________| |__________________| | <-- | |
| | |___________________|

| |___________________| |__________________| | <-- | |
| | |___________________|

## Prerequisites

You must have the following tools installed and configured:

- DPP Application with Backend and Frontend components deployed.
- Login credentials to the DPP Frontned component
- Login credentials to the DPP Frontend component
- Web Browser
- Catena-X Central Service Running (Federated IAM, Discovery Finder, BPN Discovery and EDC Discovery)

Expand All @@ -62,11 +61,11 @@ https://<dpp-hostname-url>/passport

```

And a login page from Catena-X will pop up. For doing the login follow this steps:
And a login page from Catena-X will pop up. To perform the login follow this steps:

### 1º Introduce Company Name

```
```
CX-Operator
```

Expand All @@ -78,14 +77,14 @@ CX-Operator
Username:
[email protected]
```

```
Pass:
tractusx-umbr3lla!
```

![test login](./resources/screenshots/test-login.png)


### 3º A Search by ID

Change the `<manufacturerPartId>` and `<partInstanceId>` to the actual values in the part specification.
Expand All @@ -108,8 +107,7 @@ Give permissions to the camera, and position the window over the QR code frame.

![QR code scanning](./resources/screenshots/qrcode-scanning.png)


### 5º Wait some seconds for the policy selection popup to appear
### 5º Wait a few seconds for the policy selection pop-up to appear

When the digital twin registries are being searched in the complete network, the digital product pass will call the following service to find where the digital twin registy with the digital twin data is located:

Expand All @@ -127,11 +125,10 @@ This steps are done:

- 5º -> Retrieve digital twin and find submodel for the digital product pass.

- 6º -> Query with the EDC Consumer the Catalog from the EDC Provider looking fro the asset
- 6º -> Query with the EDC Consumer the Catalog from the EDC Provider looking for the asset
- (This information is found in the Digital Twin)

Once the asset policy is found you will get a pop up more or less like this:

Once the asset policy is found you will get a pop-up similar to this one:

![Popup policy selection](./resources/screenshots/policy-selectionpopup.png)

Expand All @@ -143,7 +140,7 @@ Click on agree to accept the policy you have selected:

> [!IMPORTANT]
> The new Digital Product Pass version (v3.0.0) that will be released in R24.05 allows you to configure the policies in the Backend application.
> There is a [policy configuration guide](https://github.com/eclipse-tractusx/digital-product-pass/blob/main/docs/data-sovereignty/PolicyConfigGuide.md) that can help you understanding that better!
> There is a [policy configuration guide](https://github.com/eclipse-tractusx/digital-product-pass/blob/main/docs/data-sovereignty/PolicyConfigGuide.md) that can help you understanding this better!
### 7º Wait until contract negotiation is done

Expand All @@ -155,19 +152,17 @@ In some seconds it should start updating with the latest status of your applicat

![Visualization](./resources/screenshots/visualization.png)


#### Look for the PCF Information

![PCF Information](./resources/screenshots/pcf-info.png)


#### Check characteristics and many more!

![characteristics](./resources/screenshots/characteristics.png)

Congratulations! Now you are able to access the information regarding digital product passports and many more!

>[!TIP]
> [!TIP]
> Other models like the Battery Passport and the Transmission Passport are also available to be visualized in the app. You can follow the [CX-0096 Digital Product Pass Triangle Standard](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_Maerz_2024/CX-0096-TriangleForDigitalProductPass-v1.1.0.pdf) to configure the other models in the digital twin. For providing data read the [Data Provision Guide](data-provision.md)
## NOTICE
Expand Down
Loading

0 comments on commit 917bb2f

Please sign in to comment.