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

chore(docs): docs and change log updated #64

Merged
merged 7 commits into from
Feb 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@

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

## [Unreleased]
### Changed
- New access and usage policies added
- Documents updated
### Fixed
- Axios library issue fixed
- Duration restriction removed.
- Purpose policy “ID 3.1 Trace” updated.
- Framework agreement added in Usage Policy.
- Help link linked to the release tag.
- Page blank issue during navigation fixed.

## [2.3.3] - 2023-12-06
### Changed
- build base image security fix.
Expand All @@ -12,6 +24,8 @@ New features, fixed bugs, known defects and other noteworthy changes to each rel
- Help link navigates to GitHub documentation of the “main” branch. Shall be linked to the release tag.

## [2.3.2] - 2023-12-01
### Fixed
- Axios library issue fixed
### Changed
- Bumped version to 2.3.2 for helm charts to match with backend release.

Expand Down
81 changes: 37 additions & 44 deletions docs/Arc42.md

Large diffs are not rendered by default.

Binary file removed docs/images/argocd-apps.png
Binary file not shown.
Binary file removed docs/images/argocd-sync-policy.png
Binary file not shown.
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/images/aspect_relationship_dft_data_pipeline.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/assembly-serial-json.png
Binary file not shown.
Binary file removed docs/images/batch-json.png
Binary file not shown.
Binary file removed docs/images/batch_dft_data_pipeline.png
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/images/batch_dft_data_pipeline.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/building-block-view.png
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/images/building-block-view.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/part_as_planned.png
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/images/part_as_planned.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/part_single_level_bom_json.png
Binary file not shown.
Binary file removed docs/images/part_site_information_as_planned.png
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/images/part_site_information_as_planned.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/product_carbon_footprint.png
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/images/product_carbon_footprint.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/images/serial_part_typization_dft_data_pipeline.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/single_level_bom_as_planned.png
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/images/single_level_bom_as_planned.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/single_level_usage_as_built.png
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/images/single_level_usage_as_built.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/solution-strategy.jpeg
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/images/solution-strategy.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
50 changes: 25 additions & 25 deletions docs/user-guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,17 +47,17 @@ This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LIC

### **Login**

<img src="images/catenax-login-org-select.png" height="60%" width="60%">
<img src="images/catenax-login-org-search.png" height="60%" width="60%">
<img src="images/catenax-keycloak-signin.png" height="60%" width="60%">
<img src="images/catenax-login-org-select.svg" height="60%" width="60%">
<img src="images/catenax-login-org-search.svg" height="60%" width="60%">
<img src="images/catenax-keycloak-signin.svg" height="60%" width="60%">

1. Open **S**imple **D**ata **E**xchanger application via the [URL](https://dft.int.demo.catena-x.net/) (recommended browser Google Chrome).
2. Select the organization from the list or search the organization by typing name in input textbox and select the organization from the search results to login to the Simple Data Exchanger application. After selecting the organization from the list, it will redirect to the CatenaX keycloak login page.
3. On Keycloak login page of the selected organization, enter login details i.e. Username or email and Password. Click on Sign In button to login to the Simple Data Exchanger application.

### **Logout**

<img src="images/sde-profile-menu.png" width="320"/>&nbsp;&nbsp;<img src="images/catenax-login-org-search.png" width="320">
<img src="images/sde-profile-menu.svg" width="320"/>&nbsp;&nbsp;<img src="images/catenax-login-org-search.svg" width="320">

1. On the header, click on the user avatar (top right).
2. On the menu click on "Logout".
Expand All @@ -71,14 +71,14 @@ SDE navigation is based on a header and a left-side menu.

## **Header**

<img src="images/sde-header.png" alt="SDE header"/>
<img src="images/sde-header.svg" alt="SDE header"/>

1. On the left side on the header, there is the Simple Data Exchanger header text.
2. On the right side of the header, there is a help link. When clicked, it will redirect the user to simple data exchanger user guide. And there is avatar of the logged-in user. When clicked, there are few information about the logged in user, Logout link and Language switching options will be visible.

## **Left-side menu**

<img src="images/sde-sidemenu.png" alt="SDE sidemenu" height="350"/>
<img src="images/sde-sidemenu.svg" alt="SDE sidemenu" height="350"/>

On the left side menu, it is possible to navigate the Simple Data Exchanger application by choosing each the following options / features:

Expand All @@ -102,7 +102,7 @@ On the left side menu, it is possible to navigate the Simple Data Exchanger appl

# **Home**

<img src="images/sde-home.png" height="60%" width="60%" />
<img src="images/sde-home.svg" height="60%" width="60%" />

After successful login, user will be redirected to this page by default in the Simple Data Exchanger application. This page contains the overview of the application and use cases selection.

Expand All @@ -125,7 +125,7 @@ This Create Data page combines all the Data provider options like:-

- ### Upload File

<img src="images/sde-create-data.png" height="60%" width="60%" />
<img src="images/sde-create-data.svg" height="60%" width="60%" />

You can upload CSV files of various supported Submodels.

Expand All @@ -142,7 +142,7 @@ At the moment, Simple Data Exchanger supports data proving options for below lis

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.

<img src="images/sde-configure-policy.png" height="60%" width="60%" />
<img src="images/sde-configure-policy.svg" height="60%" width="60%" />

After successful file upload of the supported file format i.e. CSV, the button "Next Step - Configure Policies" will be enabled and after clicking on the same, Policy selection dialog will be shown where we need to configure Access and Usage policy.

Expand All @@ -159,35 +159,35 @@ This is the process of creating new data offer through SDE application by upload

#### Serial Part

<img src="images/sde-serial-part-tabular.png" height="60%" width="60%" />
<img src="images/sde-serial-part-tabular.svg" height="60%" width="60%" />

#### Batch

<img src="images/sde-batch-tabular.png" height="60%" width="60%" />
<img src="images/sde-batch-tabular.svg" height="60%" width="60%" />

#### Single Level BoM AsBuilt

<img src="images/sde-assembly-tabular.png" height="60%" width="60%" />
<img src="images/sde-assembly-tabular.svg" height="60%" width="60%" />

#### Part AsPlanned

<img src="images/sde-part-planned-tabular.png" height="60%" width="60%" />
<img src="images/sde-part-planned-tabular.svg" height="60%" width="60%" />

#### Single Level Bom AsPlanned

<img src="images/sde-single-bom-tabular.png" height="60%" width="60%" />
<img src="images/sde-single-bom-tabular.svg" height="60%" width="60%" />

#### Part Site Information AsPlanned

<img src="images/sde-part-site-info-tabular.png" height="60%" width="60%" />
<img src="images/sde-part-site-info-tabular.svg" height="60%" width="60%" />

#### Single Level Usage AsBuilt

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

#### Product Carbon Footprint

<img src="images/sde-product-carbon-footprint.png" height="60%" width="60%" />
<img src="images/sde-product-carbon-footprint.svg" 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 All @@ -196,7 +196,7 @@ Then you need to configure Access and Usage policies by clicking on "Next Step -

## Upload history

<img src="images/sde-upload-history.png" height="60%" width="60%" />
<img src="images/sde-upload-history.svg" height="60%" width="60%" />

In this menu you can see the list of uploaded data offers.

Expand All @@ -219,11 +219,11 @@ We can fetch the updated data offers by manually clicking on Refresh button pres

User can see the detailed error logs during the upload data by clicking "View errors" link.

<img src="images/sde-upload-error-logs.png" height="60%" width="60%" />
<img src="images/sde-upload-error-logs.svg" height="60%" width="60%" />

## Provider Contracts

<img src="images/sde-provider-contracts.png" height="60%" width="60%" />
<img src="images/sde-provider-contracts.svg" height="60%" width="60%" />

This page contains an overview of the data exchange contracts your organization has with other Catena-X members to provide data.

Expand All @@ -237,15 +237,15 @@ The table includes below columns:

## Help

<img src="images/sde-help-page.png" height="60%" width="60%" />
<img src="images/sde-help-page.svg" height="60%" width="60%" />

This dynamic help page provides the submodel informations of selected use case in the home page. If no use case selected, it will show all available submodels. User can see the the order of the fields and details of each field by hovering the info icon in each row. User can download the sample csv and csv template for any submodels as well from this page.

# **Consumer**

## Consume Data

<img src="images/sde-consume-data-page.png" height="60%" width="90%" />
<img src="images/sde-consume-data-page.svg" height="60%" width="90%" />

After clicking on the "Consume Data" link in the sidebar navigation menu, user will be redirected to this Consumer view page. On this page, we need to select search type as Company Name or Business Partner Number or Connector URL(For select search type as Connector URL we have to enter connector URL manually). After entering the Company Name or Business Partner Number select connector dropdown will show the available connectors to select. After selecting connector,Search button will get enabled, we need to click on "Search" button to search or fetch the list of contract offers catalogs. After the successful query operation, the below table will populate list of Contract offers. The table will show the basic meta data of the offers and include the below columns,

Expand All @@ -256,21 +256,21 @@ After clicking on the "Consume Data" link in the sidebar navigation menu, user w

The table provides convinient features like Filter by, Sorting, Global search, Pagination, Export.

<img src="images/offer-details-view-subscribe.png" height="40%" width="40%" />
<img src="images/offer-details-view-subscribe.svg" height="40%" width="40%" />

Also we can view and subscribe individual data offer by clicking on the respective row to open the offer details popup.
The offer details dialog will populate all the basic metadata of the selected offer, Access policy and Usage policy details.
You can subscribe the data offer by clicking on "Subscribe" button and accepting the terms.

<img src="images/multiple-offers-subscribe.png" height="60%" width="60%" />
<img src="images/multiple-offers-subscribe.svg" height="60%" width="60%" />

User can also subscribe to multiple data offers at a time by ticking or checking the checkbox in front of the data offers and clicking on the button "Subscribe to Selected" present at top right section of the data offers table.
Please note that, user can only subscribe to multiple data offers if the offers have exact similar usage policies configured.
After clicking on Subscribe button and agreeing to the terms and conditions, the contract agreements establishment process will start for all of the selected data offers for the subscription.

## Consumer Contracts

<img src="images/sde-consumer-contracts.png" height="60%" width="90%" />
<img src="images/sde-consumer-contracts.svg" height="60%" width="90%" />

This page contains an overview of the data exchange contracts your organization has with other Catena-X members to receive & consume data from them.

Expand Down
Binary file removed docs/user-guide/images/catenax-keycloak-signin.png
Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/catenax-keycloak-signin.svg

Large diffs are not rendered by default.

Binary file removed docs/user-guide/images/catenax-login-org-search.png
Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/catenax-login-org-search.svg

Large diffs are not rendered by default.

Binary file removed docs/user-guide/images/catenax-login-org-select.png
Diff not rendered.
9 changes: 9 additions & 0 deletions docs/user-guide/images/catenax-login-org-select.svg

Large diffs are not rendered by default.

Binary file removed docs/user-guide/images/login.png
Diff not rendered.
Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/multiple-offers-subscribe.svg

Large diffs are not rendered by default.

Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/offer-details-view-subscribe.svg

Large diffs are not rendered by default.

Binary file removed docs/user-guide/images/sde-assembly-json.png
Diff not rendered.
Binary file removed docs/user-guide/images/sde-assembly-tabular.png
Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/sde-assembly-tabular.svg

Large diffs are not rendered by default.

Binary file removed docs/user-guide/images/sde-batch-json.png
Diff not rendered.
Binary file removed docs/user-guide/images/sde-batch-tabular.png
Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/sde-batch-tabular.svg

Large diffs are not rendered by default.

Binary file removed docs/user-guide/images/sde-configure-policy.png
Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/sde-configure-policy.svg

Large diffs are not rendered by default.

Binary file removed docs/user-guide/images/sde-consume-data-page.png
Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/sde-consume-data-page.svg

Large diffs are not rendered by default.

Binary file removed docs/user-guide/images/sde-consumer-contracts.png
Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/sde-consumer-contracts.svg

Large diffs are not rendered by default.

Binary file removed docs/user-guide/images/sde-create-data.png
Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/sde-create-data.svg

Large diffs are not rendered by default.

Binary file removed docs/user-guide/images/sde-header.png
Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/sde-header.svg

Large diffs are not rendered by default.

Binary file removed docs/user-guide/images/sde-help-page.png
Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/sde-help-page.svg

Large diffs are not rendered by default.

Binary file removed docs/user-guide/images/sde-home.png
Diff not rendered.
9 changes: 9 additions & 0 deletions docs/user-guide/images/sde-home.svg

Large diffs are not rendered by default.

Binary file removed docs/user-guide/images/sde-part-planned-json.png
Diff not rendered.
Binary file removed docs/user-guide/images/sde-part-planned-tabular.png
Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/sde-part-planned-tabular.svg

Large diffs are not rendered by default.

Binary file removed docs/user-guide/images/sde-part-site-info-json.png
Diff not rendered.
Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/sde-part-site-info-tabular.svg

Large diffs are not rendered by default.

Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/sde-product-carbon-footprint.svg

Large diffs are not rendered by default.

Binary file removed docs/user-guide/images/sde-profile-menu.png
Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/sde-profile-menu.svg

Large diffs are not rendered by default.

Binary file removed docs/user-guide/images/sde-provider-contracts.png
Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/sde-provider-contracts.svg

Large diffs are not rendered by default.

Binary file removed docs/user-guide/images/sde-serial-part-json.png
Diff not rendered.
Binary file removed docs/user-guide/images/sde-serial-part-tabular.png
Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/sde-serial-part-tabular.svg

Large diffs are not rendered by default.

Binary file removed docs/user-guide/images/sde-sidemenu.png
Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/sde-sidemenu.svg

Large diffs are not rendered by default.

Binary file removed docs/user-guide/images/sde-single-bom-json.png
Diff not rendered.
Binary file removed docs/user-guide/images/sde-single-bom-tabular.png
Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/sde-single-bom-tabular.svg

Large diffs are not rendered by default.

Diff not rendered.
Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/sde-single-level-usage-table.svg

Large diffs are not rendered by default.

Binary file removed docs/user-guide/images/sde-upload-error-logs.png
Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/sde-upload-error-logs.svg

Large diffs are not rendered by default.

Binary file removed docs/user-guide/images/sde-upload-file.png
Diff not rendered.
Binary file removed docs/user-guide/images/sde-upload-history.png
Diff not rendered.
4 changes: 4 additions & 0 deletions docs/user-guide/images/sde-upload-history.svg

Large diffs are not rendered by default.

Binary file removed docs/user-guide/images/upload-file-success.png
Diff not rendered.
Loading