This manual provides a step by step introduction on how to use the Product Pass Viewer app and gives an overview on its functionalities.
After opening the Digital Product Pass Viewer application on your computer or phone, login with your company's login credentials.
In case the user is not allowed to login because the Authorization configuration is enabled the user will received this error:
It can be because of two complementary causes:
- The user has not the same BPN number as the EDC connector
- The user has no roles associated with the application instance (which is configured in the portal)
In case you are allowed to acces the application and you get this error, please contact your administrator so he can add your account credentials at the portal for this instance. This can be done by editing your IAM configuration for the Digital Product Pass application obtained in the Marketplace.
The user can logout or go back to the portal by clicking in the buttons.
After logging in, you will be forwarded to the application's main menu. Here you can access three functions:
- Search for a Product Passport
- Adjust Settings and see Profile Information
- Access the Catena-X Helpdesk
The Main Menu provides two methods for searching for Product Passports. You can request information by:
- By entering a product ID manually or
- By scanning the product's QR code
Both options can be found in the center of the Main Menu's screen (1). Whenever you access the Main Menu, the manual product ID search will be displayed by default (1a). The search text contains the pattern separated by the colon(:) CX:<manufacturerPartId>:<serializedId> where CX is a prefix, <manufacturerPartId> is the part Id of the manufacturer, and <serializedId> is the Id of the product Example: CX:XYZ78901:X123456789012X12345678901234566. If the search format is not followed, an error would be displayed.
By clicking on the switch the back arrow button (1b), you activate the QR code scanner and the application will access your device camera, which you can then capture the QR code with.
NOTE: Please make sure that the camera permissions must be turned on from the browser, otherwise the QR code cannot be scanned and you have to use the Id manually (1a) as an alternative to retrieve the passport
Clicking on the blue avatar icon in the upper right corner of the Main Menu (2) opens a drop-down menu containing your profile information and language settings. In this tab you find your specific user information and assigned role (is any) within Catena-X (4), you can sign out from your account (5) or change the applications's language (6) as shown in the below screenshot. Currently. the application supports two different languages: English (EN) as a default language and German (DE) as a second language.
If you need any help or would like to know how to operate the digital product pass application and access its features, you can access the Catena-X Helpdesk through clicking on "Help" in the upper right corner of the Main Menu (3).
After requesting data via one of the product search functions, the information will start loading against the asset Id (7) as illustrated in the screenshot , showing the steps to retrieve the passport (9) and displayed on the screen once progress bar is loaded (8). An exemplary product passport of a high voltage battery can be seen below. It provides an overview on the product's history, technical specifications, its child components using the Item Relationship Service (IRS) and data exchange information:
If Autosign setting is enabled, the first contract policy is always choosen as shown in below screenshot. The passport is shown to the user as shown in a Passport Page.
This feature requires user action. If disabled, the contract policy must be choosen by the user from the popup menu during the loading process.
The sign feature basically signs the contract policy before the contract negotiation is done. The right contract policy must be selected by the user, otherwise the contract negotiation is aborted and user is returned back to the Main Menu.
In the Choose a policy dialog, there might be more than one policies listed. User needs to select the appriopriate one and click on the Agree button.
The policy shown to the user, is written in Open Digital Rights Language (ODRL), which is translated into a more visual interpretation. For more information consult Policy Interpretation
This section defines how the policy can be interpreted to make it more understandable. The contract policy contains two different constraints separted by OR logical operator against the defined asset Id in a target:
Example of policy content: A user or company can have access to this policy either they have Membership equals to active or FrameworkAgreemen.sustainability equals to active.
In case the user want to see more details from the policy, it can be done by clicking in "More Details" which will display a JSON tree, with the complete policy and contract available for deep inspection.
NOTE: The contract policy is always checked against the defined asset Id in a target field
The user accepts the right contract policy, and click on the Agree button which resumes the remaining negotiation and data transfer steps. In the end, the passport data is retrieved and displays to the user Passport Page.
If a user is not permitted to accept a particular policy from his company, the contract policy can be declined in this case. The user will be redirected to the Main Menu.
In case the application is not able to visualize the model version because it is deprecated, the user will see the following error. The user shall search for another passport in this case because it can not be visualized.
Here the application shows the digital passport of a product after going through all necessary steps, that have been made in previous sections.
Hereby, the information is divided into the following sections:
- Serialization Information
- Typology Information
- Metadata Information
- Components
- Characteristics
- Commercial
- Identification
- Sources
- Sustainability
- Operation
- Data Exchange Information
Each category can be accessed by clicking on its heading in the selection bar towards the middle of the product passport screen (10).
The application is capable to retrieve the information from the product's child components (if any) that can be seen in the Components section of the passport (11). Once the passport is loaded and displayed to the screen, the drilling down process of the requested product gets started (12) and retrieves the available information from the first level (depth: 1) of the child components. Ths process might take a while to complete (around 4-5 minutes) as it searches the relevant components from the IRS tool.
In the below figure, the product battery contains one child component (13) named as battery module and its passport can be accessed by clicking the small external arrow (14).
This work is licensed under the CC-BY-4.0.
- SPDX-License-Identifier: CC-BY-4.0
- SPDX-FileCopyrightText: 2022, 2024 BMW AG
- SPDX-FileCopyrightText: 2022, 2024 Henkel AG & Co KGaA
- SPDX-FileCopyrightText: 2023, 2024 CGI Deutschland B.V. & Co. KG
- SPDX-FileCopyrightText: 2023, 2024 Contributors to the Eclipse Foundation
- Source URL: https://github.com/eclipse-tractusx/digital-product-pass