Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Concept: Provisioning of contract negotiation and contract agreement for assets #322

Closed
1 of 10 tasks
mkanal opened this issue Dec 5, 2023 · 4 comments
Closed
1 of 10 tasks

Concept: Provisioning of contract negotiation and contract agreement for assets #322

mkanal opened this issue Dec 5, 2023 · 4 comments
Assignees
@ds-jhartmann @mkanal
Labels
concept concept work dependencies Pull requests that update a dependency file feature Issue with a feature request linked_to_feature Issue is linked to a feature

Comments

@mkanal
Copy link
Contributor

mkanal commented Dec 5, 2023 •
edited
Loading

As Trace-X
I want contract negotiation and contract agreements information for received assets
so that I am able to audit the data contracts, assets were retrieved

Branch

Hints / Details

Outcome / Acceptance Criteria

Outcome

Collaboration Meeting with Trace-X

  1. Collecting contract agreement ids for assets is mandatory for Trace-X. Agreed to enable and disable the collection of ids for performance reasons could be managed over an API parameter. Wish would be to have this parameter activated by default.
  2. To make this easier to handle and to have non-invasive code changes, Trace-X prefers the non-normalized form of implementation. For each submodel and each AAS shell, the id should be available in the JobResponse even if it is identical several times.
  3. Trace-X has access to the EDC Consumer Management API of IRS
  4. Access to EDC management api should be covered by IRS Client Library

Acceptance Criteria

  • Collaboration Meeting with Trace-X has been conducted and results are documented
  • Concept available which covers
    • Provisioning of required identifications for contract negation and contract agreement id edc:ContractAgreementDto@id
    • IRS provides the ContractAgreeementId for data asset in JobResponse on demand
    • How the business app can request the edc:ContractAgreement and ContractNegotation Payload to visualize the required results
    • Specify the time period the ContractAgreeementId payload and ContractNegotation payload should be accessible and be available for the business app - according to that decide if information should be stored in IRS or stored in the EDC. How long does the EDC store this information and is it sufficient to store this in the EDC - (10 years according to law)
  • Tickets are created in backlog

Out of Scope

  • ...

Clarification

  • Can Trace-X access the management API of the IRS EDC?
  • Should the EDC Management API of the IRS be configured in the business application or should the url be supplied via the JobResponse?
  • Does the business app have access to the management API of the EDC configured for the IRS
@mkanal mkanal added this to IRS Dec 5, 2023
@mkanal mkanal moved this to inbox in IRS Dec 5, 2023
@mkanal mkanal changed the title Provissioning of contract negotation and contract assessment for assets Provisioning of contract negotiation and contract assessment for assets Dec 6, 2023
@jzbmw
Copy link
Contributor

jzbmw commented Dec 6, 2023

How about the solution to extend the API for an API regarding contracts and negotiations?

@jzbmw jzbmw added the DISCUSSION_NEEDED This ticket needs discussion within teammembers label Dec 6, 2023
@ds-jhartmann
Copy link
Contributor

Since Trace-X (or any other service which uses the IRS) are the ones managing the IRS EDC, another suggestion would be to extend the registry/edc library with the required requests to the EDC, so Trace-X is able to gather the contracts themselves.

@mkanal
Copy link
Contributor Author

mkanal commented Dec 14, 2023

Decision @jzbmw and @ds-jhartmann

  • Provisioning of ContractAgreementDto:@id via IRS JobReponse. This is the unique artifact which is required to resolve the ContractAgreement / ContractNegoation and Asset
  • How to resolve the EDC url and API Key of the IRS EDC via API Key ?

Contract neg id and agreement id are stored in the job response - access to the respective content is via the EDC Management API

Pro

  • No need to store contract data in IRS

Contra

  • Trace-X MUST have access to EDC of IRS - no good design as IRS proxies the access to EDC in general

Job response covers the complete payload of contract agreement and negotiation

Pro

  • Contact must not be stores in IRS
  • Data are forwarded to consumer in general

Contra

  • Exponential grow of JobResponse on complex data chains

Specification

edc:ContractAgreementDto
"@id": "YjA4NjdmMjgtYWMwMC00OTdiLTliMTItNGEzZDdkYjk4YmEw:cmVnaXN0cnktYXNzZXQ=:YWI2MTY5ZDctNzdiYi00YTQ1LTljZTYtZTUzZjhjM2MwYTFm"

@jzbmw jzbmw added dependencies Pull requests that update a dependency file feature Issue with a feature request labels Dec 20, 2023
@jzbmw jzbmw moved this from inbox to backlog in IRS Dec 20, 2023
@jzbmw jzbmw removed the DISCUSSION_NEEDED This ticket needs discussion within teammembers label Dec 20, 2023
@mkanal mkanal moved this from backlog to next in IRS Jan 9, 2024
@mkanal mkanal added the concept concept work label Jan 9, 2024
@mkanal mkanal moved this from next to wip in IRS Jan 11, 2024
@mkanal mkanal self-assigned this Jan 11, 2024
@mkanal mkanal changed the title Provisioning of contract negotiation and contract assessment for assets Provisioning of contract negotiation and contract aggreement for assets Jan 12, 2024
@mkanal
Copy link
Contributor Author

mkanal commented Jan 12, 2024

@jzbmw

Collaboration Meeting with Trace-X

Outcome

  1. Collecting contract agreement ids for assets is mandatory for Trace-X. Agreed to enable and disable the collection of ids for performance reasons could be managed over an API parameter. Wish would be to have this parameter activated by default.
  2. To make this easier to handle and to have non-invasive code changes, Trace-X prefers the non-normalized form of implementation. For each submodel and each AAS shell, the id should be available in the JobResponse even if it is identical several times.
  3. Trace-X has access to the EDC Consumer Management API of IRS
  4. Access to EDC management api should be covered by IRS Client Library

@mkanal mkanal added the linked_to_feature Issue is linked to a feature label Jan 15, 2024
@mkanal mkanal changed the title Provisioning of contract negotiation and contract aggreement for assets Concept: Provisioning of contract negotiation and contract agreement for assets Jan 18, 2024
@mkanal mkanal mentioned this issue Jan 18, 2024
Closed
16 tasks
@mkanal mkanal moved this from wip to review in IRS Jan 19, 2024
@jzbmw jzbmw moved this from review to done in IRS Jan 22, 2024
@jzbmw jzbmw closed this as completed Jan 22, 2024
ds-jhartmann pushed a commit that referenced this issue Jan 23, 2024
@mkanal
chore(#322):[#322] prepare template for concept
7f14aa4
ds-jhartmann pushed a commit that referenced this issue Jan 23, 2024
@mkanal
chore(concept):[#322] add initial concept
5d46bc9
ds-jhartmann pushed a commit that referenced this issue Jan 23, 2024
@mkanal
chore(concept):[#322] add requirements and initial idea how to store …
0a21ff3 
…contractAgreementId
ds-jhartmann pushed a commit that referenced this issue Jan 23, 2024
@mkanal
chore(concept):[#322] add edc management api endpoints and abstract d…
adf5ef4 
…efinition
ds-jhartmann pushed a commit that referenced this issue Jan 23, 2024
@mkanal
chore(concept):[#322] alignment meeting with trace-x follow ups
a044034
ds-jhartmann pushed a commit that referenced this issue Jan 23, 2024
@mkanal
chore(concept):[#322] add sequence diagram for receiving EDR token
d23b925
ds-jhartmann pushed a commit that referenced this issue Jan 23, 2024
@mkanal
chore(concept):[#322] adapted toc
c73097d
ds-jhartmann pushed a commit that referenced this issue Jan 23, 2024
@mkanal
chore(concept):[#322] adapted toc of template
50d115b
ds-jhartmann pushed a commit that referenced this issue Jan 23, 2024
@mkanal
chore(concept):[#322] adjusted fontfamiliy because of readabiliy reasons
4d9262d
ds-jhartmann pushed a commit that referenced this issue Jan 23, 2024
@mkanal
chore(concept):[#322] adjusted the concept first corrections
71487e8
ds-jhartmann pushed a commit that referenced this issue Jan 23, 2024
@mkanal
chore(concept):[#322] typo and corrections filled missing summary
edf9163
ds-jhartmann added a commit that referenced this issue Jan 23, 2024
@mkanal @ds-jhartmann
chore(concept):[#322] Update docs/concept/#322-Provisioning-of-contra…
0873179 
…ct-definiton-for-assets/#322-Provisioning-of-contract-definiton-for-assets.md

Co-authored-by: Jaro Hartmann <[email protected]>
ds-jhartmann added a commit that referenced this issue Jan 23, 2024
@mkanal @ds-jhartmann
chore(concept):[#322] Update docs/concept/#322-Provisioning-of-contra…
cb510ed 
…ct-definiton-for-assets/#322-Provisioning-of-contract-definiton-for-assets.md

Co-authored-by: Jaro Hartmann <[email protected]>
ds-jhartmann added a commit that referenced this issue Jan 23, 2024
@mkanal @ds-jhartmann
chore(concept):[#322] Update docs/concept/#322-Provisioning-of-contra…
9a5f848 
…ct-definiton-for-assets/#322-Provisioning-of-contract-definiton-for-assets.md

Co-authored-by: Jaro Hartmann <[email protected]>
ds-jhartmann added a commit that referenced this issue Jan 23, 2024
@mkanal @ds-jhartmann
chore(concept):[#322] Update docs/concept/#322-Provisioning-of-contra…
4803eea 
…ct-definiton-for-assets/#322-Provisioning-of-contract-definiton-for-assets.md

Co-authored-by: Jaro Hartmann <[email protected]>
ds-jhartmann added a commit that referenced this issue Jan 23, 2024
@mkanal @ds-jhartmann
chore(concept):[#322] Update docs/concept/#322-Provisioning-of-contra…
747ea9e 
…ct-definiton-for-assets/#322-Provisioning-of-contract-definiton-for-assets.md

Co-authored-by: Jaro Hartmann <[email protected]>
ds-jhartmann pushed a commit that referenced this issue Jan 23, 2024
@mkanal
chore(concept):[#322] add title and rename files
707d1f3 
 typo and corrections filled missing summary
ds-jhartmann pushed a commit that referenced this issue Jan 23, 2024
@mkanal
chore(concept):[#322] remove html links in toc
d834f60
ds-jhartmann pushed a commit that referenced this issue Jan 23, 2024
@mkanal
chore(concept):[#322] add changelog entry
0fda2a6
ds-jhartmann pushed a commit that referenced this issue Jan 23, 2024
@mkanal
fix(concept):[#322] fix review comments
47cfa23
ds-jhartmann pushed a commit that referenced this issue Jan 23, 2024
@mkanal
fix(concept):[#322] remove <> from status add sequence diagram for ca…
54cdfc8 
…se 3
ds-jhartmann added a commit that referenced this issue Jan 23, 2024
@ds-jhartmann
chore(concept):[#322] Formatting
a95adb0
ds-jhartmann added a commit that referenced this issue Jan 23, 2024
@ds-jhartmann
chore(concept):[#322] Formatting
e2b69ae
ds-jhartmann added a commit that referenced this issue Jan 23, 2024
@ds-jhartmann
Merge pull request #724 from catenax-ng/chore/#322-Provisioning-of-co…
0746ce4 
…ntract-negotiation-and-contract-assessment-for-assets

Chore/#322 provisioning of contract negotiation and contract assessment for assets
ds-jhartmann pushed a commit that referenced this issue Jan 23, 2024
@mkanal
chore(concept):[#322] correct tombstone using UsagePolicyValidation
ebff564
ds-jhartmann added a commit that referenced this issue Jan 23, 2024
@ds-jhartmann
Merge pull request #730 from catenax-ng/chore/#322-Provisioning-of-co…
cab0c48 
…ntract-aggreement-id

chore(concept):[#322] correct tombstone using UsagePolicyValidation
ds-jhartmann pushed a commit that referenced this issue Apr 19, 2024
@dsmf
chore(owasp): [#530] replace "ID 3.0 Trace" with "ID 3.1 Trace" - adj…
c351848 
…ust #322 concept
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ds-jhartmann ds-jhartmann

@mkanal mkanal

Labels
concept concept work dependencies Pull requests that update a dependency file feature Issue with a feature request linked_to_feature Issue is linked to a feature
Projects
IRS
Status: done
Milestone
No milestone
Development

No branches or pull requests
3 participants
@jzbmw @ds-jhartmann @mkanal