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.

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

docs: DCM-Kit Content Release 24.03 #677

Merged
merged 23 commits into from
Mar 7, 2024
Merged
Changes from 1 commit
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
41846d2
Rearrange DCM Kit structure, remove blanks from folder names
nhaenis Feb 13, 2024
99d4bd8
Add DCM API definitions into Kit structure
nhaenis Feb 13, 2024
2f01c07
Merge branch 'main' into dcm-content-r2403
nhaenis Feb 13, 2024
bca8b9e
Merge branch 'eclipse-tractusx:main' into dcm-content-r2403
nhaenis Feb 15, 2024
a56837f
Merge branch 'main' into dcm-content-r2403
nhaenis Feb 15, 2024
e63ab35
Merge branch 'dcm-content-r2403' of https://github.com/nhaenis/eclips…
nhaenis Feb 15, 2024
b0eeb85
Add DCM 24.03 Content
nhaenis Feb 15, 2024
01c5b07
Punkt ergänzt
nhaenis Feb 15, 2024
142921a
Merge branch 'main' into dcm-content-r2403
nhaenis Feb 15, 2024
f67740a
Replace [CX-0128 Demand and Capacity Management] with [CX-0128 Demand…
nhaenis Feb 19, 2024
d300c95
Merge branch 'main' into dcm-content-r2403
nhaenis Feb 19, 2024
e1f6745
Removed DCM API definitions
nhaenis Feb 22, 2024
a447f16
Merge branch 'main' into dcm-content-r2403
nhaenis Feb 23, 2024
2b6142b
Review comments cleanup
nhaenis Feb 27, 2024
24d38ef
Incorporated feedback for release
nhaenis Feb 28, 2024
116e4b7
Update changelog
nhaenis Feb 28, 2024
5683dc8
Fix headings for TOC
nhaenis Feb 28, 2024
09c3429
Merge branch 'main' into dcm-content-r2403
nhaenis Feb 28, 2024
7ea6dc0
Merge branch 'main' into dcm-content-r2403
nhaenis Feb 28, 2024
7968941
Fix static URL refs DCM to kebap-case URLs
nhaenis Feb 29, 2024
14a828e
Merge branch 'main' into dcm-content-r2403
nhaenis Mar 6, 2024
66f84dd
Copyright ranges marked with , instead of -
nhaenis Mar 7, 2024
742c3ae
Merge branch 'dcm-content-r2403' of https://github.com/nhaenis/eclips…
nhaenis Mar 7, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Replace [CX-0128 Demand and Capacity Management] with [CX-0128 Demand…
… and Capacity Management Data Exchange]
nhaenis committed Feb 19, 2024
commit f67740aa1cc3f77ad22c7a9492aad3f8bb668f76
Original file line number Diff line number Diff line change
@@ -7,7 +7,7 @@ sidebar_position: 1

![DCM kit banner](@site/static/img/DCMKitLogoIcon-min.png)

This page describes the most important parts for the software implementation of the DCM standards. For the full technical specification, please refer to the standard [CX-0128 Demand and Capacity Management](https://catena-x.net/de/standard-library).
This page describes the most important parts for the software implementation of the DCM standards. For the full technical specification, please refer to the standard [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library).

## Introduction

@@ -299,7 +299,7 @@ For the data exchange between demand and capacity management applications the `d

The `pointInTime` property represents the calendar week as a date and MUST be set to a monday of the week for that specific demand. The date format MUST be in accordance with ISO8601 and MUST be in the format YYYY-MM-DD (for example 2023-02-13) without a time zone.

The attributes `demandCategory` and `unitOfMeasure` MUST be set to one of the defined values as defined in [CX-0128 Demand and Capacity Management](https://catena-x.net/de/standard-library). If the customer explicitly does not want to send a unit of measure to the supplier, then the `unitOfMeasure` property can be omitted in the payload and the `unitOfMeasureIsOmitted` flag value MUST be set to `true`.
The attributes `demandCategory` and `unitOfMeasure` MUST be set to one of the defined values as defined in [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library). If the customer explicitly does not want to send a unit of measure to the supplier, then the `unitOfMeasure` property can be omitted in the payload and the `unitOfMeasureIsOmitted` flag value MUST be set to `true`.

The data series in the `MaterialDemand` SHOULD start already from week _n+2_, where n represents the current week.

@@ -360,7 +360,7 @@ An example EDC Data Asset definition is shown below.

#### Error Handling and payload validation

For error handling and payload validation instructions please refer to the [CX-0128 Demand and Capacity Management](https://catena-x.net/de/standard-library) standard.
For error handling and payload validation instructions please refer to the [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library) standard.

### WeekBasedCapacityGroup API

@@ -384,7 +384,7 @@ The data payload itself MUST be a valid JSON string.

All attributes marked as mandatory in the aspect model standard MUST be included in the dataset. Attribute marked as 'optional' MAY be included in the data set.

The usage of the attributes in the data model MUST follow the attribute descriptions of the respective aspect model and the definitions in [CX-0128 Demand and Capacity Management](https://catena-x.net/de/standard-library). For example, an exact definition of the different capacities is provided there and needs to be observed.
The usage of the attributes in the data model MUST follow the attribute descriptions of the respective aspect model and the definitions in [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library). For example, an exact definition of the different capacities is provided there and needs to be observed.

While some attributes are technically a string, not any string is valid. For example, `supplier` MUST be formatted as a BPNL.

@@ -396,7 +396,7 @@ The capacities for the current week (_n=0_) and the next week (_n=1_) MAY be inc

If the capacity for one of the weeks changes, the whole dataset MUST be sent to the customer, sending the changes only (delta update / incremental update) is NOT possible. By this procedure, inconsistent or incomplete data sets are avoided. One data transfer MUST contain at least one `WeekBasedCapacityGroup` data set.

Additional business-process related rules are specified in [CX-0128 Demand and Capacity Management](https://catena-x.net/de/standard-library), these MUST be followed as well. For example, the process defines a capacity and how it is to be interpreted or that a demand must be consistent with other exchanged information such as call-offs. All `WeekBasedCapacityGroup` objects MUST only use a mutually agreed unit of measure (as defined in [CX-0128 Demand and Capacity Management](https://catena-x.net/de/standard-library)).
Additional business-process related rules are specified in [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library), these MUST be followed as well. For example, the process defines a capacity and how it is to be interpreted or that a demand must be consistent with other exchanged information such as call-offs. All `WeekBasedCapacityGroup` objects MUST only use a mutually agreed unit of measure (as defined in [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library)).

The property `linkedDemandSeries` is used to indicate to which MaterialDemand object a `WeekBasedCapacityGroup` object refers to. More specifically, the linkedDemandSeries refers to a demand for a specific `demandCategory` / `customerLocation` / `materialNumberCustomer` combination.

@@ -453,7 +453,7 @@ An example EDC Data Asset definition is shown below.

#### Error Handling and payload validation

For error handling and payload validation instructions please refer to the [CX-0128 Demand and Capacity Management](https://catena-x.net/de/standard-library) standard.
For error handling and payload validation instructions please refer to the [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library) standard.

### RequestForUpdate API

@@ -595,7 +595,7 @@ An example EDC Data Asset definition is shown below.

#### Error Handling and payload validation

For error handling and payload validation instructions please refer to the [CX-0128 Demand and Capacity Management](https://catena-x.net/de/standard-library) standard.
For error handling and payload validation instructions please refer to the [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library) standard.

### IdBasedComment API

@@ -619,7 +619,7 @@ The data payload itself MUST be a valid JSON string.

All attributes marked as mandatory in the respective aspect model standard MUST be included in the dataset. Attributes marked as 'optional' MAY be included in the data set.

The usage of the attributes in the data model MUST follow the attribute descriptions of the respective aspect model and the definitions in [CX-0128 Demand and Capacity Management](https://catena-x.net/de/standard-library).
The usage of the attributes in the data model MUST follow the attribute descriptions of the respective aspect model and the definitions in [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library).

While some attributes are technically a string, not any string is valid. For example, `objectType` MUST be as a Catena-X aspect model unique identifier (defined on this page) without a version. For reusability reasons of the aspect model there are no enum values defined in the characteristic of this property.

@@ -705,7 +705,7 @@ An example EDC Data Asset definition is shown below.

#### Error Handling and payload validation

For error handling and payload validation instructions please refer to the [CX-0128 Demand and Capacity Management](https://catena-x.net/de/standard-library) standard.
For error handling and payload validation instructions please refer to the [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library) standard.

### DCM ASSET ADMINISTRATION SHELL API (AAS API)

6 changes: 3 additions & 3 deletions docs-kits/kits/DCM-Kit/page_adoption-view.md
Original file line number Diff line number Diff line change
@@ -40,9 +40,9 @@ Implementing the DCM standards will add the following core capabilities to busin

The DCM standard consists of three main elements:

- **Core Business logic** – to focus on a **common understanding** of the **DCM processes** among the participants. **Version 1.0.0** (Release 24.03) [CX-0128 Demand and Capacity Management](https://catena-x.net/de/standard-library)
- **Data model** – to align the structure of the shared data and enable the adoption of the core business logic without misinterpretation. **Version 1.0.0** (Release 24.03) [CX-0128 Demand and Capacity Management](https://catena-x.net/de/standard-library)
- **APIs** – to make sure that data are transmitted and consumed properly as well as are identically interpreted across companies. **Version 1.0.0** (Release 24.03) [CX-0128 Demand and Capacity Management](https://catena-x.net/de/standard-library)
- **Core Business logic** – to focus on a **common understanding** of the **DCM processes** among the participants. **Version 1.0.0** (Release 24.03) [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library)
- **Data model** – to align the structure of the shared data and enable the adoption of the core business logic without misinterpretation. **Version 1.0.0** (Release 24.03) [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library)
- **APIs** – to make sure that data are transmitted and consumed properly as well as are identically interpreted across companies. **Version 1.0.0** (Release 24.03) [CX-0128 Demand and Capacity Management Data Exchange](https://catena-x.net/de/standard-library)

**POWER of STANDARD**