chore(concept): 638 ContractAgreement admin view

CHANGELOG.md

@@ -6,18 +6,20 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [UNRELEASED - DD.MM.YYYY]
+
 ### Added
-- JSON Schema generation for valid submodel mapping
+- Added concept #638: Contract agreement admin view
 - Added support for meta key for multi sorting on tables
-  Added error description and retry button to error toast when creating notifications
 
 ### Changed
-- sring-core bumped from 6.0.16 to 6.0.17
-- IRS Response Mapper
-- updated user manual
+- Spring-core bumped from 6.0.16 to 6.0.17
+- Updated user manual
+- JSON Schema generation for valid submodel mapping
+- Added support for meta key for multi sorting on tables
+- Added error description and retry button to error toast when creating notifications
 
 ### Removed
-- removed EDC notification asset classes and replaced with IRS lib implementation
+- Removed EDC notification asset classes and replaced with IRS lib implementation
 
 ## [10.5.0 - 22.02.2024]
 

docs/concept/Concept_TEMPLATE.md → docs/concept/#000-concept-name-template/#000-concept-name-template.md

@@ -2,7 +2,7 @@
 
 | Key           | Value             |
 |---------------|-------------------|
-| Autor         | <name>            |
+| Author        | <name>            |
 | Creation date | <DD.MM.YYYY>      |
 | Ticket Id     | <ID> <url>        |
 | State         | <DRAFT,WIP, DONE> |

docs/concept/#638-contractagreement-admin-view/get-all-contracts-sequenceflow.puml

@@ -0,0 +1,50 @@
+@startuml
+title
+    ==POST api/contracts/request
+end title
+
+autonumber "<B>[00]"
+
+participant "Trace-X Frontend" as FE order 0
+participant "Trace-X Backend" as BE order 1
+participant "Trace-X Database" as DB order 2
+participant "EDC" as EDC order 3
+
+FE -> BE: POST api/contracts/request (limit, offset, sort, filter)
+
+activate BE
+BE -> DB: Fetch requested distinct contractAgreementIds
+activate DB
+autonumber stop
+DB --> BE: List(contractAgreementIds)
+autonumber resume
+deactivate DB
+
+BE -> EDC: POST tx-edc/management/v2/contractagreements/request \nfiltered by contractAgreementIds
+activate EDC
+autonumber stop
+EDC --> BE: JSON response
+autonumber resume
+deactivate EDC
+BE -> BE: Extract contractSigningDate, policy
+activate BE
+deactivate BE
+
+loop for all contractAgreementIds
+BE -> EDC: GET tx-edc/management/v2/contractagreements/{contractAgreementId}/negotiation
+activate EDC
+autonumber stop
+EDC --> BE: JSON response
+autonumber resume
+deactivate EDC
+BE -> BE: Extract id, counterPartyAddress, state
+activate BE
+deactivate BE
+end
+
+autonumber stop
+BE --> FE: JSON response
+autonumber resume
+deactivate BE
+
+@enduml

docs/concept/#638-contractagreement-admin-view/get-contract-sequenceflow.puml

@@ -0,0 +1,47 @@
+@startuml
+title
+    ==GET api/contracts/{tx-assetId}
+end title
+
+autonumber "<B>[00]"
+
+participant "Trace-X Frontend" as FE order 0
+participant "Trace-X Backend" as BE order 1
+participant "Trace-X Database" as DB order 2
+participant "EDC" as TXEDC order 3
+
+FE -> BE: GET api/contracts/{tx-assetId}
+
+activate BE
+BE -> DB: Take contractAgreementId for tx-assetId
+activate DB
+autonumber stop
+DB --> BE: contractAgreementId
+autonumber resume
+deactivate DB
+
+BE -> TXEDC: GET tx-edc/management/v2/contractagreements/{contractAgreementId}
+activate TXEDC
+autonumber stop
+TXEDC --> BE: JSON response
+autonumber resume
+deactivate TXEDC
+BE -> BE: Extract contractSigningDate, policy
+activate BE
+deactivate BE
+
+BE -> TXEDC: GET tx-edc/management/v2/contractagreements/{contractAgreementId}/negotiation
+activate TXEDC
+autonumber stop
+TXEDC --> BE: JSON response
+autonumber resume
+deactivate TXEDC
+BE -> BE: Extract id, counterPartyAddress, state
+activate BE
+deactivate BE
+
+autonumber stop
+BE --> FE: JSON response
+deactivate BE
+
+@enduml