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.

Sign up for GitHub

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

Fe documentation #109

Merged
merged 13 commits into from
Sep 18, 2023
Merged

Fe documentation #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
7b1ac83
Docker file update.
adityagajbhiye9 Sep 5, 2023
a486a5b
Docker image update for trivy scan
adityagajbhiye9 Sep 5, 2023
1d478c1
Update README.md
adityagajbhiye9 Sep 5, 2023
ff2da82
removed workflow.
adityagajbhiye9 Sep 6, 2023
9fb9dbb
dependencies updated
ajithsimons Sep 6, 2023
c83981b
Merge pull request #35 from catenax-ng/release-3.2
almadigabor Sep 6, 2023
77aeed1
bin/bash/ docker image fix
adityagajbhiye9 Sep 6, 2023
069d610
Merge branch 'eclipse-tractusx:main' into main
adityagajbhiye9 Sep 6, 2023
0ca8eb2
Merge branch 'main' of https://github.com/catenax-ng/tx-managed-simpl…
adityagajbhiye9 Sep 6, 2023
df6fac3
changelog update.
adityagajbhiye9 Sep 6, 2023
398fb6d
Merge pull request #36 from catenax-ng/release-3.2
almadigabor Sep 6, 2023
62fad6d
Arc 42 updated with PCF.
AjayRaturi123 Sep 11, 2023
4b2f7fd
Merge branch 'DST_PIP10_ITR3' into FE_Documentation
adityagajbhiye9 Sep 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 0 additions & 87 deletions .github/workflows/trivy-tx.yml
View file
Open in desktop

This file was deleted.

7 changes: 6 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

New features, fixed bugs, known defects and other noteworthy changes to each release of the Simple Data Exchanger Frontend.

## [2.1.0] - 2023-08-30
### Fixed
- docker base image changed .

## [2.1.0] - 2023-08-30
### Added
- warning text in access policy section.
Expand Down Expand Up @@ -188,7 +192,8 @@ New features, fixed bugs, known defects and other noteworthy changes to each rel
- Compliance with Catena-X Guidelines
- Integration with Digital Twin registry service.

[unreleased]: https://github.com/eclipse-tractusx/managed-simple-data-exchanger-frontend/compare/v2.1.0...main
[unreleased]: https://github.com/eclipse-tractusx/managed-simple-data-exchanger-frontend/compare/v2.1.1...main
[2.1.1]: https://github.com/eclipse-tractusx/managed-simple-data-exchanger-frontend/compare/v2.1.0...v2.1.1
[2.1.0]: https://github.com/eclipse-tractusx/managed-simple-data-exchanger-frontend/compare/v2.0.10...v2.0.11
[2.0.11]: https://github.com/eclipse-tractusx/managed-simple-data-exchanger-frontend/compare/v2.0.10...v2.0.11
[2.0.10]: https://github.com/eclipse-tractusx/managed-simple-data-exchanger-frontend/compare/2.0.9...v2.0.10
Expand Down
5 changes: 3 additions & 2 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,6 @@ RUN chmod ug+rwx /usr/share/nginx/html/
EXPOSE 8080
USER 101
# Start Nginx server
CMD ["nginx", "-g", "daemon off;"]
#CMD ["/bin/bash", "-c", "/usr/share/nginx/html/env.sh && nginx -g \"daemon off;\""]

CMD ["/bin/sh", "-c", "/usr/share/nginx/html/env.sh && nginx -g \"daemon off;\""]
#CMD ["nginx", "-g", "daemon off;"]
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Eclipse Tractus-X product(s) installed within the image:
- Project license: [Apache License, Version 2.0] https://github.com/eclipse-tractusx/managed-simple-data-exchanger-backend/blob/main/LICENSE

**Used base image**
- [nginxinc/nginx-unprivileged:1.25.1-perl]
- [nginxinc/nginx-unprivileged:alpine3.18-perl]
- Dockerfile: [nginxinc/nginx-unprivileged:alpine](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/Dockerfile-alpine.template)
- GitHub project: [https://github.com/nginxinc/docker-nginx-unprivileged](https://github.com/nginxinc/docker-nginx-unprivileged)
- DockerHub: [https://hub.docker.com/r/nginxinc/nginx-unprivileged](https://hub.docker.com/r/nginxinc/nginx-unprivileged)
Expand Down
15 changes: 15 additions & 0 deletions docs/Arc42.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,6 +303,21 @@ Backend API Swagger-ui : [https://dft-api.int.demo.catena-x.net/api/swagger-ui/i
| StoreSingleLevelUsageAsBuilt | Store the Single Level Usage As Built in the SDE database. | 5 |
<br />

#### **PCF - Product Carbon Footprint**
<br /><br /><img src="images/product_carbon_footprint.png" height="60%" width="60%" /><br /><br />

| Module | Description | Execution order |
|----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|
| CreatePCFAspect | Used when PCF upload is created on the frontend using the table or submit the <br>json request with the content.<br>It sets the row position and process id in each item. | 0 |
| MapToPCFAspect | Convert the string that came on the uploaded CSV file to PCFAspect dto.<br><br>It also validate the mandatory fields are fulfilled. | 1 |
| MapFromPCFAspectRequest | Convert from the PCFAspectRequest object to PCFAspect dto.<br><br>It also validate the mandatory fields are fulfilled. | 1 |
| GenerateUUId | Check if PCF have a non null and non blank Id. If not it will generate one UUID with the defined prefix "urn:uuid:". | 2 |
| DigitalTwinsPCFAspect | Do the interface in the Digital Twins registry.<br><br> - It will lookup for shells and if no shell is found it will create one;<br> - If a single shell exists for the given key it will use that shell;<br> - If multiple shell are found it will throw an exception;<br> - It will lookup for sub models. If no sub model is found it will create one; <br> - If a sub model is found it will set the PCF with that sub model id;<br><br>Please note that a shell can only have two sub models at the time being. | 3 |
| EDCPCFAspect | Do the interface in the Eclipse Data Connector (EDC)<br><br> - It will lookup for a previous registry;<br> - If no registry is found it will create an asset plus a default policy and contract definition; | 4 |
| BPNDiscovery | Push Key of Aspect asset into the BPN Discovery for DDTR lookup. | 5 |
| StorePCF | Store the PCF Aspect in the SDE database. | 6 |
<br />

### **Whitebox Overall System**

#### **App routing**
Expand Down
Binary file added docs/images/product_carbon_footprint.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/user-guide/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LIC
- [Single Level Bom As Planned](#single-level-bom-as-planned)
- [Part Site Information As Planned](#part-site-information-as-planned)
- [Single Level Usage As Built](#single-level-usage-as-built)
- [Product Carbon Footprint](#product-carbon-footprint)
- [Upload history](#upload-history)
- [Contracts](#provider-contracts)
- [Help](#help)
Expand Down Expand Up @@ -137,6 +138,7 @@ At the moment, Simple Data Exchanger supports data proving options for below lis
- Single Level Bom AsPlanned.
- Part Site Information AsPlanned.
- Single Level Usage AsBuilt.
- Product Carbon Footprint

You can click on the button "Choose a file" and select the proper CSV file present in your file system or you can just drag and drop your file in the drop area under upload file component.

Expand Down Expand Up @@ -183,6 +185,10 @@ This is the process of creating new data offer through SDE application by upload

<img src="images/sde-single-level-usage-table.png" height="60%" width="60%" />

#### Product Carbon Footprint

<img src="images/sde-product-carbon-footprint.png" height="60%" width="60%" />

You can add and submit multiple data offers via Manual entry option for particular submodel by clicking on "Add Row" button to bulk upload the multiple data offers in one go. Once you enter details in all of the required fields for a particular row, you need to select which offers we need to upload by ticking the checkboxes for the respective rows and then we need to click on "Next Step - Configure Policies" button to configure Access and Usage policies and then you need to click on Submit button from policy dialog to upload the data. You can upload the data for multiple submodels by selecting the respective submodel from the top level Select submodel dropdown.
We also can delete multiple rows by selecting which rows we want to delete and then click on Delete Row(s) button.

Expand Down
Binary file added docs/user-guide/images/sde-product-carbon-footprint.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.