Skip to content

CHANGELOG.md

Latest commit

 

History

History
1410 lines (957 loc) · 73.8 KB

CHANGELOG.md

File metadata and controls

1410 lines (957 loc) · 73.8 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

v5.2.0

The following Changelog lists the changes. Please refer to the documentation for configuration needs and understanding the concept changes.

The need for configuration updates is marked bold.

Added

  • Added environment variable for default production time (#1072)

Changed

  • /

Fixes

  • /

Known Knowns

Running With Shared DTR and EDC

PURIS FOSS may not be run on a shared DTR and EDC with full scope. See Admin Guide for more information of possible scenarios.

Upgradeability

Data base migrations are performed but assets.

Data Sovereignty

For productive use the following enhancements are encouraged

  • User FrontEnd available: Role Company Admin is able to query catalogue and see negotiations and transfers But company rules / policies need to be configured upfront in backend (via postman) to enable automatic contract negotiations, responsibility lies with Company Admin role
    --> add section in the User Manual describing this and the (legal) importance and responsibility behind defining these rules
  • Currently only one standard policy per reg. connector / customer instance is supported (more precisely one for DTR, one for all submodels), negotiation happens automatically based on this
    --> enhance option to select partner and define specific policies (to be planned in context of BPDM Integration)
    --> UI for specific configuration by dedicated role (e.g. Comp Admin) and more flexible policy configuration (withoutv code changes) is needed
  • As a non-Admin user I do not have ability to view policies in detail
    --> transparency for users when interacting with and requesting / consuming data via dashboard / views on underlying usage policies to be enhanced
  • ContractReference Constraint or configuration of policies specific to one partner only has notnot implemented
    --> clarification of potential reference to "PURIS standard contract" and enabling of ContractReference for 24.08.
  • unclear meaning of different stati in negotations
    --> add view of successfull contract agreeements wrt which data have been closed
  • current logging only done on info level
    --> enhance logging of policies (currently only available at debug level)
  • in case of non-matching policies (tested in various scenarios) no negotiation takes place
    --> enhance visualization or specific Error message to user
  • no validation of the Schema "profile": "cx-policy:profile2405" (required to ensure interop with other PURIS apps)

Styleguide

Overall
  • Brief description at the top of each page describing content would be nice for better user experience.
Catalog
  • No action possible -> unclear to user when and how user will consume an offer
Negotiations
  • Add filters for transparency (bpnl, state)

v5.1.0

The following Changelog lists the changes. Please refer to the documentation for configuration needs and understanding the concept changes.

The need for configuration updates is marked bold.

Added

  • Feature: Added update logic for operational information (#1069):
    • added update logic for Stock Modal (#1022)
    • added update logic for delivery information (#1004)
    • added update logic for demand Modal (#1028)
    • added update logic for production information (#1037)
    • updated user guide (#1070)
  • Added component to copy text to clipboard for puris frontend (#1058)
  • Added version to about license (#1067)
  • Added update flow to Material Details View buttons (#1034)
  • Add Update Partner Data Batch
    • Prepare backend for batch (#1105)
    • Incorporate scheduling service, controllers and test (#1106)
    • Implement frontend, cleanup scheduler and documentation (#1107)
    • Add missing frontend endpoint path in chart (#1112)
    • Fix typo in frontend endpoint path (in chart) (#1114)

Changed

  • switch to ssi-dim-wallet-stub instead of own mock-util-service (now DCP 1.0 is used) (#1066)
  • parametrize business partner identifiers in local deployment (#1073)
  • Bump frontend dependencies (#1107)
    • rollup from 4.28.0 to 4.59.0
    • @remix-run/route from 1.14.2 to 1.32.2
    • minimatch (eslint) from 3.1.2 to 3.15
    • minimatch (eslint-plugin) from 9.0.5 to 9.0.9

Fixes

  • /

Known Knowns

Running With Shared DTR and EDC

PURIS FOSS may not be run on a shared DTR and EDC with full scope. See Admin Guide for more information of possible scenarios.

Upgradeability

Data base migrations are performed but assets.

Data Sovereignty

For productive use the following enhancements are encouraged

  • User FrontEnd available: Role Company Admin is able to query catalogue and see negotiations and transfers But company rules / policies need to be configured upfront in backend (via postman) to enable automatic contract negotiations, responsibility lies with Company Admin role
    --> add section in the User Manual describing this and the (legal) importance and responsibility behind defining these rules
  • Currently only one standard policy per reg. connector / customer instance is supported (more precisely one for DTR, one for all submodels), negotiation happens automatically based on this
    --> enhance option to select partner and define specific policies (to be planned in context of BPDM Integration)
    --> UI for specific configuration by dedicated role (e.g. Comp Admin) and more flexible policy configuration (withoutv code changes) is needed
  • As a non-Admin user I do not have ability to view policies in detail
    --> transparency for users when interacting with and requesting / consuming data via dashboard / views on underlying usage policies to be enhanced
  • ContractReference Constraint or configuration of policies specific to one partner only has notnot implemented
    --> clarification of potential reference to "PURIS standard contract" and enabling of ContractReference for 24.08.
  • unclear meaning of different stati in negotations
    --> add view of successfull contract agreeements wrt which data have been closed
  • current logging only done on info level
    --> enhance logging of policies (currently only available at debug level)
  • in case of non-matching policies (tested in various scenarios) no negotiation takes place
    --> enhance visualization or specific Error message to user
  • no validation of the Schema "profile": "cx-policy:profile2405" (required to ensure interop with other PURIS apps)

Styleguide

Overall
  • Brief description at the top of each page describing content would be nice for better user experience.
Catalog
  • No action possible -> unclear to user when and how user will consume an offer
Negotiations
  • Add filters for transparency (bpnl, state)

v5.0.1

The following Changelog lists the changes. Please refer to the documentation for configuration needs and understanding the concept changes.

The need for configuration updates is marked bold.

Added

  • /

Changed

  • /

Fixes

  • don't fail during startup if own partner already exists (#1062)
  • in demo setup, skip setup if run has been performed before (#1065)
  • Improved documentation, added option for persitent containers and a .env file for bruno (1024)
  • fixed incorrect expected heading in E2E test suite (#1057)

Known Knowns

Running With Shared DTR and EDC

PURIS FOSS may not be run on a shared DTR and EDC with full scope. See Admin Guide for more information of possible scenarios.

Upgradeability

Data base migrations are performed but assets.

Data Sovereignty

For productive use the following enhancements are encouraged

  • User FrontEnd available: Role Company Admin is able to query catalogue and see negotiations and transfers But company rules / policies need to be configured upfront in backend (via postman) to enable automatic contract negotiations, responsibility lies with Company Admin role
    --> add section in the User Manual describing this and the (legal) importance and responsibility behind defining these rules
  • Currently only one standard policy per reg. connector / customer instance is supported (more precisely one for DTR, one for all submodels), negotiation happens automatically based on this
    --> enhance option to select partner and define specific policies (to be planned in context of BPDM Integration)
    --> UI for specific configuration by dedicated role (e.g. Comp Admin) and more flexible policy configuration (withoutv code changes) is needed
  • As a non-Admin user I do not have ability to view policies in detail
    --> transparency for users when interacting with and requesting / consuming data via dashboard / views on underlying usage policies to be enhanced
  • ContractReference Constraint or configuration of policies specific to one partner only has notnot implemented
    --> clarification of potential reference to "PURIS standard contract" and enabling of ContractReference for 24.08.
  • unclear meaning of different stati in negotations
    --> add view of successfull contract agreeements wrt which data have been closed
  • current logging only done on info level
    --> enhance logging of policies (currently only available at debug level)
  • in case of non-matching policies (tested in various scenarios) no negotiation takes place
    --> enhance visualization or specific Error message to user
  • no validation of the Schema "profile": "cx-policy:profile2405" (required to ensure interop with other PURIS apps)

Styleguide

Overall
  • Brief description at the top of each page describing content would be nice for better user experience.
Catalog
  • No action possible -> unclear to user when and how user will consume an offer
Negotiations
  • Add filters for transparency (bpnl, state)

v5.0.0

The following Changelog lists the changes. Please refer to the documentation for configuration needs and understanding the concept changes.

The need for configuration updates is marked bold.

Added

  • added Master data page for viewing all materials and option to add material as an admin (#1044)
  • added Partner table and creation modal to Master data page (#1054)
  • added Material-Partner Relation table and creation modal to master data page (#1059)

Changed

  • /

Fixes

  • /

Known Knowns

Running With Shared DTR and EDC

PURIS FOSS may not be run on a shared DTR and EDC with full scope. See Admin Guide for more information of possible scenarios.

Upgradeability

Data base migrations are performed but assets.

Data Sovereignty

For productive use the following enhancements are encouraged

  • User FrontEnd available: Role Company Admin is able to query catalogue and see negotiations and transfers But company rules / policies need to be configured upfront in backend (via postman) to enable automatic contract negotiations, responsibility lies with Company Admin role
    --> add section in the User Manual describing this and the (legal) importance and responsibility behind defining these rules
  • Currently only one standard policy per reg. connector / customer instance is supported (more precisely one for DTR, one for all submodels), negotiation happens automatically based on this
    --> enhance option to select partner and define specific policies (to be planned in context of BPDM Integration)
    --> UI for specific configuration by dedicated role (e.g. Comp Admin) and more flexible policy configuration (withoutv code changes) is needed
  • As a non-Admin user I do not have ability to view policies in detail
    --> transparency for users when interacting with and requesting / consuming data via dashboard / views on underlying usage policies to be enhanced
  • ContractReference Constraint or configuration of policies specific to one partner only has notnot implemented
    --> clarification of potential reference to "PURIS standard contract" and enabling of ContractReference for 24.08.
  • unclear meaning of different stati in negotations
    --> add view of successfull contract agreeements wrt which data have been closed
  • current logging only done on info level
    --> enhance logging of policies (currently only available at debug level)
  • in case of non-matching policies (tested in various scenarios) no negotiation takes place
    --> enhance visualization or specific Error message to user
  • no validation of the Schema "profile": "cx-policy:profile2405" (required to ensure interop with other PURIS apps)

Styleguide

Overall
  • Brief description at the top of each page describing content would be nice for better user experience.
Catalog
  • No action possible -> unclear to user when and how user will consume an offer
Negotiations
  • Add filters for transparency (bpnl, state)

v4.1.1

The following Changelog lists the changes. Please refer to the documentation for configuration needs and understanding the concept changes.

The need for configuration updates is marked bold.

Added

  • added detailed error messages for formulas in excel imports (#1036)

Changed

  • bump spring boot from 3.5.4 to 3.5.7 (#1040)
  • ci(quality-checks.yaml): configure notice file checks (#1041)
  • bump dtr version to 0.10.0-RC1 (#1043)
  • bump edc version to 0.10.2 (#1043)

Fixes

  • /

Known Knowns

Running With Shared DTR and EDC

PURIS FOSS may not be run on a shared DTR and EDC with full scope. See Admin Guide for more information of possible scenarios.

Upgradeability

Data base migrations are performed but assets.

Data Sovereignty

For productive use the following enhancements are encouraged

  • User FrontEnd available: Role Company Admin is able to query catalogue and see negotiations and transfers But company rules / policies need to be configured upfront in backend (via postman) to enable automatic contract negotiations, responsibility lies with Company Admin role
    --> add section in the User Manual describing this and the (legal) importance and responsibility behind defining these rules
  • Currently only one standard policy per reg. connector / customer instance is supported (more precisely one for DTR, one for all submodels), negotiation happens automatically based on this
    --> enhance option to select partner and define specific policies (to be planned in context of BPDM Integration)
    --> UI for specific configuration by dedicated role (e.g. Comp Admin) and more flexible policy configuration (withoutv code changes) is needed
  • As a non-Admin user I do not have ability to view policies in detail
    --> transparency for users when interacting with and requesting / consuming data via dashboard / views on underlying usage policies to be enhanced
  • ContractReference Constraint or configuration of policies specific to one partner only has notnot implemented
    --> clarification of potential reference to "PURIS standard contract" and enabling of ContractReference for 24.08.
  • unclear meaning of different stati in negotations
    --> add view of successfull contract agreeements wrt which data have been closed
  • current logging only done on info level
    --> enhance logging of policies (currently only available at debug level)
  • in case of non-matching policies (tested in various scenarios) no negotiation takes place
    --> enhance visualization or specific Error message to user
  • no validation of the Schema "profile": "cx-policy:profile2405" (required to ensure interop with other PURIS apps)

Styleguide

Overall
  • Brief description at the top of each page describing content would be nice for better user experience.
Catalog
  • No action possible -> unclear to user when and how user will consume an offer
Negotiations
  • Add filters for transparency (bpnl, state)

v4.1.0

The following Changelog lists the changes. Please refer to the documentation for configuration needs and understanding the concept changes.

The need for configuration updates is marked bold.

Added

  • Added improved error messages for refresh materials (#995)
  • Added Material Number in material details view (#1005)
  • added formula support for excel imports (#1020)

Changed

  • Refactored partner service to use patternStore regexes for BPNL/S/A (#1001)

Fixes

  • /

Known Knowns

Running With Shared DTR and EDC

PURIS FOSS may not be run on a shared DTR and EDC with full scope. See Admin Guide for more information of possible scenarios.

Upgradeability

Data base migrations are performed but assets.

Data Sovereignty

For productive use the following enhancements are encouraged

  • User FrontEnd available: Role Company Admin is able to query catalogue and see negotiations and transfers But company rules / policies need to be configured upfront in backend (via postman) to enable automatic contract negotiations, responsibility lies with Company Admin role
    --> add section in the User Manual describing this and the (legal) importance and responsibility behind defining these rules
  • Currently only one standard policy per reg. connector / customer instance is supported (more precisely one for DTR, one for all submodels), negotiation happens automatically based on this
    --> enhance option to select partner and define specific policies (to be planned in context of BPDM Integration)
    --> UI for specific configuration by dedicated role (e.g. Comp Admin) and more flexible policy configuration (withoutv code changes) is needed
  • As a non-Admin user I do not have ability to view policies in detail
    --> transparency for users when interacting with and requesting / consuming data via dashboard / views on underlying usage policies to be enhanced
  • ContractReference Constraint or configuration of policies specific to one partner only has notnot implemented
    --> clarification of potential reference to "PURIS standard contract" and enabling of ContractReference for 24.08.
  • unclear meaning of different stati in negotations
    --> add view of successfull contract agreeements wrt which data have been closed
  • current logging only done on info level
    --> enhance logging of policies (currently only available at debug level)
  • in case of non-matching policies (tested in various scenarios) no negotiation takes place
    --> enhance visualization or specific Error message to user
  • no validation of the Schema "profile": "cx-policy:profile2405" (required to ensure interop with other PURIS apps)

Styleguide

Overall
  • Brief description at the top of each page describing content would be nice for better user experience.
Catalog
  • No action possible -> unclear to user when and how user will consume an offer
Negotiations
  • Add filters for transparency (bpnl, state)

v4.0.0

The following Changelog lists the changes. Please refer to the documentation for configuration needs and understanding the concept changes.

The need for configuration updates is marked bold.

Added

  • /

Changed

  • /

Fixes

  • Fixed invalid framework policy in the bruno DTR setup (#967)
  • Fixed Modal dialogs not updating when deleting entries for materials (#984)
  • Allow 0 values in all reported and most own data to improve application resiliency (#991)
  • Fixed product and material stocks always including values for all materials (#994)

Known Knowns

Running With Shared DTR and EDC

PURIS FOSS may not be run on a shared DTR and EDC with full scope. See Admin Guide for more information of possible scenarios.

Upgradeability

Data base migrations are performed but assets.

Data Sovereignty

For productive use the following enhancements are encouraged

  • User FrontEnd available: Role Company Admin is able to query catalogue and see negotiations and transfers But company rules / policies need to be configured upfront in backend (via postman) to enable automatic contract negotiations, responsibility lies with Company Admin role
    --> add section in the User Manual describing this and the (legal) importance and responsibility behind defining these rules
  • Currently only one standard policy per reg. connector / customer instance is supported (more precisely one for DTR, one for all submodels), negotiation happens automatically based on this
    --> enhance option to select partner and define specific policies (to be planned in context of BPDM Integration)
    --> UI for specific configuration by dedicated role (e.g. Comp Admin) and more flexible policy configuration (withoutv code changes) is needed
  • As a non-Admin user I do not have ability to view policies in detail
    --> transparency for users when interacting with and requesting / consuming data via dashboard / views on underlying usage policies to be enhanced
  • ContractReference Constraint or configuration of policies specific to one partner only has notnot implemented
    --> clarification of potential reference to "PURIS standard contract" and enabling of ContractReference for 24.08.
  • unclear meaning of different stati in negotations
    --> add view of successfull contract agreeements wrt which data have been closed
  • current logging only done on info level
    --> enhance logging of policies (currently only available at debug level)
  • in case of non-matching policies (tested in various scenarios) no negotiation takes place
    --> enhance visualization or specific Error message to user
  • no validation of the Schema "profile": "cx-policy:profile2405" (required to ensure interop with other PURIS apps)

Styleguide

Overall
  • Brief description at the top of each page describing content would be nice for better user experience.
Catalog
  • No action possible -> unclear to user when and how user will consume an offer
Negotiations
  • Add filters for transparency (bpnl, state)

v3.4.0

The following Changelog lists the changes. Please refer to the documentation for configuration needs and understanding the concept changes.

The need for configuration updates is marked bold.

Added

  • Added possibility to suppress asset and contract creation for DTR if already covered by another application (#963)

Changed

  • /

Fixes

  • Fixed import bugs for empty rows and duplicate stocks (#961)

Known Knowns

Running With Shared DTR and EDC

PURIS FOSS may not be run on a shared DTR and EDC with full scope. See Admin Guide for more information of possible scenarios.

Upgradeability

Data base migrations are performed but assets.

Data Sovereignty

For productive use the following enhancements are encouraged

  • User FrontEnd available: Role Company Admin is able to query catalogue and see negotiations and transfers But company rules / policies need to be configured upfront in backend (via postman) to enable automatic contract negotiations, responsibility lies with Company Admin role
    --> add section in the User Manual describing this and the (legal) importance and responsibility behind defining these rules
  • Currently only one standard policy per reg. connector / customer instance is supported (more precisely one for DTR, one for all submodels), negotiation happens automatically based on this
    --> enhance option to select partner and define specific policies (to be planned in context of BPDM Integration)
    --> UI for specific configuration by dedicated role (e.g. Comp Admin) and more flexible policy configuration (withoutv code changes) is needed
  • As a non-Admin user I do not have ability to view policies in detail
    --> transparency for users when interacting with and requesting / consuming data via dashboard / views on underlying usage policies to be enhanced
  • ContractReference Constraint or configuration of policies specific to one partner only has notnot implemented
    --> clarification of potential reference to "PURIS standard contract" and enabling of ContractReference for 24.08.
  • unclear meaning of different stati in negotations
    --> add view of successfull contract agreeements wrt which data have been closed
  • current logging only done on info level
    --> enhance logging of policies (currently only available at debug level)
  • in case of non-matching policies (tested in various scenarios) no negotiation takes place
    --> enhance visualization or specific Error message to user
  • no validation of the Schema "profile": "cx-policy:profile2405" (required to ensure interop with other PURIS apps)

Styleguide

Overall
  • Brief description at the top of each page describing content would be nice for better user experience.
Catalog
  • No action possible -> unclear to user when and how user will consume an offer
Negotiations
  • Add filters for transparency (bpnl, state)

v3.3.0

The following Changelog lists the changes. Please refer to the documentation for configuration needs and understanding the concept changes.

The need for configuration updates is marked bold.

Added

  • Added unit tests Excel imports (#922)
  • Added role based permission handling for endpoints (#925)
  • Added Excel import page with template files download (#930)

Changed

  • Updated End-to-End tests to support local authentication (#920)
  • Update DemandAndCapacityNotification API to implement standard version 2.0 (#921)
  • Update Frontend Notification View with grouping based on disruptionId and seperating by status, forwarding connected notifications, editing and resolving notifications (#926)
  • CI: Trivy workflow should not fail if critical or high vulnerabilities are found (#948).

Fixes

  • Drop further security capabilities and apply default seccomp in chart's deployments (#938)
  • Fixed notification resolution validation issue (#952)
  • Fixed notification resolution start date validation (#954)
  • Fixed E2E test for sidebar (#958)

Chore

  • Updated open API (#929)
  • Updated dependencies to resolve high and critical security vulnerabilities (#932)
  • Updated User guide with the updated notification view and the new import page (#933)
  • Updated Arc42 documentation (#937)
  • Bump helm test workfow to new kubernetes version and latest q-gates puris version (#938)

Version Bumps

  • Digital Twin Registry to 0.9.0-RC1 (#957)

Known Knowns

Upgradeability

Data base migrations are performed but assets.

Data Sovereignty

For productive use the following enhancements are encouraged

  • User FrontEnd available: Role Company Admin is able to query catalogue and see negotiations and transfers But company rules / policies need to be configured upfront in backend (via postman) to enable automatic contract negotiations, responsibility lies with Company Admin role
    --> add section in the User Manual describing this and the (legal) importance and responsibility behind defining these rules
  • Currently only one standard policy per reg. connector / customer instance is supported (more precisely one for DTR, one for all submodels), negotiation happens automatically based on this
    --> enhance option to select partner and define specific policies (to be planned in context of BPDM Integration)
    --> UI for specific configuration by dedicated role (e.g. Comp Admin) and more flexible policy configuration (withoutv code changes) is needed
  • As a non-Admin user I do not have ability to view policies in detail
    --> transparency for users when interacting with and requesting / consuming data via dashboard / views on underlying usage policies to be enhanced
  • ContractReference Constraint or configuration of policies specific to one partner only has notnot implemented
    --> clarification of potential reference to "PURIS standard contract" and enabling of ContractReference for 24.08.
  • unclear meaning of different stati in negotations
    --> add view of successfull contract agreeements wrt which data have been closed
  • current logging only done on info level
    --> enhance logging of policies (currently only available at debug level)
  • in case of non-matching policies (tested in various scenarios) no negotiation takes place
    --> enhance visualization or specific Error message to user
  • no validation of the Schema "profile": "cx-policy:profile2405" (required to ensure interop with other PURIS apps)

Styleguide

Overall
  • Brief description at the top of each page describing content would be nice for better user experience.
Catalog
  • No action possible -> unclear to user when and how user will consume an offer
Negotiations
  • Add filters for transparency (bpnl, state)

v3.2.0

The following Changelog lists the changes. Please refer to the documentation for configuration needs and understanding the concept changes.

The need for configuration updates is marked bold.

Added

  • Implement Excel imports through API (#897, #907)
  • Added liquibase for database migrations (#913)

Changed

  • Use the frontend's existing keycloak authentication to authorize backend calls (#896) (moved IDP configuration and IDP no longer optional)

Fixes

  • Added lastUpdatedOnDateTime to local representations of Demand, Production and Delivery (#908)

v3.1.0

The following Changelog lists the changes. Please refer to the documentation for configuration needs and understanding the concept changes.

The need for configuration updates is marked bold.

Added

  • One line local deployment script (#469)
  • End-to-end tests using Cypress (#868)

Changed

  • Switch to spring actuator helm endpoint including enhancement of health, liveness and startup probe (#469)
  • Company name and BPNL display in the sidebar for easier distinguishing between applications (#837)
  • Updated partner data request flow to automatically update the UI when the data is received (#847)
  • Extended Days of Supply unit tests in the backend to include some additional edge cases (#870)

Fixes

  • Expect dtr base url to include api/v3 in asset (#824) (updated default values and asset definition)
  • Creating own partner entity does not run into (#838)
  • submodel endpoint returns 501 instead of 500 for operations not implemented (#850)
  • Creating own partner entity does not run into exception (#838)
  • Submodels are exposed via submodel/$value and not $value including the update of SubmodelDescriptors (#849)
  • use own bpnl as default tenant (Edc-Bpn) when updating own dtr and only use partner BPNL in externalSubjectId (#849)
  • use assetId instead of semanticId and dct:type=submodel during catalog request for submodel assets (#849)
  • use the correct request when refreshing material data from customers (#879)
  • add the correct role to the login commands in cypress tests and utilize sessions to optimize login logic (#889)
  • fix bruno integration test suite (#893)

Chore

  • Added missing notice sections for markdown files (#884)
  • Updated User Guide (#883)
  • Updated open API (#894)

CI

  • reduce dashtool failures during test and dependency check in backend (#890)

Version Bumps

  • Infrastructure Components
    • Tractus-X Connector to 0.10.0-rc2 (#872)
    • Digital Twin Registry to 0.8.0-RC1 (#872)
  • Backend Dependencies
    • spring-boot from 3.4.3 to 3.4.5 in /backend (#871)

Removed

N.A.

Known Knowns

Security

The Backend is currently secured via API Key while the Frontend already uses a Keycloak integration. See Admin Guide for further information.

Upgradeability

As currently no active user was known migrations of data are not yet supported. The chart technically is upgradeable.

Data Sovereignty

For productive use the following enhancements are encouraged

  • User FrontEnd available: Role Company Admin is able to query catalogue and see negotiations and transfers But company rules / policies need to be configured upfront in backend (via postman) to enable automatic contract negotiations, responsibility lies with Company Admin role --> add section in the User Manual describing this and the (legal) importance and responsibility behind defining these rules
  • Currently only one standard policy per reg. connector / customer instance is supported (more precisely one for DTR, one for all submodels), negotiation happens automatically based on this --> enhance option to select partner and define specific policies (to be planned in context of BPDM Integration) --> UI for specific configuration by dedicated role (e.g. Comp Admin) and more flexible policy configuration (withoutv code changes) is needed
  • As a non-Admin user I do not have ability to view policies in detail --> transparency for users when interacting with and requesting / consuming data via dashboard / views on underlying usage policies to be enhanced
  • ContractReference Constraint or configuration of policies specific to one partner only has notnot implemented --> clarification of potential reference to "PURIS standard contract" and enabling of ContractReference for 24.08.
  • unclear meaning of different stati in negotations --> add view of successfull contract agreeements wrt which data have been closed
  • current logging only done on info level --> enhance logging of policies (currently only available at debug level)
  • in case of non-matching policies (tested in various scenarios) no negotiation takes place --> enhance visualization or specific Error message to user
  • no validation of the Schema "profile": "cx-policy:profile2405" (required to ensure interop with other PURIS apps)

Styleguide

Overall

  • Brief description at the top of each page describing content would be nice for better user experience.

Catalog

  • No action possible -> unclear to user when and how user will consume an offer

Negotiations

  • Add filters for transparency (bpnl, state)

v3.0.0

The following Changelog lists the changes. Please refer to the documentation for configuration needs and understanding the concept changes.

The need for configuration updates is marked bold.

Added

  • Added banner for puris backend (#556)
  • Add bruno integration test collection (#546)

Changed

Fixes

  • Encode material numbers in frontend parameters with base64 (#512, #580)(breaking change)
  • Change log message for already existing edc assets on startup (547)
  • Don't return own partner entity from partner/all endpoint (#563)
  • Fix material number issues and partner/all endpoint in integration test suite (#689)
  • improve demand and capacity notification (accept material number correctly, added test, role specific differentiation) (#576)
  • Can't create select a partner when creating deliveries (#800)
  • Missing indicators for mandatory fields (#800)
  • Update "Supplier Site" label on add demand dialog to "Expected Supplier Site" (#800)
  • fixed translation of weekdays to english language (#800)
  • fixed missing mandatory indicator for Estimated Completion Time (#801)

UI enhancements

  • Reworked UI theme (#709)
  • Added Material List View (#732)
  • Added Material Details View (#747, #750)
  • Integrated Stock View into Material Details View (#778)

Days of Supply Information implementation

  • Added Days of Supply EDC integration (#694)
  • Added Days of Supply to the frontend (#776)
  • Added unit tests for Days of Supply to the backend (#454, #694)
  • Add integration test cases for bruno for days of supply (#752)
  • Fix days of supply calculation by only relying on the projected stocks without the addedValue (#773)

CI

  • Added workflow for backend unit tests (#616)
  • Added trufflehog secret scanning tool (#531, #555)
  • Updated Triviy version and workflow failure (#452)
  • Changed Helm Test workflow to only check for version bump in the end so that version bumps are not enforced anymore (#450)

Chore

  • Changed license headers to follow TRG 7.02 (#562)
  • Cleaned up erp adapter request feature (#578)
  • Updated User Guide (#780)
  • Update of swagger documentation (#794)

Version Bumps

  • Infrastructure Components
    • Tractus-X Connector to 0.8.0 (#705) and 0.9.0-rc2 (#781)
    • Digital Twin Registry to 0.7.0 (#781)
  • Backend Dependencies
    • edc-connector-version from 0.7.0 to 0.11.1 in /backend (#781)
    • org.springdoc:springdoc-openapi-starter-webmvc-ui in /backend (#790)
    • org.springframework.boot:spring-boot-starter-parent in /backend (#790)
  • IAM Mock (Local Deployment)
    • jinja2 from 3.1.4 to 3.1.5 (#784)
    • python-multipart from 0.0.7 to 0.0.18 (#784)
    • starlette from 0.37.2 to 0.40.0 (#784)
    • cryptography from 42.0.5 to 44.0.1 (#784)
  • CI

Removed

N.A.

Known Knowns

Security

The Backend is currently secured via API Key while the Frontend already uses a Keycloak integration. See Admin Guide for further information.

Upgradeability

As currently no active user was known migrations of data are not yet supported. The chart technically is upgradeable.

Data Sovereignty

For productive use the following enhancements are encouraged

  • User FrontEnd available: Role Company Admin is able to query catalogue and see negotiations and transfers But company rules / policies need to be configured upfront in backend (via postman) to enable automatic contract negotiations, responsibility lies with Company Admin role --> add section in the User Manual describing this and the (legal) importance and responsibility behind defining these rules
  • Currently only one standard policy per reg. connector / customer instance is supported (more precisely one for DTR, one for all submodels), negotiation happens automatically based on this --> enhance option to select partner and define specific policies (to be planned in context of BPDM Integration) --> UI for specific configuration by dedicated role (e.g. Comp Admin) and more flexible policy configuration (withoutv code changes) is needed
  • As a non-Admin user I do not have ability to view policies in detail --> transparency for users when interacting with and requesting / consuming data via dashboard / views on underlying usage policies to be enhanced
  • ContractReference Constraint or configuration of policies specific to one partner only has notnot implemented --> clarification of potential reference to "PURIS standard contract" and enabling of ContractReference for 24.08.
  • unclear meaning of different stati in negotations --> add view of successfull contract agreeements wrt which data have been closed
  • current logging only done on info level --> enhance logging of policies (currently only available at debug level)
  • in case of non-matching policies (tested in various scenarios) no negotiation takes place --> enhance visualization or specific Error message to user
  • no validation of the Schema "profile": "cx-policy:profile2405" (required to ensure interop with other PURIS apps)

Styleguide

Overall

  • Brief description at the top of each page describing content would be nice for better user experience.

Catalog

  • No action possible -> unclear to user when and how user will consume an offer

Negotiations

  • Add filters for transparency (bpnl, state)

v2.1.0

The following Changelog lists the changes. Please refer to the documentation for configuration needs and understanding the concept changes.

The need for configuration updates is marked bold.

Added

  • ERP Adapter
    • Added client (#443)
    • Added trigger service (#474)
    • Added button to frontend (#504)
  • backend implementation for Days of Supply (CX-0145) (#441)
  • Demand and Capacity Notifications (CX-0146) can be sent between partners (#447, #451)

Changed

Fixes

  • Fail contract negotiation if non-empty obligations or prohibitions are set (#509)
  • Use expanded jsonLD when evaluating catalog offers (#416)
  • Publish cxId to DTR when retrieving Part Type later (#483)

CI

  • Trivy Workflow (#452)
  • Helm Test to only check for version bump in the end so that version bumps are not enforced anymore (#450)

Chore

  • Updated license information (#468, #476, #527)
  • Update of swagger documentation (#514, #516)
  • Version Bumps
    • Infrastructure Components
      • Tractus-X EDC to 0.7.3 (#508)
      • Digital Twin Registry to 0.5.0 (#496)
    • Backend Dependencies
      • spring boot starter parent to 3.3.1 (#471)
    • Frontend Dependencies
      • vite to 5.3.3 (#481)
      • postcss to 8.4.39 (#478)
      • braces to 3.0.3 (#453)
      • typescript-eslint/eslint-plugin to 7.0.0 (7.0.0)
    • IAM Mock (Local Deployment): certify to 2024.7.4 (#484)
    • CI
      • actions/setup-python to 5.1.1 (#492)
      • github/codeql-action to 3.25.10 (#448)
      • checkmarx/kics-github-action to 2.1.0 (#446)
      • actions/download-artifact to 4.1.7 (#396)
      • azure/setup-helm to 4 (#395)

Removed

N.A.

Known Knowns

Security

The Backend is currently secured via API Key while the Frontend already uses an API-KEY. See Admin Guide for further information.

Upgradeability

As currently no active user was known migrations of data are not yet supported. The chart technically is upgradeable.

Data Sovereignty

For productive use the following enhancements are encouraged

  • User FrontEnd available: Role Company Admin is able to query catalogue and see negotiations and transfers But company rules / policies need to be configured upfront in backend (via postman) to enable automatic contract negotiations, responsibility lies with Company Admin role --> add section in the User Manual describing this and the (legal) importance and responsibility behind defining these rules
  • Currently only one standard policy per reg. connector / customer instance is supported (more precisely one for DTR, one for all submodels), negotiation happens automatically based on this --> enhance option to select partner and define specific policies (to be planned in context of BPDM Integration) --> UI for specific configuration by dedicated role (e.g. Comp Admin) and more flexible policy configuration (without code changes) is needed
  • As a non-Admin user I do not have ability to view policies in detail --> transparency for users when interacting with and requesting / consuming data via dashboard / views on underlying usage policies to be enhanced
  • ContractReference Constraint or configuration of policies specific to one partner only not implemented --> clarification of potential reference to "PURIS standard contract" and enabling of ContractReference for 24.08.
  • unclear meaning of different stati in negotations --> add view of successfull contract agreeements wrt which data have been closed
  • current logging only done on info level --> enhance logging of policies (currently only available at debug level)
  • in case of non-matching policies (tested in various scenarios) no negotiation takes place --> enhance visualization or specific Error message to user
  • no validation of the Schema "profile": "cx-policy:profile2405" (required to ensure interop with other PURIS apps)

Styleguide

Overall

  • Brief description at the top of each page describing content would be nice for better user experience.

Stocks

  • user needs better guidance to click on a stock to update it (else error prone to enter one slightly different attribute and Add instead of update)
  • Refresh -- update request has been sent successfully. -> more information regarding data transfer needed for user

Catalog

  • No action possible -> unclear to user when and how user will consume an offer

Negotiations

  • Add filters for transparency (bpnl, state)

v2.0.2

The following Changelog lists the changes. Please refer to the documentation for configuration needs and understanding the concept changes.

The need for configuration updates is marked bold.

Added

  • Added backend implementation to CRUD Demand and Capacity Notifications (#415)
  • Added ERP response interface (#418)

Changed

  • Fixed check when answering delivery information request from a customer which prevented always to answer (#435)

Removed

N.A.

Known Knowns

Security

The Backend is currently secured via API Key while the Frontend already uses an API-KEY. See Admin Guide for further information.

Upgradeability

As currently no active user was known migrations of data are not yet supported. The chart technically is upgradeable.

Data Sovereignty

For productive use the following enhancements are encouraged

  • User FrontEnd available: Role Company Admin is able to query catalogue and see negotiations and transfers But company rules / policies need to be configured upfront in backend (via postman) to enable automatic contract negotiations, responsibility lies with Company Admin role --> add section in the User Manual describing this and the (legal) importance and responsibility behind defining these rules
  • Currently only one standard policy per reg. connector / customer instance is supported (more precisely one for DTR, one for all submodels), negotiation happens automatically based on this --> enhance option to select partner and define specific policies (to be planned in context of BPDM Integration) --> UI for specific configuration by dedicated role (e.g. Comp Admin) and more flexible policy configuration (without code changes) is needed
  • As a non-Admin user I do not have ability to view policies in detail --> transparency for users when interacting with and requesting / consuming data via dashboard / views on underlying usage policies to be enhanced
  • ContractReference Constraint or configuration of policies specific to one partner only not implemented --> clarification of potential reference to "PURIS standard contract" and enabling of ContractReference for 24.08.
  • unclear meaning of different stati in negotations --> add view of successfull contract agreeements wrt which data have been closed
  • current logging only done on info level --> enhance logging of policies (currently only available at debug level)
  • in case of non-matching policies (tested in various scenarios) no negotiation takes place --> enhance visualization or specific Error message to user
  • no validation of the Schema "profile": "cx-policy:profile2405" (required to ensure interop with other PURIS apps)

Styleguide

Overall

  • Brief description at the top of each page describing content would be nice for better user experience.

Dashboard

  • Similar for Create Delivery (here SOME entries are reset but warnings stay) (block)

Stocks

  • user needs better guidance to click on a stock to update it (else error prone to enter one slightly different attribute and Add instead of update)
  • Refresh -- update request has been sent successfully. -> more information regarding data transfer needed for user

Catalog

  • No action possible -> unclear to user when and how user will consume an offer

Negotiations

  • Add filters for transparency (bpnl, state)

v2.0.1

The following Changelog lists the changes. Please refer to the documentation for configuration needs and understanding the concept changes.

The need for configuration updates is marked bold.

Added

  • Added backend implementation to CRUD Demand and Capacity Notifications (#415)
  • Added ERP response interface (#418)

Changed

  • Fixed check when answering delivery information request from a customer which prevented always to answer (#435)

Removed

N.A.

Known Knowns

Security

The Backend is currently secured via API Key while the Frontend already uses an API-KEY. See Admin Guide for further information.

Upgradeability

As currently no active user was known migrations of data are not yet supported. The chart technically is upgradeable.

Data Sovereignty

For productive use the following enhancements are encouraged

  • User FrontEnd available: Role Company Admin is able to query catalogue and see negotiations and transfers But company rules / policies need to be configured upfront in backend (via postman) to enable automatic contract negotiations, responsibility lies with Company Admin role --> add section in the User Manual describing this and the (legal) importance and responsibility behind defining these rules
  • Currently only one standard policy per reg. connector / customer instance is supported (more precisely one for DTR, one for all submodels), negotiation happens automatically based on this --> enhance option to select partner and define specific policies (to be planned in context of BPDM Integration) --> UI for specific configuration by dedicated role (e.g. Comp Admin) and more flexible policy configuration (without code changes) is needed
  • As a non-Admin user I do not have ability to view policies in detail --> transparency for users when interacting with and requesting / consuming data via dashboard / views on underlying usage policies to be enhanced
  • ContractReference Constraint or configuration of policies specific to one partner only not implemented --> clarification of potential reference to "PURIS standard contract" and enabling of ContractReference for 24.08.
  • unclear meaning of different stati in negotations --> add view of successfull contract agreeements wrt which data have been closed
  • current logging only done on info level --> enhance logging of policies (currently only available at debug level)
  • in case of non-matching policies (tested in various scenarios) no negotiation takes place --> enhance visualization or specific Error message to user
  • no validation of the Schema "profile": "cx-policy:profile2405" (required to ensure interop with other PURIS apps)

Styleguide

Overall

  • Brief description at the top of each page describing content would be nice for better user experience.

Dashboard

  • Similar for Create Delivery (here SOME entries are reset but warnings stay) (block)

Stocks

  • user needs better guidance to click on a stock to update it (else error prone to enter one slightly different attribute and Add instead of update)
  • Refresh -- update request has been sent successfully. -> more information regarding data transfer needed for user

Catalog

  • No action possible -> unclear to user when and how user will consume an offer

Negotiations

  • Add filters for transparency (bpnl, state)

v2.0.1

The following Changelog lists the changes. Please refer to the documentation for configuration needs and understanding the concept changes.

The need for configuration updates is marked bold.

Added

  • Added Footer

Changed

Frontend updates

  • Labels are now above and not on the border of elements
  • updated icons for catalog, negotiations, transfers, logout
  • Font update for Role switching elements in stocks and dashboard view
  • Handled modal dialog behavior to always let failed validations prevent closing
  • Modal Dialog Demand
    • Day is marked as mandatory
    • Reset data when reopening
  • Catalog View
    • Updated header itle + usage policy naming (previously Asset Action)
    • Added table view
    • increased responsiveness by loading animation
  • Negotiation view
    • Added table view + Subheader
  • Logout button now logs out again

Fixed constraints to exactly match on leftOperands during consumer side offer evaluation

Removed

  • EDR Endpoint as removed for edr api usage in appVersion 2.0.0

Known Knowns

Security

The Backend is currently secured via API Key while the Frontend already uses an API-KEY. See Admin Guide for further information.

Upgradeability

As currently no active user was known migrations of data are not yet supported. The chart technically is upgradeable.

Data Sovereignty

For productive use the following enhancements are encouraged

  • User FrontEnd available: Role Company Admin is able to query catalogue and see negotiations and transfers But company rules / policies need to be configured upfront in backend (via postman) to enable automatic contract negotiations, responsibility lies with Company Admin role --> add section in the User Manual describing this and the (legal) importance and responsibility behind defining these rules
  • Currently only one standard policy per reg. connector / customer instance is supported (more precisely one for DTR, one for all submodels), negotiation happens automatically based on this --> enhance option to select partner and define specific policies (to be planned in context of BPDM Integration) --> UI for specific configuration by dedicated role (e.g. Comp Admin) and more flexible policy configuration (without code changes) is needed
  • As a non-Admin user I do not have ability to view policies in detail --> transparency for users when interacting with and requesting / consuming data via dashboard / views on underlying usage policies to be enhanced
  • ContractReference Constraint or configuration of policies specific to one partner only not implemented --> clarification of potential reference to "PURIS standard contract" and enabling of ContractReference for 24.08.
  • unclear meaning of different stati in negotations --> add view of successfull contract agreeements wrt which data have been closed
  • current logging only done on info level --> enhance logging of policies (currently only available at debug level)
  • in case of non-matching policies (tested in various scenarios) no negotiation takes place --> enhance visualization or specific Error message to user
  • no validation of the Schema "profile": "cx-policy:profile2405" (required to ensure interop with other PURIS apps)

Styleguide

Overall

  • Brief description at the top of each page describing content would be nice for better user experience.

Dashboard

  • Similar for Create Delivery (here SOME entries are reset but warnings stay) (block)

Stocks

  • user needs better guidance to click on a stock to update it (else error prone to enter one slightly different attribute and Add instead of update)
  • Refresh -- update request has been sent successfully. -> more information regarding data transfer needed for user

Catalog

  • No action possible -> unclear to user when and how user will consume an offer

Negotiations

  • Add filters for transparency (bpnl, state)

v2.0.0

The following Changelog lists the changes. Please refer to the documentation for configuration needs and understanding the concept changes.

The need for configuration updates is marked bold.

Added

  • Implementation of the following standards relying on Digital Twins and Industry Core
    • Delivery Information Exchange CX-0118, version 2.0.0
    • Short-Term Material Demand Exchange CX-0120, version 2.0.0
    • Planned Production Output Exchange CX-0121, version 2.0.0
    • Item Stock Exchange CX-0122, version 2.0.0
  • Added submodel PartTypeInformation + pull flow of the Catena-X ID for shared assets pattern of the Digital Twin / Industry Core KIT.
  • Implementation of Digital Twins. Added Digital Twin Registry (DTR) as dependency. Used to
    • create and update digital twins for partners
    • query partner materials and determine submodels
  • Added Identity Provider (IDP) support for DTR
    • One user for EDC (read)
    • One user for PURIS (manage)
  • Frontend updates
    • Reworked whole frontend to use React instead of Vue -> better Styleguide conformity as cx components are used.
    • Updated Dashboard
      • Customer view shows own demand, stock and incoming deliveries. You can select customer partner sites to see planned production, stocks and outgoing deliveries.
      • Supplier view shows own planned production, stock and outgoing deliveries. You can select supplier partner sites to see demand, stocks and incoming deliveries.
      • Added manual create / delete for production, deliveries and demand (stock still separate ui).
      • Added projection of stock from latest stock.
      • Added possibility to pull data from partner for demand, planned production and deliveries.
    • Catalog now uses partners and their EDC url (no freehand check possible anymore)
    • Updated user guide and added it to the frontend (help feature)
  • Data Sovereignty
    • Added Membership Credential to all access policies.
    • Added Usage Purpose as mandatory for submodel.
    • Added version to usage purpose and framework agreement.
    • Added consumer side verification of contracts.
  • Infrastructure
    • Digital Twin Registry version 0.4.3 is mandatory
    • Update to Tractus-x EDC version 0.7.3
    • Mock version of IATP compliant MIW for local deployment

Changed

  • Data Sovereignty
    • Updated to be compliant to cx odrl:profile. (No Schema-Validation)
    • Framework Credential now is mandatory (removed backend.frameworkagreement.use)
  • Bump supported EDC version from 0.5.x to 0.7.x
    • Update of EDR flow: Don't use the Http Dynamic Receiver extension anymore as it was removed from EDC 0.7.x. Now uses Tractus-X EDC EDR v2 version getting a fresh token synchronously. EDR Controller to be removed.
    • Terminate transfers after opening.
    • Enhanced reusage of contracts - but still not always possible.
  • Local deployment updated.
    • Version bumps for EDC + switched from in-memory to postgres version.
    • Use one postgres for PURIS, EDC and DTR.
    • Updated keycloak to have a Customer and Supplier realm for DTR IDP configuration.
    • Updated MIW to 0.4.0. Then outcommented MIW as it doesn't support Identity and Trust Protocol (IATP, needed for TX EDC 0.7.x) and added Mock-IAM mocking the needed services.
  • Integration test postman suite
    • Updated test for EDC > new syntax and models.
    • Added tests for new information (demand, planned production, delivery).
    • Added tests for SubmodelDescriptor Setup in DTR.
    • Refatorings for tests.
  • Master Data handling:
    • Store Catena-X ID for product twins of the partner in material partner relationship. Needed due to Digital Twin shared asset approach.
    • Configuration to either let the backend generate your Catena-X ID or to ship it via interface.

Removed

  • Implementation of CX-0122 version 1.0.0 (Request and Response Endpoint)
  • CI: Veracode as license expired

Known Knowns

Security

The Backend is currently secured via API Key while the Frontend already uses an API-KEY. See Admin Guide for further information.

Upgradeability

As currently no active user was known migrations of data are not yet supported. The chart technically is upgradeable.

Data Sovereignty

For productive use the following enhancements are encouraged

  • UI to create and manage contract offers and contracts
  • possibility to add contract references
  • possibility to use multiple Framework or Usage Purpose Constraints in contract policies
  • possibility to define contract policies per partner
  • user feedback on why negotiations failed (currently refresh runs asynchronously and the admin may only get sufficient insights from the logs)

Styleguide

Overall

  • Brief description at the top of each page describing content would be nice for better user experience.
  • Please use different icon for Catalog, Negotiations, Transfers - currently all with
  • Logout button does not work
  • Logout button has trash symbol (block)
  • Footer Component missing

Dashboard

  • DropDown Headers / Field Headers not correctly placed. Other views / data entry / filter screens to be checked.
  • Dashboard currently has larger fond than all other Page Headers -> please unify
  • Create Demand - Day is mandatory and should require an asterix
  • Create Demand - Upon entering data and closing, SOME (not all) entries are preserved (and so are warnings for mandatory fields) --> upon closing and re-opening information should be reset to default. (block)
  • Similar for Create Delivery (here SOME entries are reset but warnings stay) (block)

Stocks

  • Switch between Material Stocks and Product Stocks -> same layout adaption as for Dashboard suggested (see above)
  • Like the functionality that by clicking on a stock, data gets entered for add/update -> user needs better guidance to do this (else error prone to enter one slightly different attribute and Add instead of update)
  • Refresh -- update request has been sent successfully. -> more information regarding data transfer needed for user

Catalog

  • Usage Policies are called "Asset Action"
  • Header Name should be "View Connector Catalog" or "View Partner Catalog"
  • No action possible -> unclear to user when and how user will consume an offer
  • List shows a couple of items and item view takes up quite some space --> maybe use a table instead to show more items in overview
  • Delay in loading results and first "No Catalog available..." shown and then load items

Negotiations

  • Similar as Catalog
  • Add filters for transparency (bpnl, state)

v1.0.0

Added

  • Initial version implementing CX-0122 version 1.0.0

Changed

  • N/A

Removed

  • N/A

Security

  • N/A

Known Knowns

The application currently is not compliant to the Catena-X Styleguide. It will be updated for R24.05.
⚡