Skip to content

Commit

Permalink
deploy: b60ea8c
Browse files Browse the repository at this point in the history
  • Loading branch information
@ds-mwesener
ds-mwesener committed Jul 25, 2024
1 parent 5980b10 commit 10febb9
Show file tree
Hide file tree
Showing 145 changed files with 545 additions and 8,415 deletions.
2 changes: 1 addition & 1 deletion docs/administration/administration-guide.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1732,7 +1732,7 @@ <h2 id="_troubleshooting">Troubleshooting</h2>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-24 08:07:16 UTC
Last updated 2024-07-25 07:15:01 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/administration/backend-configuration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1179,7 +1179,7 @@ <h3 id="_pgadmin4_ingress_enabled">&lt;pgadmin4.ingress.enabled&gt;</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-24 08:07:16 UTC
Last updated 2024-07-25 07:15:01 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/administration/configuration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1424,7 +1424,7 @@ <h3 id="_retrieve_wallet_configuration">Retrieve wallet configuration</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-24 08:07:16 UTC
Last updated 2024-07-25 07:15:01 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/administration/frontend-configuration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -519,7 +519,7 @@ <h4 id="_readinessprobe">&lt;readinessProbe&gt;</h4>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-24 08:07:16 UTC
Last updated 2024-07-25 07:15:01 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/administration/installation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -750,7 +750,7 @@ <h2 id="_deployment_using_argocd">Deployment using ArgoCD</h2>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-24 08:07:16 UTC
Last updated 2024-07-25 07:15:01 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/administration/portal-configuration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -671,7 +671,7 @@ <h2 id="_retrieve_wallet_configuration">Retrieve wallet configuration</h2>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-24 08:07:16 UTC
Last updated 2024-07-25 07:15:01 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/administration/system-overview.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -640,7 +640,7 @@ <h2 id="_rights_and_role_matrix_of_trace_x">Rights and role matrix of Trace-X</h
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-24 08:07:16 UTC
Last updated 2024-07-25 07:15:01 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/administration/troubleshooting.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,7 @@ <h1>Troubleshooting</h1>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-24 08:07:16 UTC
Last updated 2024-07-25 07:15:01 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/api-specification/api-specification.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -503,7 +503,7 @@ <h1>Trace-X API</h1>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-24 08:07:16 UTC
Last updated 2024-07-25 07:15:01 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/api-specification/api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -455,7 +455,7 @@ <h1>Trace-X API</h1>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-24 08:07:16 UTC
Last updated 2024-07-25 07:15:01 UTC
</div>
</div>
</body>
Expand Down
61 changes: 42 additions & 19 deletions docs/arc42.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -445,32 +445,55 @@ However, to be sure that data is shared only with companies that match one’s r
The policies used for sending and receiving notifications and parts have an identical data format, so they can be used for each process interchangeably.
The processes itself are different and will be explained here:

### Policy Types

The EDC Connector MUST provide a possibility to restrict the access of a Data Asset to specific business partners by attribute(s), e.g., represented as a VC.
The Connector MUST restrict the data usage to partners and purposes for a specific use case.

There are two policy types used.
* Access
* Usage

As specified by the [Dataspace Protocol](https://github.com/International-Data-Spaces-Association/ids-specification), one Data Asset MUST refer to at least one Usage Policy, expressed in ODRL.
For additional information refer to [Connector KIT](https://eclipse-tractusx.github.io/docs-kits/kits/Connector%20Kit/Adoption%20View/connector_kit_adoption_view)

### Policies for sending and receiving parts

![arc42_015](https://eclipse-tractusx.github.io/traceability-foss/docs/assets/arc42/arc42_015.png)

| | |
| --- | --- |
| 1, 2 | Policies can be created by administrators at any time in the administration section of Trace-X. |
| 3 | Parts can be imported at any time in the parts section of Trace-X. They will be stored locally at first. |
| 4 | Before connected BPNs can access the imported parts, the parts must be published to the EDC and to the Digital Twin Registry (DTR). |
| 5 | The user must choose the policy that is used for contract negotiation of the selected parts. |
| 6 | The policy is created in the EDC. |
| 7 | Each part is created as a shell in the DTR. This holds all the data of the part. |
| 8 | The created part is linked to the policy from the EDC. This is the last step of data provisioning. Trace-X A has done everything to ensure that companies that have a matching policy can access its published parts. |
| 9 | Trace-X B wants to synchronize parts and retrieve available ones from connected BPNs. In this case Trace-X A and Trace-X B have an established connection. |
| 10 | For part synchronization the Item Relationship Service (IRS) is requested. |
| 11 | First the IRS must know the policies that are used by Trace-X B, so it requests them directly. |
| 12 | Trace-X B returns a list of the configured policies depending on the configuration done by the administrator in step 2. |
| 13 | The IRS requests the catalog from Trace-X A. In the catalog, all policies of Trace-X A are stored. |
| 14 | The EDC of Trace-X A provides the catalog. |
| 15 | The IRS checks the catalog for the required policies and extracts them. |
| 16 | Now that the IRS has all the relevant policies of both companies, it can start comparing the linked policy of each part to the policy list of Trace-X B. This works by comparing the included constraints logically. If no policy matches for a part, it will not be imported. |
| 17, 18 | If the policy of the part matches with any policy of Trace-X A, a contract agreement is created for both Trace-X A and Trace-X B. It can be viewed in the administration section of Trace-X and documents the data exchange. |
| 19 | Now that the contract negotiation was successful, the data consumption process can take place for that part. |
| 1 | Policies can be created by User with role 'Admin' at any time in the administration section of Trace-X. The policy is created to later used for publishing assets in the current company context. |
| 2 | Policies are stored in the PolicyStore which is a shared component used by Trace-X [A] app and IRS for storing usage and access policies. |
| 3 | Policy is created in the policy store. |
| 4 | User with role 'Admin' receives feedback that creation of policy was successful. |
| 5, 6 | User with role 'Admin' imports assets in Admin section of Trace-X [A]. Parts can be imported at any time in the parts section of Trace-X. They will be stored locally at first. [Testdata for asset import](https://github.com/eclipse-tractusx/traceability-foss/tree/main/tx-backend/testdata) |
| 7 | User with role 'Admin' selects assets in transient state in application. |
| 8 | User with role 'Admin' is requested to define a policy for assets publishing. |
| 9 | User with role 'Admin' selects policy under which assets are published. The user must choose the policy that is used for contract negotiation of the selected parts. |
| 10, 11 | Assets are created in the EDC. (POST /v3/assets) |
| 12,13 | Trace-X [A] BE checks if PolicyDefinition for selected policy already exists. |
| 14,15 | In case PolicyDefinition does not exist. New PolicyDefinition is created in EDC [A]. The PolicyDefinition is created in the EDC. |
| 16,17 | The created part is linked in the PolicyDefinition from the EDC. This is the last step of data provisioning. Trace-X [A] has done everything to ensure that companies that have a matching policy can access its published parts. |
| 18,19 | Each part is created as a shell in the DTR. This holds all the data of the part. Before connected BPNs can access the imported parts, the parts must be published to the EDC and to the Digital Twin Registry (DTR). |
| 20,21 | User with role 'Admin' in Trace-X [B] creates policy for consuming assets of Trace-X [A]. |
| 22 | Trace-X [B] wants to synchronize parts and retrieve available ones from connected BPNs. In this case Trace-X [A] and Trace-X [B] have an established connection. |
| 23,24 | Trace-X [B] requests for globalAssetIds (unique identifier of digital twins (Asset Administration Shell)) in decentral Digital Twin registry. |
| 25 | For part synchronization a synchronization job is started in the Item Relationship Service (IRS) . |
| 26,27 | IRS requests for CatalogOffer for globalAssetsIds passed by Trace-X [A] |
| 28 | IRS extracts policies from CatalogOffer |
| 29,30 | IRS requests for policies defined for BPNL of Trace-X [A] in PolicyStore of Trace-X [B] |
| 31 | Now that the IRS has all the relevant policies of both companies, it can start comparing the linked policy of each part to the policy list of Trace-X B. This works by comparing the included constraints logically. If no policy matches for a part, it will not be imported. |
| 32,33,34 | If the policy of the part matches with any policy of Trace-X A, a contract agreement is created for both Trace-X A and Trace-X B. It can be viewed in the administration section of Trace-X and documents the data exchange. Since the contractAgreementId will be mapped to an submodel of IRS. The contracts can be seen after IRS responded to Trace-X initial sync call with the submodels including the contractAgreementId. |
| 35 | Now that the contract negotiation was successful, the data consumption process can take place for that part. |
| 36 | In case policy does not match IRS created tombstone. |
| 37 | IRS callbacks Trace-X [B] Instance after completing job processing. ContractAgreementId for asset is available in Trace-X passed in IRS JobResponse. |

It’s possible to publish parts with different policies. For this, the user must only publish a limited selection of parts for which he can select a policy. For the parts that must be published with different policies, the user can repeat the process.

***Note***:
For more detailed information concerning the functionality of IRS please refer to [IRS documentation](https://eclipse-tractusx.github.io/item-relationship-service/docs/)

***[Work-in-progress]*** The user may also choose parts that have already been published - they can be republished with a different policy. The process for this is identical to the regular publishing process.

### Policies for sending and receiving notifications
Expand All @@ -491,7 +514,7 @@ It’s possible to publish parts with different policies. For this, the user mus
| 11 | Finally, the notification will be sent to the receiving EDC. |
| 12 | If no policies match, an error will be returned to the user. |

#### No policies when sending notifications
#### No policies defined for Receiver BPNL when sending notifications

![arc42_017](https://eclipse-tractusx.github.io/traceability-foss/docs/assets/arc42/arc42_017.png)

Expand All @@ -501,7 +524,7 @@ If no policies are configured for the receiving BPN and a notification is sent t

![arc42_018](https://eclipse-tractusx.github.io/traceability-foss/docs/assets/arc42/arc42_018.png)

Policies always have an expiration time. When a notification is sent and there are policies configured for the selected BPN with an expiration time in the past, Trace-X will throw an error. In that case, an administrator must either update the policy. Then the policy can be resent.
Policies always have an expiration time defined by the 'validUntil' timestamp. When a notification is sent and there are policies configured for the selected BPN with an expiration time in the past, Trace-X will throw an error. In that case, an administrator must either update the policy. Then the policy can be resent.

#### Testing policies

Expand Down
2 changes: 1 addition & 1 deletion docs/arc42/.asciidoctor/diagram/business-context_data_provisioning_1.svg.cache
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"checksum":"plantuml-md5-315ce92b51dfd38a033aa2d5d09b3de0","options":{"size_limit":"4096"},"width":707,"height":612}
{"checksum":"plantuml-md5-28b8d50741070fe5d1033236c9ac66a6","options":{"size_limit":"4096"},"width":775,"height":612}
2 changes: 1 addition & 1 deletion docs/arc42/.asciidoctor/diagram/business-context_data_provisioning_2.svg.cache
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"checksum":"plantuml-md5-5518f4e64cd8cf0c0c0ee4643904fed3","options":{"size_limit":"4096"},"width":751,"height":490}
{"checksum":"plantuml-md5-b39e30ca6b2f1a8cae86837ab7599a55","options":{"size_limit":"4096"},"width":733,"height":490}
2 changes: 1 addition & 1 deletion docs/arc42/.asciidoctor/diagram/business-context_data_provisioning_3.svg.cache
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"checksum":"plantuml-md5-931ba42280d21c933509b8a45ba7f1c1","options":{"size_limit":"4096"},"width":710,"height":843}
{"checksum":"plantuml-md5-3508c2da05b450afabee7cce4ba854c0","options":{"size_limit":"4096"},"width":701,"height":843}
2 changes: 1 addition & 1 deletion docs/arc42/.asciidoctor/diagram/data-sovereignty-expired-policy.svg.cache
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"checksum":"plantuml-md5-c05bbfb2cb6fd0224348fc488a3d199c","options":{"size_limit":"4096"},"width":739,"height":677}
{"checksum":"plantuml-md5-f08ae3d08a42db5f1801c10ece0b4b02","options":{"size_limit":"4096"},"width":772,"height":677}
2 changes: 1 addition & 1 deletion docs/arc42/.asciidoctor/diagram/data-sovereignty-notifications-policy-change.svg.cache
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"checksum":"plantuml-md5-8e9b530945ecbfe7e90c5b3f986e3194","options":{"size_limit":"4096"},"width":835,"height":751}
{"checksum":"plantuml-md5-95c084274597b267c4255bb26575b648","options":{"size_limit":"4096"},"width":987,"height":798}
2 changes: 1 addition & 1 deletion docs/arc42/.asciidoctor/diagram/data-sovereignty-publish-assets.svg.cache
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"checksum":"plantuml-md5-1f0a855c99c1208b84077152e76c904c","options":{"size_limit":"4096"},"width":1338,"height":1004}
{"checksum":"plantuml-md5-2cd9c651ba583541c99cea5b8bcec4cd","options":{"size_limit":"4096"},"width":3310,"height":1861}
2 changes: 1 addition & 1 deletion docs/arc42/.asciidoctor/diagram/import-report-receive.svg.cache
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"checksum":"plantuml-md5-013f4ad262aaba55cb0aad8468302d9f","options":{"size_limit":"4096"},"width":1732,"height":542}
{"checksum":"plantuml-md5-b6efae601f52777ca7b3931dc5e79bf2","options":{"size_limit":"4096"},"width":1678,"height":542}
2 changes: 1 addition & 1 deletion docs/arc42/.asciidoctor/diagram/publish-assets-error.svg.cache
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"checksum":"plantuml-md5-703c4fa2b6d1d3e0514de32411edd492","options":{"size_limit":"4096"},"width":680,"height":413}
{"checksum":"plantuml-md5-d9c820402344178506110e8159aabc98","options":{"size_limit":"4096"},"width":662,"height":413}
2 changes: 1 addition & 1 deletion docs/arc42/.asciidoctor/diagram/publish-assets.svg.cache
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"checksum":"plantuml-md5-3c19451ea0bfc3d5f99dfa231c0f6bca","options":{"size_limit":"4096"},"width":425,"height":299}
{"checksum":"plantuml-md5-18a60b7a82374ecf51430df3dd61380f","options":{"size_limit":"4096"},"width":407,"height":299}
2 changes: 1 addition & 1 deletion docs/arc42/.asciidoctor/diagram/return-all-contracts.svg.cache
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"checksum":"plantuml-md5-273ad87547aa59d0071050883e0f0140","options":{"size_limit":"4096"},"width":1105,"height":554}
{"checksum":"plantuml-md5-c8da37af22a245698c832edf8e8ed0ab","options":{"size_limit":"4096"},"width":1150,"height":608}
Loading

0 comments on commit 10febb9

Please sign in to comment.