From 09824b9e98a0132d6ff1267337dcca0744e37102 Mon Sep 17 00:00:00 2001 From: Dominik Oeh Date: Thu, 19 Oct 2023 11:15:26 +0200 Subject: [PATCH 1/2] initial draft for material flow scenario request --- .../MaterialFlowScenarioRequestAspect.ttl | 214 ++++++++++++++++++ .../1.0.0/metadata.json | 1 + .../RELEASE_NOTES.md | 7 + 3 files changed, 222 insertions(+) create mode 100644 io.catenax.material_flow_scenario_request/1.0.0/MaterialFlowScenarioRequestAspect.ttl create mode 100644 io.catenax.material_flow_scenario_request/1.0.0/metadata.json create mode 100644 io.catenax.material_flow_scenario_request/RELEASE_NOTES.md diff --git a/io.catenax.material_flow_scenario_request/1.0.0/MaterialFlowScenarioRequestAspect.ttl b/io.catenax.material_flow_scenario_request/1.0.0/MaterialFlowScenarioRequestAspect.ttl new file mode 100644 index 000000000..e79186a24 --- /dev/null +++ b/io.catenax.material_flow_scenario_request/1.0.0/MaterialFlowScenarioRequestAspect.ttl @@ -0,0 +1,214 @@ +########################################################################################## +# Copyright (c) 2023 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e. V. +# Copyright (c) 2023 German Edge Cloud GmbH & Co. KG +# Copyright (c) 2023 Siemens AG +# +# See the NOTICE file(s) distributed with this work for additional +# information regarding copyright ownership. +# +# This work is made available under the terms of the +# Creative Commons Attribution 4.0 International (CC-BY-4.0) license, +# which is available at +# https://creativecommons.org/licenses/by/4.0/legalcode. +# +# SPDX-License-Identifier: CC-BY-4.0 +########################################################################################## +@prefix samm: . +@prefix samm-c: . +@prefix samm-e: . +@prefix unit: . +@prefix rdf: . +@prefix rdfs: . +@prefix xsd: . +@prefix : . +@prefix ext-result: . + +:MaterialFlowScenarioRequestAspect a samm:Aspect ; + samm:preferredName "Material Flow Scenario Request Aspect"@en ; + samm:description "Aspect model describing the Material Flow Scenario Request"@en ; + samm:properties ( :materialFlowScenarioRequest ) ; + samm:operations ( ) ; + samm:events ( ) . + +:materialFlowScenarioRequest a samm:Property ; + samm:preferredName "materialFlowScenarioRequest"@en ; + samm:description "Contains standardized attributes for the content of the Material Flow Scenario Request"@en ; + samm:characteristic :MaterialFlowScenarioRequestCharacteristic . + +:MaterialFlowScenarioRequestCharacteristic a samm:Characteristic ; + samm:preferredName "Material Flow Scenario Request Characteristic"@en ; + samm:description "Characteristic describing the aspect Material Flow Scenario Request"@en ; + samm:dataType :MaterialFlowScenarioRequest . + +:MaterialFlowScenarioRequest a samm:Entity ; + samm:preferredName "Material Flow Scenario Request"@en ; + samm:description "The Material Flow Scenario Request contains standardized attributes for exchanging scenario requests and the resulting simulation results between two OSIM Manager Instances"@en ; + samm:properties ( :scenarioHeader [ samm:property :scenarioParameter; samm:optional true ] :scenarioSimResults ) . + +:scenarioHeader a samm:Property ; + samm:preferredName "scenarioHeader"@en ; + samm:description "Required parameters for the scenario header"@en ; + samm:characteristic :ScenarioHeaderCharacteristic . + +:scenarioParameter a samm:Property ; + samm:preferredName "scenarioParameter"@en ; + samm:description "Required parameters for the material flow scenario request"@en ; + samm:characteristic :ScenarioParameterCharacteristic . + +:scenarioSimResults a samm:Property ; + samm:preferredName "scenarioSimResults"@en ; + samm:description "Simulation results of the scenario"@en ; + samm:characteristic :ScenarioSimResultsCharacteristic . + +:ScenarioHeaderCharacteristic a samm:Characteristic ; + samm:preferredName "Scenario Header Characteristic"@en ; + samm:description "Characteristic describing the parameter for a scenario header"@en ; + samm:dataType :ScenarioHeader . + +:ScenarioParameterCharacteristic a samm:Characteristic ; + samm:preferredName "Scenario Parameter Characteristic"@en ; + samm:description "Characteristic describing the scenario parameter"@en ; + samm:dataType :ScenarioParameter . + +:ScenarioSimResultsCharacteristic a samm:Characteristic ; + samm:preferredName "Scenario Simulation Results Characteristic"@en ; + samm:description "Characteristic for simulation results"@en ; + samm:dataType :ScenarioSimResults . + +:ScenarioHeader a samm:Entity ; + samm:preferredName "Scenario Header"@en ; + samm:description "Headers required for every exchange"@en ; + samm:properties ( :scenarioId :scenarioTitle :scenarioCreationTimestamp :scenarioExpirationTimestamp :scenarioOwner :scenarioOwnerRole [ samm:property :scenarioDescription; samm:optional true ] ) . + +:ScenarioParameter a samm:Entity ; + samm:preferredName "Scenario Parameter"@en ; + samm:description "Parameters which are used to describe a material flow scenario request"@en ; + samm:properties ( :parameterId :parameterDeliveryDateInitial :parameterDeliveryDateUpdated :parameterQuantityInitial :parameterQuantityUpdated :parameterOrderId :parameterScenario :parameterComment ext-result:materialNumber ext-result:materialName ext-result:unitOfMeasurement ) . + +:ScenarioSimResults a samm:Entity ; + samm:preferredName "Scenario Simulation Results"@en ; + samm:description "Attached to a scenario simulation results of the feedback requestor"@en ; + samm:properties ( :resultOwnId [ samm:property :resultOwnSimRunInitial; samm:optional true ] [ samm:property :resultOwnSimRunUpdated; samm:optional true ] ) . + +:scenarioId a samm:Property ; + samm:preferredName "scenarioId"@en ; + samm:description "ID of scenario header"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "8d464b8b-6977-4952-8a22-0489067ca081" . + +:scenarioTitle a samm:Property ; + samm:preferredName "scenarioTitle"@en ; + samm:description "Title of scenario"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Delivery Modification" . + +:scenarioCreationTimestamp a samm:Property ; + samm:preferredName "scenarioCreationTimestamp"@en ; + samm:description "Date and Time of scenario creation"@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2023-10-04T09:10:00.000Z"^^xsd:dateTime . + +:scenarioExpirationTimestamp a samm:Property ; + samm:preferredName "scenarioExpirationTimestamp"@en ; + samm:description "Date and Time of validity expiration"@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2023-10-07T09:10:00.000Z"^^xsd:dateTime . + +:scenarioOwner a samm:Property ; + samm:preferredName "scenarioOwner"@en ; + samm:description "Owner of the simulation scenario"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "BPNL0000007OTZ3" . + +:scenarioOwnerRole a samm:Property ; + samm:preferredName "scenarioOwnerRole"@en ; + samm:description "Role of the scenario owner"@en ; + samm:characteristic :ScenarioOwnerRoleCharacteristic ; + samm:exampleValue "Customer" . + +:scenarioDescription a samm:Property ; + samm:preferredName "scenarioDescription"@en ; + samm:description "Description of the scenario"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "Changes in Delivery Date" . + +:parameterId a samm:Property ; + samm:preferredName "parameterId"@en ; + samm:description "Identifier of scenario parameter"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "847c71e5-614a-468b-a3a0-674bf2af3004" . + +:parameterDeliveryDateInitial a samm:Property ; + samm:preferredName "parameterDeliveryDateInitial"@en ; + samm:description "Delivery date initial (without scenario changes), optional, NULL when initially not set"@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2023-10-09T10:00:00.000Z"^^xsd:dateTime . + +:parameterDeliveryDateUpdated a samm:Property ; + samm:preferredName "parameterDeliveryDateUpdated"@en ; + samm:description "Delivery date updated (with scenario changes)"@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2023-10-10T09:00:00.000Z"^^xsd:dateTime . + +:parameterQuantityInitial a samm:Property ; + samm:preferredName "parameterQuantityInitial"@en ; + samm:description "Amount initial (without scenario changes), optional, NULL, when initially not set"@en ; + samm:characteristic :QuantityCharacteristic ; + samm:exampleValue "1.00"^^xsd:float . + +:parameterQuantityUpdated a samm:Property ; + samm:preferredName "parameterQuantityUpdated"@en ; + samm:description "Amount updated (with scenario changes)"@en ; + samm:characteristic :QuantityCharacteristic ; + samm:exampleValue "1.00"^^xsd:float . + +:parameterOrderId a samm:Property ; + samm:preferredName "parameterOrderId"@en ; + samm:description "ID of the order"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "OID-011123456" . + +:parameterScenario a samm:Property ; + samm:preferredName "parameterScenario"@en ; + samm:description "Foreign key to scenario header"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "8d464b8b-6977-4952-8a22-0489067ca081" . + +:parameterComment a samm:Property ; + samm:preferredName "parameterComment"@en ; + samm:description "Optional description of parameters"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "updated Delivery Date" . + +:resultOwnId a samm:Property ; + samm:preferredName "resultOwnId"@en ; + samm:description "ID of scenario result own"@en ; + samm:characteristic samm-c:Text ; + samm:exampleValue "916b5688-8bd8-4d7e-83b9-e0d40939274e" . + +:resultOwnSimRunInitial a samm:Property ; + samm:preferredName "resultOwnSimRunInitial"@en ; + samm:description "Foreign key to simulation result based on initial parameters"@en ; + samm:characteristic :SimResult . + +:resultOwnSimRunUpdated a samm:Property ; + samm:preferredName "resultOwnSimRunUpdated"@en ; + samm:description "Foreign key to simulation result based on updated parameter (scenario)"@en ; + samm:characteristic :SimResult . + +:ScenarioOwnerRoleCharacteristic a samm-c:Enumeration ; + samm:preferredName "Scenario Owner Role Characteristic"@en ; + samm:description "Characteristic describing possible values for the role of the scenario owner"@en ; + samm:dataType xsd:string ; + samm-c:values ( "Customer" "Supplier" "LogisticianReceiving" "LogisticianSending" ) . + +:QuantityCharacteristic a samm:Characteristic ; + samm:preferredName "Quantity Characteristic"@en ; + samm:description "Describes a property which is a Float"@en ; + samm:dataType xsd:float . + +:SimResult a samm:Characteristic ; + samm:preferredName "Sim Result"@en ; + samm:description "Characteristic describing the property for a Material Flow Simulation Result"@en ; + samm:dataType ext-result:MaterialFlowSimulationResult . + diff --git a/io.catenax.material_flow_scenario_request/1.0.0/metadata.json b/io.catenax.material_flow_scenario_request/1.0.0/metadata.json new file mode 100644 index 000000000..84245e4eb --- /dev/null +++ b/io.catenax.material_flow_scenario_request/1.0.0/metadata.json @@ -0,0 +1 @@ +{ "status" : "release" } diff --git a/io.catenax.material_flow_scenario_request/RELEASE_NOTES.md b/io.catenax.material_flow_scenario_request/RELEASE_NOTES.md new file mode 100644 index 000000000..96aeebdab --- /dev/null +++ b/io.catenax.material_flow_scenario_request/RELEASE_NOTES.md @@ -0,0 +1,7 @@ +# Changelog + +All notable changes to this model will be documented in this file. + +## [1.0.0] + +- initial version of the aspect model for Scenario Simulation Request From 87008d56605cc8e126196bee117afbe829179366 Mon Sep 17 00:00:00 2001 From: Dominik Oeh Date: Thu, 19 Oct 2023 15:14:42 +0200 Subject: [PATCH 2/2] change release date for the model --- io.catenax.material_flow_scenario_request/RELEASE_NOTES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/io.catenax.material_flow_scenario_request/RELEASE_NOTES.md b/io.catenax.material_flow_scenario_request/RELEASE_NOTES.md index 96aeebdab..a65cda634 100644 --- a/io.catenax.material_flow_scenario_request/RELEASE_NOTES.md +++ b/io.catenax.material_flow_scenario_request/RELEASE_NOTES.md @@ -2,6 +2,6 @@ All notable changes to this model will be documented in this file. -## [1.0.0] +## [1.0.0] 2023-10-23 - initial version of the aspect model for Scenario Simulation Request