docs: DCM-Kit Content Release 24.03 #677
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| --- | ||
| id: changelog | ||
| title: Changelog | ||
| description: 'What has changed recently?' | ||
| sidebar_position: 1 | ||
| --- | ||
|
|
||
|  | ||
|
|
||
| ## DCM KIT Changelog | ||
|
|
||
| All notable changes to this Kit will be documented in this file. | ||
|
|
||
| ## [0.2.0] - 2024-03-08 | ||
|
|
||
| ### Added | ||
|
|
||
| - Added Architecture View | ||
| - Added IdBasedRequestForUpdate data model reference to Adoption View | ||
| - Added IdBasedComment data model reference to Adoption View | ||
| - Added IdBasedRequestForUpdate data model chapter to Development View | ||
| - Added IdBasedComment data model chapter to Development View | ||
| - Added IdBasedRequestForUpdate API chapter to Development View | ||
| - Added IdBasedComment API chapter to Development View | ||
|
|
||
| ### Changed | ||
|
|
||
| - Updated DCM standard references in Adoption View (Merged CX-0046, CX-0047 and CX-0048 into CX-0128) | ||
| - Updated data model references in Adoption View | ||
| - Updated MaterialDemand data model chapter to new data models and versions (Replaced WeekBasedMaterialDemand with MaterialDemand aspect model) | ||
| - Updated WeekBasedCapacityGroup data model chapter to new data models and versions | ||
| - Updated MaterialDemand API chapter to new API definitions | ||
| - Updated WeekBasedCapacityGroup API chapter to new API definitions | ||
|
|
||
| ### Removed | ||
|
|
||
| n/a | ||
|
|
||
| ## [0.1.0] - 2023-03-01 | ||
|
|
||
| ### Added | ||
|
|
||
| - Adoption View | ||
| - Development View | ||
|
|
||
| ### Changed | ||
|
|
||
| n/a | ||
|
|
||
| ### Removed | ||
|
|
||
| n/a |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| --- | ||
| id: architecture-view | ||
| title: Architecture View | ||
| description: The view from above | ||
| sidebar_position: 4 | ||
| --- | ||
|
|
||
|  | ||
|
|
||
| ## Why | ||
|
|
||
| This page is relevant for you, if one of the following cases applies: | ||
|
|
||
| 1. You want to participate in the demand and capacity usecase as either a customer or a supplier and intend to adapt your existing custom application landscape to Catena-X DCM. | ||
| 2. You want to offer business solutions to the aforementioned customers and suppliers by adapting your commercial software product for Catena-X DCM. | ||
|
|
||
| If non of this applies to you or you are unsure, please refer to DCM guideline for solution adoption first. | ||
|
|
||
| Note: if you purchase commercial software from a software vendor, the vendor needs to adopt their software for you. Please refer your vendor to this page. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| In order to participate in the Catena-X network an Eclipse Dataspace Connector (EDC) is required, as the endpoints must not be called directly but only through an EDC. | ||
|
|
||
| In addition use case participants need to be boarded onto the Catena-X network. | ||
|
|
||
| Participants intending to act as a customer require at least one BPNL for their company as well as one BPNS for every site they intend to integrate into the Catena-X network. | ||
|
|
||
| Participants intending to act as a supplier require at least one BPNL for their company. | ||
|
|
||
| ## How | ||
|
|
||
| If you want to adapt your custom or commercial applications to work with the Catena-X DCM usecase you will have to | ||
|
|
||
| 1. Modify the source code of your application | ||
| 2. Enable your software to offer multiple REST API endpoints in order to receive data | ||
| 3. Enable your software to call multiple REST API endpoints in order to send data | ||
| 4. Enable your software the communicate through an Eclipse Dataspace Connector (EDC), which is to be setup separately | ||
|
|
||
| For details, please refer to the Catena-X DCM standard CX-0128. This page provides a non-normative overview only. | ||
|
|
||
| ## Solution Overview | ||
|
|
||
| For the exchange of the demand and capacity information required by the process, five REST APIs are used: | ||
|
|
||
| - MaterialDemand API - used for the exchange of demand information | ||
| - WeekBasedCapacityGroup API - used for the exchange of capacity information | ||
| - RequestForUpdate API - used for requesting an update of MaterialDemand or WeekBasedCapacityGroup | ||
| - IdBasedComment API - used for the exchange of additional comments regarding MaterialDemand or WeekBasedCapacityGroup | ||
| - Asset Administration Shell (AAS) API - used when using DCM in combination with a Digital Twin Registry | ||
|
|
||
| All those APIs are REST-based APIs. | ||
|
|
||
| Implementing all endpoints is mandatory, except the AAS API endpoint, which is optional. | ||
|
|
||
| Note that the software solutions used as well as the business process should be enabled in order to receive MaterialDemand information from customers and send WeekBasedCapacityGroup information back to those customers. Also, it needs to be possible to send the own MaterialDemand information to the suppliers and receive their WeekBasedCapacityGroup information in return. Therefore, the software tools used need to be able to send/receive these information and the users need to be able to work with the information in the planning processes. | ||
|
|
||
| When implementing the API endpoints, it is important to follow the DCM standard closely in order to ensure compatibility with other solutions. This is not limited to technical aspects, but also extends to the business definition of demand and capacity. | ||
|
|
||
| ### Architecture Constraints | ||
|
|
||
| | Constraint ID | Constraint | | ||
| | ------------- | ------------- | | ||
| | C-1 | Software and third party software must be compliant to the Catena-X and Eclipse Foundation Guidelines/Policies [eclipse_foundation](https://www.eclipse.org/projects/dev_process/) | | ||
| | C-2 | [Eclipse Dataspace Connector](https://github.com/eclipse-tractusx/tractusx-edc/tree/main) (EDC) must be used for data transfer between different legal entities; e.g. the API endpoints listed above may only be called through an EDC | | ||
|
|
||
| ## Sequence Diagram | ||
|
|
||
| The overall interaction between partners is illustrated by the following sequence diagram: | ||
|
|
||
|  | ||
|
|
||
| Note that the supplier does not need to immediately reply with capacity group after receiving demand information, although a timely reply is appreciated, there can be a considerable time in between instead. | ||
|
|
||
| Digital Twins can also be used to reference parts, but are not shown in the sequence diagram for simplicity. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are those statements really necessary as H3? Because they are showing up in the right navigation and we want to keep this as lean as possible.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed to ** bold ** -> Linter error message can be ignored