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

OSim KIT 24.08 #962

Merged
merged 7 commits into from
Aug 2, 2024
+1,323 −1,422
Merged

OSim KIT 24.08 #962

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5dd1891
feat: update osim openAPI documentation
dominikoeh Jun 20, 2024
753cd2c
feat(osim-kit): update adoption view
dominikoeh Jul 4, 2024
f9c1f44
feat(osim-kit): update copyright
dominikoeh Jul 4, 2024
2c73e8d
feat(osim-kit): update copyright
dominikoeh Jul 4, 2024
6dd5de2
fix(osim-kit): copyright adoption view
dominikoeh Jul 9, 2024
73bb254
feat(osim-kit): code linting
dominikoeh Jul 11, 2024
0dd1057
docs(osim-kit): convert openAPI document to YAML
dominikoeh Jul 29, 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
feat(osim-kit): update adoption view 
- add latest versions for models and standard
- add product documentation
@dominikoeh
dominikoeh committed Jul 4, 2024
commit 753cd2c2e643fa71febc5ee1ec630c5208b32869
Binary file added docs-kits/kits/OSim Kit/OSim-Product-Documentation-EN.pdf
View file
Binary file not shown.
185 changes: 110 additions & 75 deletions ...ts/kits/OSim Kit/Software Development View/02-page_software-development-view.md
View file
Original file line number Diff line number Diff line change
@@ -16,47 +16,59 @@ The following example shows the payload used for exchange of simulation results

```json
{
"owner": { "id": "BPNL00000007OTZ3" },
"dataQuality": 1,
"description": "Daily standard simulation",
"comment": "successful simulation",
"expirationTimestamp": "2023-03-24T09:15:24.000Z",
"runId": "0fece48b-c8d1-4180-1a9caca6d67e",
"shipments": [
{
"handlingUnits": [
{
"name": "Palette",
"volume": 1,
"weight": 189,
"batches": [
{
"unitOfMeasurement": "KG",
"materialName": "KK1000GR-Gehäuse-Rot",
"quantity": 50,
"materialNumber": "KK1000GR",
"batchOrderId": "Order-0001",
"batchId": "Batch_1",
"hazardousGoods": false,
"batchExpirationTimestamp": "2023-08-22T16:00:00.000Z",
"batchNumber": "45"
}
],
"handlingUnitId": "HUT_1",
"amount": 1
}
],
"shipmentId": "DE51515151",
"recipientTimestampPlanned": "2023-04-19T09:00:00.000Z",
"destination": { "id": "BPNL00000007OTZ3" },
"recipient": { "id": "BPNL00000007OTZ4" },
"logistics": { "id": "BPNL00000007OS0H" },
"preceding": {},
"splittingAllowed": true,
"destinationTimestamp": "2023-03-19T09:00:00.000Z"
}
],
"timestamp": "2023-03-09T14:13:42.806Z"
"materialFlowSimulationResult": {
"owner": {
"bpnsProperty": "BPNS0123456789ZZ"
},
"dataQuality": 0,
"description": "Please simulate asap",
"comment": "successful simulation ",
"expirationTimestamp": "2023-03-24T09:15:24.000Z",
"runId": "0fece48b-c8d1-4180-1a9caca6d67e",
"shipments": [
{
"handlingUnits": [
{
"name": "Palette",
"volume": 1,
"weight": 189,
"batches": [
{
"unitOfMeasurement": "KG",
"materialName": "KK1000GR-Gehäuse-Rot",
"quantity": 0,
"materialNumber": "KK1000GR",
"materialHazardousGoods": false,
"batchSerialNumber": "Batch_1",
"batchOrderId": "Order-0001",
"batchExpirationTimestamp": "2023-08-22T16:00:00.000Z",
"batchNumber": "45"
}
],
"handlingUnitId": "HUT_1",
"amount": 1
}
],
"shipmentId": "DE51515151",
"recipientTimestampPlanned": "2023-04-19T09:00:00.000Z",
"destination": {
"bpnsProperty": "BPNS0123456789ZZ"
},
"recipient": {
"bpnsProperty": "BPNS0123456789ZZ"
},
"logistics": {
"bpnsProperty": "BPNS0123456789ZZ"
},
"preceding": {
"bpnsProperty": "BPNS0123456789ZZ"
},
"splittingAllowed": true,
"destinationTimestamp": "2023-03-19T09:00:00.000Z"
}
],
"timestamp": "2023-03-09T14:13:42.806Z"
}
}
```

@@ -70,28 +82,30 @@ The following example shows the payload used for exchange of scenario data betwe
"scenarioSimResults": {
"resultOwnId": "916b5688-8bd8-4d7e-83b9-e0d40939274e",
"resultOwnSimRunInitial": {
"owner": {},
"owner": {
"bpnsProperty": "BPNS0123456789ZZ"
},
"dataQuality": 0,
"description": "Please simulate asap",
"comment": "successful simulation",
"comment": "successful simulation ",
"expirationTimestamp": "2023-03-24T09:15:24.000Z",
"runId": "0fece48b-c8d1-4180-1a9caca6d67e",
"shipments": [
{
"handlingUnits": [
{
"name": "Palette",
"volume": 1.0,
"weight": 189.0,
"volume": 1,
"weight": 189,
"batches": [
{
"unitOfMeasurement": "KG",
"materialName": "KK1000GR-Gehäuse-Rot",
"quantity": 50.0,
"quantity": 0,
"materialNumber": "KK1000GR",
"materialHazardousGoods": false,
"batchSerialNumber": "Batch_1",
"batchOrderId": "Order-0001",
"batchId": "Batch_1",
"batchExpirationTimestamp": "2023-08-22T16:00:00.000Z",
"batchNumber": "45"
}
@@ -102,39 +116,49 @@ The following example shows the payload used for exchange of scenario data betwe
],
"shipmentId": "DE51515151",
"recipientTimestampPlanned": "2023-04-19T09:00:00.000Z",
"destination": {},
"recipient": {},
"logistics": {},
"preceding": {},
"destination": {
"bpnsProperty": "BPNS0123456789ZZ"
},
"recipient": {
"bpnsProperty": "BPNS0123456789ZZ"
},
"logistics": {
"bpnsProperty": "BPNS0123456789ZZ"
},
"preceding": {
"bpnsProperty": "BPNS0123456789ZZ"
},
"splittingAllowed": true,
"destinationTimestamp": "2023-03-19T09:00:00.000Z"
}
],
"timestamp": "2023-03-09T14:13:42.806Z"
},
"resultOwnSimRunUpdated": {
"owner": {},
"owner": {
"bpnsProperty": "BPNS0123456789ZZ"
},
"dataQuality": 0,
"description": "Please simulate asap",
"comment": "successful simulation",
"comment": "successful simulation ",
"expirationTimestamp": "2023-03-24T09:15:24.000Z",
"runId": "0fece48b-c8d1-4180-1a9caca6d67e",
"shipments": [
{
"handlingUnits": [
{
"name": "Palette",
"volume": 1.0,
"weight": 189.0,
"volume": 1,
"weight": 189,
"batches": [
{
"unitOfMeasurement": "KG",
"materialName": "KK1000GR-Gehäuse-Rot",
"quantity": 50.0,
"quantity": 0,
"materialNumber": "KK1000GR",
"materialHazardousGoods": false,
"batchSerialNumber": "Batch_1",
"batchOrderId": "Order-0001",
"batchId": "Batch_1",
"batchExpirationTimestamp": "2023-08-22T16:00:00.000Z",
"batchNumber": "45"
}
@@ -145,35 +169,46 @@ The following example shows the payload used for exchange of scenario data betwe
],
"shipmentId": "DE51515151",
"recipientTimestampPlanned": "2023-04-19T09:00:00.000Z",
"destination": {},
"recipient": {},
"logistics": {},
"preceding": {},
"destination": {
"bpnsProperty": "BPNS0123456789ZZ"
},
"recipient": {
"bpnsProperty": "BPNS0123456789ZZ"
},
"logistics": {
"bpnsProperty": "BPNS0123456789ZZ"
},
"preceding": {
"bpnsProperty": "BPNS0123456789ZZ"
},
"splittingAllowed": true,
"destinationTimestamp": "2023-03-19T09:00:00.000Z"
}
],
"timestamp": "2023-03-09T14:13:42.806Z"
}
},
"scenarioParameter": {
"unitOfMeasurement": "KG",
"parameterScenario": "8d464b8b-6977-4952-8a22-0489067ca081",
"parameterComment": "updated Delivery Date",
"materialName": "KK1000GR-Gehäuse-Rot",
"parameterQuantityUpdated": 1.0,
"parameterId": "847c71e5-614a-468b-a3a0-674bf2af3004",
"materialNumber": "KK1000GR",
"parameterDeliveryDateUpdated": "2023-10-10T09:00:00.000Z",
"parameterDeliveryDateInitial": "2023-10-09T10:00:00.000Z",
"parameterOrderId": "OID-011123456",
"parameterQuantityInitial": 1.0
},
"scenarioParameter": [
{
"unitOfMeasurement": "KG",
"parameterComment": "updated Delivery Date",
"materialName": "KK1000GR-Gehäuse-Rot",
"parameterQuantityUpdated": 1,
"parameterId": "847c71e5-614a-468b-a3a0-674bf2af3004",
"materialNumber": "KK1000GR",
"parameterDeliveryDateUpdated": "2023-10-10T09:00:00.000Z",
"parameterDeliveryDateInitial": "2023-10-09T10:00:00.000Z",
"parameterOrderId": "OID-011123546",
"parameterQuantityInitial": 1
}
],
"scenarioHeader": {
"scenarioOwnerRole": "Customer",
"scenarioCreationTimestamp": "2023-10-04T09:10:00.000Z",
"scenarioExpirationTimestamp": "2023-10-07T09:10:00.000Z",
"scenarioOwner": "BPNL0000007OTZ3",
"scenarioOwner": {
"bpnsProperty": "BPNS0123456789ZZ"
},
"scenarioDescription": "Changes in Delivery Date",
"scenarioId": "8d464b8b-6977-4952-8a22-0489067ca081",
"scenarioTitle": "Delivery Modification"
15 changes: 9 additions & 6 deletions docs-kits/kits/OSim Kit/page_adoption-view.md
View file
Original file line number Diff line number Diff line change
@@ -92,7 +92,7 @@ One *MaterialFlowSimulationResult* refers to one or more Shipments.

#### Aspect Model

Github Link to semantic data model: <https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.material_flow_simulation_result/2.0.0>
Github Link to semantic data model: <https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.material_flow_simulation_result/3.0.0>

### Materialflow Scenario Request (MaterialFlowScenarioRequest)

@@ -121,7 +121,7 @@ The *MaterialFlowScenarioRequest* semantic model contains 4 entities:

#### Aspect Model

Github Link to semantic data model: <https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.material_flow_scenario_request/1.0.0>
Github Link to semantic data model: <https://github.com/eclipse-tractusx/sldt-semantic-models/blob/main/io.catenax.material_flow_scenario_request/2.0.0>

## Logic & Schema

@@ -241,10 +241,13 @@ To verify the participants Catena-X membership, the Membership verifiable creden

Our relevant standards can be downloaded from the official [Catena-X Standard Library](https://catena-x.net/de/standard-library):

- [CX - 0072 OSim Process and Core Business Logic v1.0.0](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_September23/CX-0072-OSimProcessAndCoreBusinessLogic-v1.0.0.pdf)
- [CX - 0073 OSim API v1.0.0](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_September23/CX-0073-OSimAPI-v1.0.0.pdf)
- [CX - 0087 OSim Data Model Materialflow Simulation Result v1.0.0](https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_September23/CX-0087-OSimDataModelMaterialFlowSimulationResult-v1.0.0.pdf)
- [CX - 0133 Online Control and Simulation v1.0.0](https://catena-x.net/de/standard-library)
- [CX - 0133 Online Control and Simulation v2.0.0](https://catenax-ev.github.io/docs/next/standards/CX-0133-OnlineControlandSimulation)

## Product Documentation

A deeper understanding of the basic Online Control and Simulation use case can be gained from the following linked document. While in the OSIM-KIT only the standardized partner interface of OSim is considered, the OSim product documentation represents the complete technical specification of the use case.

- [OSim - Product Documentation_EN](./OSim-Product-Documentation-EN.pdf)

## Notice

19 changes: 19 additions & 0 deletions docs-kits/kits/OSim Kit/page_changelog.md
View file
Original file line number Diff line number Diff line change
@@ -11,6 +11,25 @@ sidebar_position: 1

All notable changes to this Kit will be documented in this file.

## [3.0.0] - 2024-08-01

### Added

- Adoption View:
- Added new Chapter Product documentation with a link to the document.

### Changed

- Adoption View:
- Updated the aspect model references to the newest version.
- Development View:
- Updated the API descriptions in accordance with the newest OSim standardization document CX-133

### Removed

- Adoption View:
- References to the obsolete OSim Standards.

## [2.0.0] – 2024-03-08

### Added