From 039ec26ee7f7731cf9f9a0b010f083fad94c3a18 Mon Sep 17 00:00:00 2001 From: "Jan Christoph Wehrstedt (Desktop)" Date: Thu, 13 Jul 2023 14:06:07 +0200 Subject: [PATCH 1/5] first version of ShopfloorInformationTypes --- .../1.0.0/GetProductionForecast.ttl | 91 +++++++++++++++++++ .../1.0.0/metadata.json | 1 + .../RELEASE_NOTES.md | 7 ++ 3 files changed, 99 insertions(+) create mode 100644 io.catenax.mpShopfloorInformationTypes/1.0.0/GetProductionForecast.ttl create mode 100644 io.catenax.mpShopfloorInformationTypes/1.0.0/metadata.json create mode 100644 io.catenax.mpShopfloorInformationTypes/RELEASE_NOTES.md diff --git a/io.catenax.mpShopfloorInformationTypes/1.0.0/GetProductionForecast.ttl b/io.catenax.mpShopfloorInformationTypes/1.0.0/GetProductionForecast.ttl new file mode 100644 index 00000000..90225197 --- /dev/null +++ b/io.catenax.mpShopfloorInformationTypes/1.0.0/GetProductionForecast.ttl @@ -0,0 +1,91 @@ +########################################################################################## +# Copyright (c) 2023 Fraunhofer Institute of Optronics, System Technology and Image Exploitation (IOSB) +# Copyright (c) 2023 Siemens AG +# Copyright (c) 2023 Contributors to the Eclipse Foundation +# +# 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-header: . +@prefix ext-types: . + +:GetProductionForecast a samm:Aspect ; + samm:preferredName "Get Production Forecast"@en ; + samm:description "Aspect Model to request a production forecast"@en ; + samm:properties ( [ samm:property :request; samm:optional true ] ext-header:header ) ; + samm:operations ( ) ; + samm:events ( ) . + +:request a samm:Property ; + samm:preferredName "Request"@en ; + samm:description "Data model for a request"@en ; + samm:characteristic :RequestCharacteristic . + +:RequestCharacteristic a samm:Characteristic ; + samm:preferredName "Request Characteristic"@en ; + samm:description "DataType for a request"@en ; + samm:dataType :RequestEntity . + +:RequestEntity a samm:Entity ; + samm:preferredName "Request Entity"@en ; + samm:description "Entity for a request of a production forecast"@en ; + samm:properties ( :offset :customerId [ samm:property :precisionOfForecast; samm:optional true ] :productionForecast4All :orderId [ samm:property :deviationOfSchedule; samm:optional true ] [ samm:property :notificationInterval; samm:optional true ] ext-types:communicationMode ext-types:versionDataModel ) . + +:offset a samm:Property ; + samm:preferredName "offset"@en ; + samm:description "Send/start time of the first message/notification\n- \"0\" ==> immediate response"@en ; + samm:characteristic :TimeValueCharacteristic . + +:customerId a samm:Property ; + samm:preferredName "customerId"@en ; + samm:description "Internal customerId"@en ; + samm:characteristic ext-header:BpnCharacteristic ; + samm:exampleValue "BPNL7588787849VQ" . + +:precisionOfForecast a samm:Property ; + samm:preferredName "Precision of forecast"@en ; + samm:description "Accuracy of the time specification of the completion date.\n- default: implicitly defined by production\n- only as a REQUEST of the requester, since it cannot be guaranteed that the store floor can provide the data in this accuracy."@en ; + samm:characteristic :TimeValueCharacteristic . + +:productionForecast4All a samm:Property ; + samm:preferredName "Production forecast for all"@en ; + samm:description "Boolean variable that detemines whether the customer request information about each position of an order, or information about the complete order"@en ; + samm:characteristic samm-c:Boolean ; + samm:exampleValue false . + +:orderId a samm:Property ; + samm:preferredName "orderId"@en ; + samm:description "The Id identifying subject of the request"@en ; + samm:characteristic ext-header:UuidCharacteristic ; + samm:exampleValue "00000000-0000-0000-C000-000000000046" . + +:deviationOfSchedule a samm:Property ; + samm:preferredName "Deviation of Schedule"@en ; + samm:description "Mandatory property for the notification mode. The property specifies the deviation from targeted delivery date that must be met to send a notification to a subscriber"@en ; + samm:characteristic :TimeValueCharacteristic . + +:notificationInterval a samm:Property ; + samm:preferredName "Notification Interval"@en ; + samm:description "Interval time that either specifies the cyclic send time or limits the notification time"@en ; + samm:characteristic :TimeValueCharacteristic . + +:TimeValueCharacteristic a samm:Characteristic ; + samm:preferredName "TimeValueCharacteristic"@en ; + samm:description "Link to the TimeUnit Data Type"@en ; + samm:dataType ext-types:TimeValue . + diff --git a/io.catenax.mpShopfloorInformationTypes/1.0.0/metadata.json b/io.catenax.mpShopfloorInformationTypes/1.0.0/metadata.json new file mode 100644 index 00000000..84245e4e --- /dev/null +++ b/io.catenax.mpShopfloorInformationTypes/1.0.0/metadata.json @@ -0,0 +1 @@ +{ "status" : "release" } diff --git a/io.catenax.mpShopfloorInformationTypes/RELEASE_NOTES.md b/io.catenax.mpShopfloorInformationTypes/RELEASE_NOTES.md new file mode 100644 index 00000000..a76f8a91 --- /dev/null +++ b/io.catenax.mpShopfloorInformationTypes/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 ShopfloorInformationTypes \ No newline at end of file From e76905b1b7b5aaf671179fe80bfd2c79a4d217d1 Mon Sep 17 00:00:00 2001 From: "Jan Christoph Wehrstedt (Desktop)" Date: Thu, 13 Jul 2023 23:02:11 +0200 Subject: [PATCH 2/5] pull request get production forecast --- .../1.0.0/GetProductionForecast.ttl | 4 +- .../1.0.0/ShopfloorInformationTypes.ttl | 88 +++++++++++++++++++ .../1.0.0/metadata.json | 2 +- .../RELEASE_NOTES.md | 2 +- 4 files changed, 92 insertions(+), 4 deletions(-) create mode 100644 io.catenax.mpShopfloorInformationTypes/1.0.0/ShopfloorInformationTypes.ttl diff --git a/io.catenax.mpShopfloorInformationTypes/1.0.0/GetProductionForecast.ttl b/io.catenax.mpShopfloorInformationTypes/1.0.0/GetProductionForecast.ttl index 90225197..3ec8b855 100644 --- a/io.catenax.mpShopfloorInformationTypes/1.0.0/GetProductionForecast.ttl +++ b/io.catenax.mpShopfloorInformationTypes/1.0.0/GetProductionForecast.ttl @@ -1,7 +1,7 @@ ########################################################################################## # Copyright (c) 2023 Fraunhofer Institute of Optronics, System Technology and Image Exploitation (IOSB) # Copyright (c) 2023 Siemens AG -# Copyright (c) 2023 Contributors to the Eclipse Foundation +# Copyright (c) 2023 Contributors to the Eclipse Foundation # # See the NOTICE file(s) distributed with this work for additional # information regarding copyright ownership. @@ -12,7 +12,7 @@ # https://creativecommons.org/licenses/by/4.0/legalcode. # # SPDX-License-Identifier: CC-BY-4.0 -########################################################################################## +########################################################################################### @prefix samm: . @prefix samm-c: . @prefix samm-e: . diff --git a/io.catenax.mpShopfloorInformationTypes/1.0.0/ShopfloorInformationTypes.ttl b/io.catenax.mpShopfloorInformationTypes/1.0.0/ShopfloorInformationTypes.ttl new file mode 100644 index 00000000..e79b04bd --- /dev/null +++ b/io.catenax.mpShopfloorInformationTypes/1.0.0/ShopfloorInformationTypes.ttl @@ -0,0 +1,88 @@ +########################################################################################## +# Copyright (c) 2023 Fraunhofer Institute of Optronics, System Technology and Image Exploitation (IOSB) +# Copyright (c) 2023 Siemens AG +# Copyright (c) 2023 Contributors to the Eclipse Foundation +# +# 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-header: . + +:ShopfloorInformationTypes a samm:Aspect ; + samm:preferredName "Shopfloor Information Types"@en ; + samm:description "Collection of types used in multiple data models of the Shopfloor Information Service"@en ; + samm:properties ( :communicationMode :versionDataModel :timeValue ) ; + samm:operations ( ) ; + samm:events ( ) . + +:communicationMode a samm:Property ; + samm:preferredName "communication Mode"@en ; + samm:description "Specification of the communication mode"@en ; + samm:characteristic :CommunicationModeEnum ; + samm:exampleValue "synchronous" . + +:versionDataModel a samm:Property ; + samm:preferredName "version Data Model"@en ; + samm:description "Specifies the used version of the data model"@en ; + samm:characteristic ext-header:VersionCharacteristic ; + samm:exampleValue "urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0" . + +:timeValue a samm:Property ; + samm:preferredName "Time Value"@en ; + samm:description "A time Value property"@en ; + samm:characteristic :TimeValueCharacteristic . + +:CommunicationModeEnum a samm-c:Enumeration ; + samm:preferredName "Communication Mode Enumeration"@en ; + samm:description "Enumerates all possible communication modes"@en ; + samm:dataType xsd:string ; + samm-c:values ( "synchronous" "cyclic" "notification" ) . + +:TimeValueCharacteristic a samm:Characteristic ; + samm:preferredName "Time Value Characteristic"@en ; + samm:description "Link to the TimeUnit Data Type"@en ; + samm:dataType :TimeValue . + +:TimeValue a samm:Entity ; + samm:preferredName "TimeValue"@en ; + samm:description "Datatype to express a time value"@en ; + samm:properties ( :timeUnit :value ) . + +:timeUnit a samm:Property ; + samm:preferredName "time Unit"@en ; + samm:description "Specifies the unit in which the time is represented"@en ; + samm:characteristic :TimeUnitEnum ; + samm:exampleValue "Hour" . + +:value a samm:Property ; + samm:preferredName "value"@en ; + samm:description "The amount of timeUnits considered"@en ; + samm:characteristic :IntegerValueCharacteristic ; + samm:exampleValue 12 . + +:TimeUnitEnum a samm-c:Enumeration ; + samm:preferredName "TimeUnitEnum"@en ; + samm:description "Enumerates all possible time units"@en ; + samm:dataType xsd:string ; + samm-c:values ( "Month" "Day" "Week" "Hour" "Minute" "Second" ) . + +:IntegerValueCharacteristic a samm:Characteristic ; + samm:preferredName "Integer Value Characteristic"@en ; + samm:description "The value of the specified timeUnit as an integer value"@en ; + samm:dataType xsd:integer . + diff --git a/io.catenax.mpShopfloorInformationTypes/1.0.0/metadata.json b/io.catenax.mpShopfloorInformationTypes/1.0.0/metadata.json index 84245e4e..9e063c55 100644 --- a/io.catenax.mpShopfloorInformationTypes/1.0.0/metadata.json +++ b/io.catenax.mpShopfloorInformationTypes/1.0.0/metadata.json @@ -1 +1 @@ -{ "status" : "release" } +{ "status" : "release" } diff --git a/io.catenax.mpShopfloorInformationTypes/RELEASE_NOTES.md b/io.catenax.mpShopfloorInformationTypes/RELEASE_NOTES.md index a76f8a91..847a0b0f 100644 --- a/io.catenax.mpShopfloorInformationTypes/RELEASE_NOTES.md +++ b/io.catenax.mpShopfloorInformationTypes/RELEASE_NOTES.md @@ -1,6 +1,6 @@ # Changelog -All notable changes to this model will be documented in this file. +All notable changes to this model will be documented in this file. ## [1.0.0] From cb8668268f0385d9da8bb80b61f83236e2cf70b2 Mon Sep 17 00:00:00 2001 From: "Jan Christoph Wehrstedt (Desktop)" Date: Fri, 14 Jul 2023 15:36:11 +0200 Subject: [PATCH 3/5] update of common data after review --- .../1.0.0/GetProductionForecast.ttl | 91 ------------------- .../1.0.0/metadata.json | 1 - .../1.0.0/ShopfloorInformationTypes.ttl | 23 +++-- .../RELEASE_NOTES.md | 0 4 files changed, 11 insertions(+), 104 deletions(-) delete mode 100644 io.catenax.mpShopfloorInformationTypes/1.0.0/GetProductionForecast.ttl delete mode 100644 io.catenax.mpShopfloorInformationTypes/1.0.0/metadata.json rename {io.catenax.mpShopfloorInformationTypes => io.catenax.shared.shopfloor_information_types}/1.0.0/ShopfloorInformationTypes.ttl (83%) rename {io.catenax.mpShopfloorInformationTypes => io.catenax.shared.shopfloor_information_types}/RELEASE_NOTES.md (100%) diff --git a/io.catenax.mpShopfloorInformationTypes/1.0.0/GetProductionForecast.ttl b/io.catenax.mpShopfloorInformationTypes/1.0.0/GetProductionForecast.ttl deleted file mode 100644 index 3ec8b855..00000000 --- a/io.catenax.mpShopfloorInformationTypes/1.0.0/GetProductionForecast.ttl +++ /dev/null @@ -1,91 +0,0 @@ -########################################################################################## -# Copyright (c) 2023 Fraunhofer Institute of Optronics, System Technology and Image Exploitation (IOSB) -# Copyright (c) 2023 Siemens AG -# Copyright (c) 2023 Contributors to the Eclipse Foundation -# -# 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-header: . -@prefix ext-types: . - -:GetProductionForecast a samm:Aspect ; - samm:preferredName "Get Production Forecast"@en ; - samm:description "Aspect Model to request a production forecast"@en ; - samm:properties ( [ samm:property :request; samm:optional true ] ext-header:header ) ; - samm:operations ( ) ; - samm:events ( ) . - -:request a samm:Property ; - samm:preferredName "Request"@en ; - samm:description "Data model for a request"@en ; - samm:characteristic :RequestCharacteristic . - -:RequestCharacteristic a samm:Characteristic ; - samm:preferredName "Request Characteristic"@en ; - samm:description "DataType for a request"@en ; - samm:dataType :RequestEntity . - -:RequestEntity a samm:Entity ; - samm:preferredName "Request Entity"@en ; - samm:description "Entity for a request of a production forecast"@en ; - samm:properties ( :offset :customerId [ samm:property :precisionOfForecast; samm:optional true ] :productionForecast4All :orderId [ samm:property :deviationOfSchedule; samm:optional true ] [ samm:property :notificationInterval; samm:optional true ] ext-types:communicationMode ext-types:versionDataModel ) . - -:offset a samm:Property ; - samm:preferredName "offset"@en ; - samm:description "Send/start time of the first message/notification\n- \"0\" ==> immediate response"@en ; - samm:characteristic :TimeValueCharacteristic . - -:customerId a samm:Property ; - samm:preferredName "customerId"@en ; - samm:description "Internal customerId"@en ; - samm:characteristic ext-header:BpnCharacteristic ; - samm:exampleValue "BPNL7588787849VQ" . - -:precisionOfForecast a samm:Property ; - samm:preferredName "Precision of forecast"@en ; - samm:description "Accuracy of the time specification of the completion date.\n- default: implicitly defined by production\n- only as a REQUEST of the requester, since it cannot be guaranteed that the store floor can provide the data in this accuracy."@en ; - samm:characteristic :TimeValueCharacteristic . - -:productionForecast4All a samm:Property ; - samm:preferredName "Production forecast for all"@en ; - samm:description "Boolean variable that detemines whether the customer request information about each position of an order, or information about the complete order"@en ; - samm:characteristic samm-c:Boolean ; - samm:exampleValue false . - -:orderId a samm:Property ; - samm:preferredName "orderId"@en ; - samm:description "The Id identifying subject of the request"@en ; - samm:characteristic ext-header:UuidCharacteristic ; - samm:exampleValue "00000000-0000-0000-C000-000000000046" . - -:deviationOfSchedule a samm:Property ; - samm:preferredName "Deviation of Schedule"@en ; - samm:description "Mandatory property for the notification mode. The property specifies the deviation from targeted delivery date that must be met to send a notification to a subscriber"@en ; - samm:characteristic :TimeValueCharacteristic . - -:notificationInterval a samm:Property ; - samm:preferredName "Notification Interval"@en ; - samm:description "Interval time that either specifies the cyclic send time or limits the notification time"@en ; - samm:characteristic :TimeValueCharacteristic . - -:TimeValueCharacteristic a samm:Characteristic ; - samm:preferredName "TimeValueCharacteristic"@en ; - samm:description "Link to the TimeUnit Data Type"@en ; - samm:dataType ext-types:TimeValue . - diff --git a/io.catenax.mpShopfloorInformationTypes/1.0.0/metadata.json b/io.catenax.mpShopfloorInformationTypes/1.0.0/metadata.json deleted file mode 100644 index 9e063c55..00000000 --- a/io.catenax.mpShopfloorInformationTypes/1.0.0/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{ "status" : "release" } diff --git a/io.catenax.mpShopfloorInformationTypes/1.0.0/ShopfloorInformationTypes.ttl b/io.catenax.shared.shopfloor_information_types/1.0.0/ShopfloorInformationTypes.ttl similarity index 83% rename from io.catenax.mpShopfloorInformationTypes/1.0.0/ShopfloorInformationTypes.ttl rename to io.catenax.shared.shopfloor_information_types/1.0.0/ShopfloorInformationTypes.ttl index e79b04bd..1b5ddf28 100644 --- a/io.catenax.mpShopfloorInformationTypes/1.0.0/ShopfloorInformationTypes.ttl +++ b/io.catenax.shared.shopfloor_information_types/1.0.0/ShopfloorInformationTypes.ttl @@ -21,7 +21,7 @@ @prefix rdfs: . @prefix xsd: . @prefix : . -@prefix ext-header: . +@prefix ext-header: . :ShopfloorInformationTypes a samm:Aspect ; samm:preferredName "Shopfloor Information Types"@en ; @@ -31,15 +31,15 @@ samm:events ( ) . :communicationMode a samm:Property ; - samm:preferredName "communication Mode"@en ; + samm:preferredName "Communication Mode"@en ; samm:description "Specification of the communication mode"@en ; samm:characteristic :CommunicationModeEnum ; samm:exampleValue "synchronous" . :versionDataModel a samm:Property ; - samm:preferredName "version Data Model"@en ; + samm:preferredName "Version Data Model"@en ; samm:description "Specifies the used version of the data model"@en ; - samm:characteristic ext-header:VersionCharacteristic ; + samm:characteristic ext-header:BpnCharacteristic ; samm:exampleValue "urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0" . :timeValue a samm:Property ; @@ -64,22 +64,21 @@ samm:properties ( :timeUnit :value ) . :timeUnit a samm:Property ; - samm:preferredName "time Unit"@en ; + samm:preferredName "Time Unit"@en ; samm:description "Specifies the unit in which the time is represented"@en ; - samm:characteristic :TimeUnitEnum ; - samm:exampleValue "Hour" . + samm:characteristic :TimeUnitEnum . :value a samm:Property ; - samm:preferredName "value"@en ; + samm:preferredName "Value"@en ; samm:description "The amount of timeUnits considered"@en ; samm:characteristic :IntegerValueCharacteristic ; samm:exampleValue 12 . :TimeUnitEnum a samm-c:Enumeration ; - samm:preferredName "TimeUnitEnum"@en ; - samm:description "Enumerates all possible time units"@en ; - samm:dataType xsd:string ; - samm-c:values ( "Month" "Day" "Week" "Hour" "Minute" "Second" ) . + samm:preferredName "Time Unit Enum"@en ; + samm:description "Enumerates all time units"@en ; + samm:dataType samm:curie ; + samm-c:values ( "unit:secondUnitOfTime"^^samm:curie "unit:minuteUnitOfTime"^^samm:curie "unit:hour"^^samm:curie "unit:day"^^samm:curie "unit:week"^^samm:curie "unit:month"^^samm:curie "unit:year"^^samm:curie ) . :IntegerValueCharacteristic a samm:Characteristic ; samm:preferredName "Integer Value Characteristic"@en ; diff --git a/io.catenax.mpShopfloorInformationTypes/RELEASE_NOTES.md b/io.catenax.shared.shopfloor_information_types/RELEASE_NOTES.md similarity index 100% rename from io.catenax.mpShopfloorInformationTypes/RELEASE_NOTES.md rename to io.catenax.shared.shopfloor_information_types/RELEASE_NOTES.md From b05aa6a441ea1a571eb4f34d77ac4a6b7ce75e4b Mon Sep 17 00:00:00 2001 From: "Jan Christoph Wehrstedt (Desktop)" Date: Fri, 14 Jul 2023 15:43:29 +0200 Subject: [PATCH 4/5] metadata added --- .../1.0.0/metadata.json | 1 + 1 file changed, 1 insertion(+) create mode 100644 io.catenax.shared.shopfloor_information_types/1.0.0/metadata.json diff --git a/io.catenax.shared.shopfloor_information_types/1.0.0/metadata.json b/io.catenax.shared.shopfloor_information_types/1.0.0/metadata.json new file mode 100644 index 00000000..84245e4e --- /dev/null +++ b/io.catenax.shared.shopfloor_information_types/1.0.0/metadata.json @@ -0,0 +1 @@ +{ "status" : "release" } From 05cebba2d0da87932ea13bfbd0783efbe013ad71 Mon Sep 17 00:00:00 2001 From: Dominik Oeh Date: Fri, 4 Aug 2023 14:19:42 +0200 Subject: [PATCH 5/5] fix: message header prefix update message header prefix to shared namespace --- .../1.0.0/ShopfloorInformationTypes.ttl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/io.catenax.shared.shopfloor_information_types/1.0.0/ShopfloorInformationTypes.ttl b/io.catenax.shared.shopfloor_information_types/1.0.0/ShopfloorInformationTypes.ttl index 1b5ddf28..521259ce 100644 --- a/io.catenax.shared.shopfloor_information_types/1.0.0/ShopfloorInformationTypes.ttl +++ b/io.catenax.shared.shopfloor_information_types/1.0.0/ShopfloorInformationTypes.ttl @@ -21,7 +21,7 @@ @prefix rdfs: . @prefix xsd: . @prefix : . -@prefix ext-header: . +@prefix ext-header: . :ShopfloorInformationTypes a samm:Aspect ; samm:preferredName "Shopfloor Information Types"@en ; @@ -59,7 +59,7 @@ samm:dataType :TimeValue . :TimeValue a samm:Entity ; - samm:preferredName "TimeValue"@en ; + samm:preferredName "Time Value"@en ; samm:description "Datatype to express a time value"@en ; samm:properties ( :timeUnit :value ) .