3.2.0

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)

Known Knowns

Upgradeability

Currently no migrations for edc and dtr data is provided.

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)

puris-4.0.0

A helm chart for Kubernetes deployment of PURIS

3.1.0

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)

puris-3.0.1

A helm chart for Kubernetes deployment of PURIS

puris-3.0.0

A helm chart for Kubernetes deployment of PURIS

3.1.0-rc1

3.1.0-rc1

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)

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)

puris-2.9.0

A helm chart for Kubernetes deployment of PURIS

puris-2.8.1

A helm chart for Kubernetes deployment of PURIS

3.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
  • peter-evans/dockerhub-description from 3.4.2 to 4.0.0 (#460)
  • actions/checkout from 4.1.6 to 4.2.3 (#461, #629, #607, #646)
  • actions/setup-node from 4.0.2 to 4.1.0 (#552, #594, #650)
  • trufflesecurity/trufflehog from 3.80.2 to 3.82.13 (#544, #557, #571, #588, #603, #608, #610, #630, #636, #639, #651)
  • docker/setup-buildx-action from 3.3.0 to 3.7.1 (#553, #618)
  • docker/login-action from 3.1.0 to 3.3.0 (#548)
  • docker/setup-qemu-action from 3.0.0 to 3.2.0 (#549)
  • github/codeql-action from 3.25.10 to 3.26.13 (#545, #558, #567, #569, #589, #593, #604, #614, #624, #632, #645)
  • actions/setup-java from 3.13.0 to 4.5.0 (#535, #605, #628, #649)
  • docker/build-push-action from 5.3.0 to 6.9.0 (#543, #612)
  • actions/setup-python from 5.1.1 to 5.2.0 (#570) to 5.3.0 (#648)
  • checkmarx/kics-github-action from 2.1.0 to 2.1.3 (#560, #619)
  • aquasecurity/trivy-action from 0.22.0 to 0.24.0 (#559,#627, #635)
  • keycloak-js from 23.0.5 to 25.0.6 in /frontend (#595)

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 dedi...

3.0.0-rc2

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
  • peter-evans/dockerhub-description from 3.4.2 to 4.0.0 (#460)
  • actions/checkout from 4.1.6 to 4.2.3 (#461, #629, #607, #646)
  • actions/setup-node from 4.0.2 to 4.1.0 (#552, #594, #650)
  • trufflesecurity/trufflehog from 3.80.2 to 3.82.13 (#544, #557, #571, #588, #603, #608, #610, #630, #636, #639, #651)
  • docker/setup-buildx-action from 3.3.0 to 3.7.1 (#553, #618)
  • docker/login-action from 3.1.0 to 3.3.0 (#548)
  • docker/setup-qemu-action from 3.0.0 to 3.2.0 (#549)
  • github/codeql-action from 3.25.10 to 3.26.13 (#545, #558, #567, #569, #589, #593, #604, #614, #624, #632, #645)
  • actions/setup-java from 3.13.0 to 4.5.0 (#535, #605, #628, #649)
  • docker/build-push-action from 5.3.0 to 6.9.0 (#543, #612)
  • actions/setup-python from 5.1.1 to 5.2.0 (#570) to 5.3.0 (#648)
  • checkmarx/kics-github-action from 2.1.0 to 2.1.3 (#560, #619)
  • aquasecurity/trivy-action from 0.22.0 to 0.24.0 (#559,#627, #635)
  • keycloak-js from 23.0.5 to 25.0.6 in /frontend (#595)

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 dedi...