Simple Data Exchanger (SDE) Release 23.12 Documentation Acceptance Criteria

[kelaja]

Release Documentation 23.12

Source in Catena-X Confluence and Expert Contacts here (Source only accessible for Catena-X Consortia members in current transition phase).

• Source Code QG check (Release 23.12) managed-simple-data-exchanger#21

  • Code is centrally managed in Eclipse Tractus-X repository.
  • All active and relevant Release Guidelines are fulfilled (with confirmation by DevSecOps SystemTeam).

  Artefact Repo:

  • Eclipse Tractus-X
  • FOSS Infopage(Source only accessible for Catena-X Consortia members in current transition phase)

  Best Practice

  • Consult the regular office hours as early as possible; expect optimization loops based on feedback.

  Contact:

  • DevSecOps System Team

• Architecture Documents

  • Arc42 documentation completed for relevant product version.
  • In MarkDown format. Link to document available. Must point to leading repository within Tractus-X. Process the JIRA ticket and schedule an appointment with Expert to obtain approval prior to Gate review.
  • Provide link to documentation as early as possible and mark changes to previous version (if applicable); expect optimization loops based on feedback.

  Artefact Repo:

  • GitHub Readme how-to (Source only accessible for Catena-X Consortia members in current transition phase)

  Contact:

  • SYSTEM ARCHITECT

• Administrator`s Guide (User assistance)

  • Admin Guide is available with the software at the same time
  • Admin Guide is correct and up to date; english is a must
  • The documentation is of appropriate maturity for any Operating Company with global business practice intentions.
  • In MarkDown format. Link to document available. Must point to leading repository within Tractus-X.

  Best Practice:

  • Process the issue and schedule an appointment with SYSTEM ARCHITECT to obtain approval prior to Gate review.
  • Provide link to documentation as early as possible and mark changes to previous version (if applicable); expect optimization loops based on feedback.
  • User assistance ensures that for example administrators get all the information they need to accomplish their tasks with the software. Refer to a administration guide, which covers "install/deploy, configure the software" – as appropriate for the type of software and the information needs of the target group(s)
  • UI text and embedded help complete the User assistance.

  Contact:

  • SYSTEM ARCHITECT

• End-User Manual (User assistance)

  • End-User Manual is available with the software at the same time
  • End-User Manual is correct and up to date; english is a must
  • The documentation is of appropriate maturity to be handed over from the CX Consortia to any Operations Company with global business practice intentions.

  Best Practice:

  • Process the issue and schedule an appointment with SYSTEM ARCHITECT to obtain approval prior to Gate review.
  • Provide link to documentation as early as possible and mark changes to previous version (if applicable); expect optimization loops based on feedback.
  • User assistance ensures that end users and others get all the information they need to accomplish their tasks with the software. Refer to a user guide, which covers "install/deploy, configure, and use the software" – as appropriate for the type of software and the information needs of the target group(s)
  • UI text and embedded help complete the User assistance.

  Contact:

  • SYSTEM ARCHITECT

• Interfaces Documentation

  • API documentation contains all relevant interfaces for integration testing and is completed for relevant product version.
  • Link to document available.
  • Interface contract signed by all involved parties.

  Best Practice:

  • Process the issue and schedule an appointment with SYSTEM ARCHITECT to obtain approval prior to Gate review.
  • Provide link to documentation as early as possible and mark changes to previous version (if applicable); expect optimization loops based on feedback.
  • see Open APIs

  Contact:

  • SYSTEM ARCHITECT

• UX consistency Style Guideline for User Interfaces

  • Mandatory for FrontEnd modules where the IP is Open Source or owned by Catena-X.
  • User Interfaces are in line with the Catena-X Style Guidelines
    • user interface style review has been executed (review owner: SYSTEM ARCHITECT5 UX)
    • review feedback (if existing) got incorporated
    • all findings are assessed
    • all findings (high/very high) are fixed or cleaned up (evidence by re-review)
    • approval of the application CX Style conformity is available (given by the review owner)

  Best Practice:

  • Obtain approval from Style Guideline Owner, prior to Gate review
  • use issue, include app URL & TestUser, assign to SYSTEM ARCHITECT5, expect review loop
  • Style Components
  • LINK to Style Guideline (Source only accessible for Catena-X Consortia members in current transition phase)
  • LINK to FrontEnd validations (will be added asap)
  • Please note, you can use the official public available CX shared component library (react supported) to easily develop applications that are in-line with the CX style guidelines

[sachinargade123]

• Source Code :
  SDE FE - https://github.com/eclipse-tractusx/managed-simple-data-exchanger-frontend
  SDE BE - https://github.com/eclipse-tractusx/managed-simple-data-exchanger-backend

• Architecture Documents Arc 42 - https://github.com/eclipse-tractusx/managed-simple-data-exchanger-frontend/blob/main/docs/Arc42.md

• Administrator`s Guide (User assistance)
  SDE BE - https://github.com/eclipse-tractusx/managed-simple-data-exchanger-backend/blob/main/INSTALL.md
  SDE. FE - https://github.com/eclipse-tractusx/managed-simple-data-exchanger-frontend/blob/main/README.md

• End-User Manual (User assistance)
  SDE Frontend :- https://github.com/eclipse-tractusx/managed-simple-data-exchanger-frontend/blob/main/docs/user-guide/README.md
  SDE Backend :- https://github.com/eclipse-tractusx/managed-simple-data-exchanger-backend/blob/main/README.md

• Interfaces Documentation - https://github.com/eclipse-tractusx/managed-simple-data-exchanger-backend/blob/main/modules/sde-core/src/main/resources/sde-open-api.yml

• UX consistency - Done as per UX Guidelines from Cat-X.

[hzierer]

System Team Release Guideline checks tracked in eclipse-tractusx/managed-simple-data-exchanger#21

[hzierer]

@MehranRoshandel @adityagajbhiye9 can you please specify the versions to check for QG4? And I assume we first need some PRs from catena-x -> tractus-x as the catena-x repos are several commits ahead

[adityagajbhiye9]

It is progress.

[hzierer]

Overview of the open (or not yet merged) issues found in the checks:

• values.yaml should not set insecure default passwords managed-simple-data-exchanger#22
• [TRG 5.07] postgresql version is not on the aligned version managed-simple-data-exchanger#23
• {TRG 7.02] Missing license and copyright header managed-simple-data-exchanger-frontend#40
• Dockerfile: UID 1001 and "useradd -r ..." are mutally exclusive managed-simple-data-exchanger-backend#69
• [TRG 7.01] outdated notice.md file managed-simple-data-exchanger-backend#71

[adityagajbhiye9]

Overview of the open (or not yet merged) issues found in the checks:

• values.yaml should not set insecure default passwords managed-simple-data-exchanger#22
• [TRG 5.07] postgresql version is not on the aligned version managed-simple-data-exchanger#23
• [{TRG 7.02] Missing license and copyright header managed-simple-data-exchanger-frontend#40]({TRG 7.02] Missing license and copyright header managed-simple-data-exchanger-frontend#40)
• Dockerfile: UID 1001 and "useradd -r ..." are mutally exclusive managed-simple-data-exchanger-backend#69
• [TRG 7.01] outdated notice.md file managed-simple-data-exchanger-backend#71

We already fixed above issues.

[adityagajbhiye9]

@MehranRoshandel @adityagajbhiye9 can you please specify the versions to check for QG4? And I assume we first need some PRs from catena-x -> tractus-x as the catena-x repos are several commits ahead
AppVersion:2.3.0
Chart Version: 1.0.0
After merging PR ,release tag will be 2.3.0

[MehranRoshandel]

This is correct; we are still waiting for the open PRs to merge.
eclipse-tractusx/managed-simple-data-exchanger-backend#68
eclipse-tractusx/managed-simple-data-exchanger-frontend#38
The expected version is 2.3.0

[kelaja]

• Source Code -> WiP in QG-Review on 23rd Nov, final version 2.3.0
• Architecture Documents -> @vialkoje kindly check upront in ng-repo or PR
• Administrator`s Guide -> @vialkoje kindly check
• End-User Manual -> @vialkoje kindly check
• Interfaces Documentation -> @vialkoje kindly check
• UX consistency -> @jjeroch no changes in the UX

[hzierer]

Found one additional issue:

• [TRG 7.05] Missing legal decuments in Docker image managed-simple-data-exchanger-frontend#41

[adityagajbhiye9]

Found one additional issue:

• [TRG 7.05] Missing legal decuments in Docker image managed-simple-data-exchanger-frontend#41

Updated the legal documents for docker image.

[kelaja]

@hzierer kindly check again the comment from @adityagajbhiye9

[jjeroch]

UX Validation Feedback:

Following change (findings of the last release) is/are missing:

• Suggestion: If the user selected one or several useCases on the "home" page, add the information of the selected useCases in all other sub-pages to ensure that the user is aware that a filtering is active.

Successfully tested:

• Suggestion: inside the "create data" page I suggest to add a link to the submodel description page ">> more details regarding the different submodel attributes"
• Inside the "Help" page (navigation on the left hand side) anchors/hyperlinks are suggested to enable the user to jump directly to the respective submodel description

[MehranRoshandel]

Good morning @jjeroch, Thanks we can implement the suggestions in this PI

[AjayRaturi123]

Source Code :
SDE FE - https://github.com/eclipse-tractusx/managed-simple-data-exchanger-frontend/releases/tag/v2.3.3
SDE BE - https://github.com/eclipse-tractusx/managed-simple-data-exchanger-backend/releases/tag/v2.3.3
@Siegfriedk please review and approve.

Architecture Documents Arc 42 - Arc42.md document updated with below points:-

1. Essential Features.
2. Interfaces/APIs.
3. Data processing pipelines.
   https://github.com/eclipse-tractusx/managed-simple-data-exchanger-frontend/blob/main/docs/Arc42.md

Administrator`s Guide (User assistance) - No Changes.
SDE BE - https://github.com/eclipse-tractusx/managed-simple-data-exchanger-backend/blob/main/INSTALL.md
SDE FE - https://github.com/eclipse-tractusx/managed-simple-data-exchanger-frontend/blob/main/README.md

End-User Manual (User assistance)
SDE Frontend :- Updated the UI changes screenshots and details as per new implementations.
https://github.com/eclipse-tractusx/managed-simple-data-exchanger-frontend/blob/main/docs/user-guide/README.md
SDE Backend :- Changes in submodel names.
https://github.com/eclipse-tractusx/managed-simple-data-exchanger-backend/blob/main/README.md

Interfaces Documentation - No Changes since R3.2.0
https://github.com/eclipse-tractusx/managed-simple-data-exchanger-backend/blob/main/modules/sde-core/src/main/resources/sde-open-api.yml

UX consistency - Done as per UX Guidelines from Cat-X.

@vialkoje Please review and approve.

[vialkoje]

everything available as expected. expert approval granted for architecture-, Admin-, User- and interface documentation tasks.

[hzierer]

Most checks (24/30) from system team side are ok in the meantime, too. Except for those which are blocked by the not yet released helm chart.
(PR is still in draft state)

[hzierer]

Most checks (24/30) from system team side are ok in the meantime, too. Except for those which are blocked by the not yet released helm chart. (PR is still in draft state)

The remaining 3 checks are currently blocked by managed-simple-data-exchanger/issues/26

[hzierer]

System Team Release Guideline checks have been finished successfully

[MehranRoshandel]

Thanks,
@kelaja please close the Ticket #78

[kelaja]

@jjeroch @MehranRoshandel can the UX be conditionally approved?

[kelaja]

@RolaH1t
The release notes must mention the following regarding UX:

• the reload will cause additional time duration for loading UX-content
• single selects are not implemented

if this is provided in the release notes then UX is conditionally approved.
Thx @jjeroch

@MehranRoshandel please add the findings from @jjeroch in the ChangeLog, and indicate to @RolaH1t if there is a Version update necessary

[RolaH1t]

Deadline Noon today! Go Go Go and move the issue to next status, when done!

[kelaja]

@jjeroch kindly leave your comment here, regarding SDE UX

[jjeroch]

Update on my findings based on the newest SDE Version:

UX Validation Feedback:

Following change (findings of the last release) is/are missing:

• Suggestion: If the user selected one or several useCases on the "home" page, add the information of the selected useCases in all other sub-pages to ensure that the user is aware that a filtering is active.

Successfully tested:

• Suggestion: inside the "create data" page I suggest to add a link to the submodel description page ">> more details regarding the different submodel attributes"
• Inside the "Help" page (navigation on the left hand side) anchors/hyperlinks are suggested to enable the user to jump directly to the respective submodel description
• left hand side navigation is always reloading when the user selects any navigation item. Instead its expected to stay in place and only reload the actual page content right beside. You can have a look at the portal - we are doing the same with our top navigation
• select should only allow single select but actually allows multiple selection

Findings relevant for the ChangeLog of Release 23.12.:

• Duration restriction need to get removed, this is not a valid policy rule
• Purpose policy rule wrong. Instead of “ID 3.0 Trace” it must be “ID 3.1 Trace”
• Usage Policy is missing the framework agreement which is mandatorily needed for UseCase specific data offers
• Help link navigates to GitHub docu “main” – this is a bad implementation behavior, never use main use the actual release tag
  otherwise the documentation will not fit to the actual application deployed as soon as main gets further developed

[MehranRoshandel]

Thanks, Julia,
We will document the findings in the changelog.

[MehranRoshandel]

We have updated the change logs as requested:
https://github.com/eclipse-tractusx/managed-simple-data-exchanger-frontend/blob/main/CHANGELOG.md

[MehranRoshandel]

@kelaja please close this ticket