Skip to content

Commit

Permalink
initial draft for material flow scenario request
Browse files Browse the repository at this point in the history
  • Loading branch information
@dominikoeh
dominikoeh committed Oct 19, 2023
1 parent a53ac61 commit 09824b9
Show file tree
Hide file tree
Showing 3 changed files with 222 additions and 0 deletions.
214 changes: 214 additions & 0 deletions io.catenax.material_flow_scenario_request/1.0.0/MaterialFlowScenarioRequestAspect.ttl
View file
Original file line number Diff line number Diff line change
@@ -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: <urn:samm:org.eclipse.esmf.samm:meta-model:2.0.0#> .
@prefix samm-c: <urn:samm:org.eclipse.esmf.samm:characteristic:2.0.0#> .
@prefix samm-e: <urn:samm:org.eclipse.esmf.samm:entity:2.0.0#> .
@prefix unit: <urn:samm:org.eclipse.esmf.samm:unit:2.0.0#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
@prefix : <urn:samm:io.catenax.material_flow_scenario_request:1.0.0#> .
@prefix ext-result: <urn:samm:io.catenax.material_flow_simulation_result:2.0.0#> .

: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 .

1 change: 1 addition & 0 deletions io.catenax.material_flow_scenario_request/1.0.0/metadata.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{ "status" : "release" }
7 changes: 7 additions & 0 deletions io.catenax.material_flow_scenario_request/RELEASE_NOTES.md
View file
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 09824b9

Please sign in to comment.