Merge pull request #208 from catenax-ng/release/v2.1.0/user-manual

[ 22° ] - Release/v2.1.0/user manual: update user manual and added policy selection screenshots

CHANGELOG.md

@@ -25,6 +25,42 @@
 
 The changelog format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+
+## [released]
+## [v2.1.0] - 02-02-2024
+## Added
+- Added policyId parameter to the `/agree` api.
+- Added mechanism to get a policy by id from a catalog contract
+- Added frontend logic to call the `/decline` and `/cancel` backend APIs
+- Added reload option in case of error
+- Added/fixed logging of the Digital Twin Registry Contracts and which policy was selected (Data Souverenighty improvement)
+- Added util method to move files from one path to another
+- Added functionality to treat more than one policy and more than one contract, allowing user to decide
+- Added safety functionalities to make sure that the contract selected is correct
+- Added Policy selector when autosign is not enabled
+- Added Contract JSON details display
+- Added Agree/Decline button for contract/policy
+- Added fixes in backend and frontend integration
+- Added pydoc comments to the getPassport.py
+- Added access-token parameter to authorize the APIs without providing username/password and company
+
+
+## Updated
+- Updated versions from container base images
+- Adjusted the non root user ids in Dockerfiles and dpp helm chart configurations
+- Updated diagrams in Arc42, Data Retrieval Guide to editable drawio svgs
+- [BRAKING CHANGE] Renamed API from **sign** to negotiate  **/agree**
+- Bumped Vite to version `>=4.5.2`
+- Updated the frontend to allow the **AutoSigning** of contracts.
+- Optimized temporary directory logging of the DTR negotiation
+- Updated logging and readme
+- Updated license header
+- Updated user manual readme by adding the policy selection screenshots
+
+
+## Issues Fixed
+- Fixed issue related to `sleepy` EDCs, allowing the backend to re-request the contract negotiation when the EDC does not respond.
+
 ## [released]
 ## [v2.0.3] - 02-02-2024
 ## Added

README.md

@@ -41,6 +41,7 @@ In particular, the appliction is used to access the battery passport data provid
 <pre id="app-version"><a href="https://github.com/eclipse-tractusx/digital-product-pass/releases/tag/v2.1.0">v2.1.0</a></pre>
 
 
+
 ## Application Preview
 
 Here is a preview from the DPP App UI, where we visualize a test battery passport in this case.

docs/RELEASE_USER.md

@@ -24,9 +24,26 @@
 # Release Notes Digital Product Pass Application
 User friendly relase notes without especific technical details.
 
+**February 02 2024 (Version 2.1.0)**
+*02.02.2024*
+
+### Added
+#### Added Support for more than one Policy and Contract in the Backend
+The backend is now able to handle multiple policies and multiple contracts, allowing the user to select one specific policy if the configuration.
+
+#### Added frontend decline/agree functionality
+Now the frotend is able to show the user the option of "agreeing" or "declining" a contract based on the policy. They are able to select a contract and policy.
+
+### Updated
+#### Refactored Data Retrieval Script
+Refactored the script that retrieves passports to be able to interacturate with the new backend implementation. Upgraded the script documentation to make it more understandable and clear for the user that is using it
+
+#### Updated user manual explanation
+Added explanation for agree and decline functionality in the user manual that explains how the user can choose a policy and interactuate with the new frontend implementation.
+
 **February 02 2024 (Version 2.0.3)**
 *02.02.2024*
- 
+
 ### Updated
 #### Updated documentation and business statement
 Updated the user manual to reflect the latests changes
@@ -35,18 +52,16 @@ The business statement was also updated to reflect the latest functionalities fr
 
 **February 02 2024 (Version 2.0.2)**
 *02.02.2024*
-
 ### Added
 #### English and German translations enabled in the application
 Now the application is able to visualize the texts in more than one language.
 The german language selection is added to the application.
-
-#### Digital Product Pass version v2.0.0
-The application now supports the version `v2.0.0` of the Digital Product Pass Aspect.
-This deprecates the version `v1.0.0` of the passport aspect.
 
+#### Digital Product Pass version v2.0.0
+The application now supports the version v2.0.0 of the Digital Product Pass Aspect.
+This deprecates the version v1.0.0 of the passport aspect.
 
-**January 04 2024 (Version 2.0.0)**
+**January 04 2024 (Version 2.0.1)**
 *03.01.2024*
 
 ### Added

docs/user manual/User Manual Product Viewer App.md

@@ -84,10 +84,44 @@ If questions arise, you can access the Catena-X Helpdesk through clicking on "He
 
  After requesting data via one of the [product search functions](#search-for-a-product-passport), 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:
 
+
+### Autosign feature
+
+#### Enable Autosign:
+If Autosign setting is enabled, the first contract policy is always choosen as shown in below screenshot.
+The passport is shown to the user.
+
 </br></br>
 ![Loading Product Pass](./images/LoadingPass.png)
 </br></br>
 
+#### Disable Autosign:
+This feature requires user action. If disabled, the contract policy must be choosen by the user from the popup menu.
+
+</br></br>
+![Before Contract Policy Selection](./images/BeforePolicySelection.png)
+</br></br>
+
+</br></br>
+![Agree Contract policy](./images/AgreePolicy.png)
+</br></br>
+
+</br></br>
+![View Contract Policy](./images/ViewPolicy.png)
+</br></br>
+
+</br></br>
+![After Contract Policy Selection](./images/AfterPolicySelection.png)
+</br></br>
+
+</br></br>
+![Decline Contract Policy](./images/DeclinePolicy.png)
+</br></br>
+
+
+</br></br>
+![Aspect Model Not Supported](./images/AspectNotSupported.png)
+</br></br>
 
 </br></br>
 ![Product Pass](./images/ProductPassport.png)

dpp-backend/charts/digital-product-pass-backend/README.md

@@ -4,6 +4,43 @@
 
 A Helm chart for Tractus-X Digital Product Pass Backend Kubernetes
 
+## TL;DR 
+
+### Install
+
+```bash
+cd backend/charts/digital-product-pass-backend
+helm install digital-product-pass-backend -f ./values.yaml -f ./values-int.yaml
+```
+
+> **NOTE**: This command will deploy the backend application.
+
+### Exposing ports
+
+Once the application is running, the certain ports need to be exposed to access the backend outside the Kubernetes cluster.
+
+### Get pod name
+Search for the application name:
+
+```bash
+kubectl get pods --no-headers |  awk '{if ($1 ~ "dpp-backend-*") print $1}'
+```
+Copy the pod name with the prefix `dpp-backend-*`
+
+### Port forwarding
+
+```bash
+kubectl port-forward dpp-backend-* 8888:8888
+```
+
+> **NOTE**: The default port set is `8888` however it can be changed in the configuration.
+
+### Check if the application is running
+
+Open the web browser with the following url to check the health status:
+```
+localhost:8888/health
+
 **Homepage:** <https://github.com/eclipse-tractusx/digital-product-pass/tree/main/dpp-backend/charts/digital-product-pass-backend>
 
 ## Source Code

dpp-backend/scripts/README.md

@@ -40,8 +40,8 @@ A command line python script to request for any aspect model data using the Digi
 - Export enabled/disabled option to export the requested aspect data to a json file
 - Logging to log intermediate retrieval status to a file for further backtracking/debugging/troubleshooting
 - The backend API and authorization server settings are configurable
-- Capable to handle exception and error messages+
-- When doing contract negotiation the first contract is always choosed
+- Capable to handle exception and error messages
+- When doing contract negotiation the first contract is always used
 
 ## TL;DR 
 - The default script configuration is provided in [Constants.py](./utilities/constants.py) and can be changed based on the authentication provider.