Merge pull request #235 from wehrstedt-jan/getShopfloorInformation

created first version of getShopfloorInformationAspect

io.catenax.shopfloor_information.get_production_forecast/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: <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.shopfloor_information.production_forecast_request:1.0.0#> .
+@prefix ext-header: <urn:samm:io.catenax.shared.message_header:1.0.0#> .
+@prefix ext-types: <urn:samm:io.catenax.shared.shopfloor_information_types:1.0.0#> .
+
+: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 "Data type 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 ] :productionForecastForAll :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 .
+
+:productionForecastForAll 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\n\nmandatory for CommunicationMode = \"notification\""@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\nmandatory for CommunicationMode = \"cyclic\""@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 .
+

io.catenax.shopfloor_information.get_production_forecast/1.0.0/metadata.json

@@ -0,0 +1 @@
+{ "status" : "release" }

io.catenax.shopfloor_information.get_production_forecast/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 get production forecast