From 4b60b72148102925e7993341acc160af1c124ce8 Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Thu, 14 Dec 2023 11:14:24 +0100 Subject: [PATCH 01/27] feat: first draft of the Messaging model --- io.catenax.messaging/1.0.0/Messaging.ttl | 112 +++++++++++++++++++++++ io.catenax.messaging/1.0.0/metadata.json | 1 + io.catenax.messaging/RELEASE_NOTES.md | 7 ++ 3 files changed, 120 insertions(+) create mode 100644 io.catenax.messaging/1.0.0/Messaging.ttl create mode 100644 io.catenax.messaging/1.0.0/metadata.json create mode 100644 io.catenax.messaging/RELEASE_NOTES.md diff --git a/io.catenax.messaging/1.0.0/Messaging.ttl b/io.catenax.messaging/1.0.0/Messaging.ttl new file mode 100644 index 00000000..02d7531f --- /dev/null +++ b/io.catenax.messaging/1.0.0/Messaging.ttl @@ -0,0 +1,112 @@ +####################################################################### +# Copyright (c) 2023 ISTOS GmbH (a member of the DMG Mori Group) +# Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST) +# Copyright (c) 2023 TRUMPF Werkzeugmaschinen SE + Co. KG +# Copyright (c) 2023 Volkswagen 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-information: . +@prefix ext-uuid: . + +:Messaging a samm:Aspect; + samm:preferredName "Messaging"@en; + samm:description "This aspect model defines the standard for message exchange between business partners. Messages refer to specific events which affect production or demand."@en; + samm:properties ([ + samm:property :affectedSitesSender; + samm:optional "true"^^xsd:boolean +] [ + samm:property :affectedSitesReceiver; + samm:optional "true"^^xsd:boolean +] :leadingRootCause :effect [ + samm:property :message; + samm:optional "true"^^xsd:boolean +] [ + samm:property :materialNumberDigitalTwin; + samm:optional "true"^^xsd:boolean +] :startDateOfEffect [ + samm:property :expectedEndDateOfEffect; + samm:optional "true"^^xsd:boolean +] :status [ + samm:property ext-information:materialNumberCustomer; + samm:optional "true"^^xsd:boolean +] [ + samm:property ext-information:materialNumberSupplier; + samm:optional "true"^^xsd:boolean +]); + samm:operations (); + samm:events (). +:affectedSitesSender a samm:Property; + samm:preferredName "Affected sites of the sender."@en; + samm:description "A set of BPNS of the sender which are affected."@en; + samm:characteristic :AffectedSitesSet; + samm:exampleValue "BPNS7588787849VQ". +:affectedSitesReceiver a samm:Property; + samm:preferredName "Affected sites of the receiver"@en; + samm:description "A set of BPNS of the receiver that are affected."@en; + samm:characteristic :AffectedSitesSet; + samm:exampleValue "BPNS6666787765VQ". +:leadingRootCause a samm:Property; + samm:preferredName "Leading root cause"@en; + samm:description "The main cause which affects the demand or production."@en; + samm:characteristic :LeadingRootCauseEnumeration; + samm:exampleValue "strike". +:effect a samm:Property; + samm:preferredName "Effect"@en; + samm:characteristic :EffectEnumeration; + samm:exampleValue "capacity-reduction". +:message a samm:Property; + samm:preferredName "Message."@en; + samm:characteristic :UserInputCharacteristic; + samm:exampleValue "HelloWorld". +:materialNumberDigitalTwin a samm:Property; + samm:preferredName "Material number digital twin."@en; + samm:characteristic ext-uuid:UuidV4Trait; + samm:exampleValue "f81d4fae-7dec-11d0-a765-00a0c91e6bf6". +:startDateOfEffect a samm:Property; + samm:preferredName "Start date of the effect."@en; + samm:characteristic ext-information:DateTimeStamp; + samm:exampleValue "2023-12-13T15:00:00+01:00"^^xsd:dateTime. +:expectedEndDateOfEffect a samm:Property; + samm:preferredName "Expected end date of effect."@en; + samm:characteristic ext-information:DateTimeStamp; + samm:exampleValue "2023-12-17T08:00:00+01:00"^^xsd:dateTime. +:status a samm:Property; + samm:preferredName "Status"@en; + samm:characteristic :StatusEnumeration; + samm:exampleValue "new". +:AffectedSitesSet a samm-c:Set; + samm:preferredName "Set of affected sites."@en; + samm:dataType xsd:string. +:LeadingRootCauseEnumeration a samm-c:Enumeration; + samm:preferredName "Leading root cause enumeration."@en; + samm:dataType xsd:string; + samm-c:values ("strike" "earthquake" "fire" "flood" "other" "force-majeure"). +:EffectEnumeration a samm-c:Enumeration; + samm:preferredName "Effect enumeration."@en; + samm:dataType xsd:string; + samm-c:values ("demand-reduction" "demand-increase" "capacity-reduction" "capacity-increase"). +:UserInputCharacteristic a samm:Characteristic; + samm:preferredName "User input characteristic"@en; + samm:dataType xsd:string. +:StatusEnumeration a samm-c:Enumeration; + samm:preferredName "Status enumeration."@en; + samm:dataType xsd:string; + samm-c:values ("new" "resolved"). diff --git a/io.catenax.messaging/1.0.0/metadata.json b/io.catenax.messaging/1.0.0/metadata.json new file mode 100644 index 00000000..c22749ae --- /dev/null +++ b/io.catenax.messaging/1.0.0/metadata.json @@ -0,0 +1 @@ +{ "status" : "release"} diff --git a/io.catenax.messaging/RELEASE_NOTES.md b/io.catenax.messaging/RELEASE_NOTES.md new file mode 100644 index 00000000..054ad929 --- /dev/null +++ b/io.catenax.messaging/RELEASE_NOTES.md @@ -0,0 +1,7 @@ +# Changelog +All notable changes to this model will be documented in this file. + +## [1.0.0] +### Added +- initial model + From 5078c17570d998b93e9bfdd4cd2b17b7fbc29efe Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Mon, 15 Jan 2024 12:20:32 +0100 Subject: [PATCH 02/27] refactor: renamed Messaging to Notification --- .../1.0.0/Notification.ttl | 10 +++++----- .../1.0.0/metadata.json | 0 .../RELEASE_NOTES.md | 0 3 files changed, 5 insertions(+), 5 deletions(-) rename io.catenax.messaging/1.0.0/Messaging.ttl => io.catenax.notification/1.0.0/Notification.ttl (94%) rename {io.catenax.messaging => io.catenax.notification}/1.0.0/metadata.json (100%) rename {io.catenax.messaging => io.catenax.notification}/RELEASE_NOTES.md (100%) diff --git a/io.catenax.messaging/1.0.0/Messaging.ttl b/io.catenax.notification/1.0.0/Notification.ttl similarity index 94% rename from io.catenax.messaging/1.0.0/Messaging.ttl rename to io.catenax.notification/1.0.0/Notification.ttl index 02d7531f..feb084fb 100644 --- a/io.catenax.messaging/1.0.0/Messaging.ttl +++ b/io.catenax.notification/1.0.0/Notification.ttl @@ -22,13 +22,13 @@ @prefix rdf: . @prefix rdfs: . @prefix xsd: . -@prefix : . +@prefix : . @prefix ext-information: . @prefix ext-uuid: . -:Messaging a samm:Aspect; +:Notification a samm:Aspect; samm:preferredName "Messaging"@en; - samm:description "This aspect model defines the standard for message exchange between business partners. Messages refer to specific events which affect production or demand."@en; + samm:description "This aspect model defines the standard for notification exchange between business partners. Notification refers to specific events which affect production or demand."@en; samm:properties ([ samm:property :affectedSitesSender; samm:optional "true"^^xsd:boolean @@ -91,7 +91,7 @@ :status a samm:Property; samm:preferredName "Status"@en; samm:characteristic :StatusEnumeration; - samm:exampleValue "new". + samm:exampleValue "open". :AffectedSitesSet a samm-c:Set; samm:preferredName "Set of affected sites."@en; samm:dataType xsd:string. @@ -109,4 +109,4 @@ :StatusEnumeration a samm-c:Enumeration; samm:preferredName "Status enumeration."@en; samm:dataType xsd:string; - samm-c:values ("new" "resolved"). + samm-c:values ("resolved" "open"). diff --git a/io.catenax.messaging/1.0.0/metadata.json b/io.catenax.notification/1.0.0/metadata.json similarity index 100% rename from io.catenax.messaging/1.0.0/metadata.json rename to io.catenax.notification/1.0.0/metadata.json diff --git a/io.catenax.messaging/RELEASE_NOTES.md b/io.catenax.notification/RELEASE_NOTES.md similarity index 100% rename from io.catenax.messaging/RELEASE_NOTES.md rename to io.catenax.notification/RELEASE_NOTES.md From bb07580c7e0d65aa2e54dd2a4a85a42c818f91e8 Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Mon, 15 Jan 2024 12:27:41 +0100 Subject: [PATCH 03/27] feat: added properties contentChangedAt and relatedSourceMessageId --- .../1.0.0/Notification.ttl | 22 ++++++++++++++----- 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/io.catenax.notification/1.0.0/Notification.ttl b/io.catenax.notification/1.0.0/Notification.ttl index feb084fb..4a6ea64a 100644 --- a/io.catenax.notification/1.0.0/Notification.ttl +++ b/io.catenax.notification/1.0.0/Notification.ttl @@ -36,7 +36,7 @@ samm:property :affectedSitesReceiver; samm:optional "true"^^xsd:boolean ] :leadingRootCause :effect [ - samm:property :message; + samm:property :text; samm:optional "true"^^xsd:boolean ] [ samm:property :materialNumberDigitalTwin; @@ -50,7 +50,7 @@ ] [ samm:property ext-information:materialNumberSupplier; samm:optional "true"^^xsd:boolean -]); +] :contentChangedAt :relatedSourceMessageId); samm:operations (); samm:events (). :affectedSitesSender a samm:Property; @@ -72,10 +72,6 @@ samm:preferredName "Effect"@en; samm:characteristic :EffectEnumeration; samm:exampleValue "capacity-reduction". -:message a samm:Property; - samm:preferredName "Message."@en; - samm:characteristic :UserInputCharacteristic; - samm:exampleValue "HelloWorld". :materialNumberDigitalTwin a samm:Property; samm:preferredName "Material number digital twin."@en; samm:characteristic ext-uuid:UuidV4Trait; @@ -90,6 +86,7 @@ samm:exampleValue "2023-12-17T08:00:00+01:00"^^xsd:dateTime. :status a samm:Property; samm:preferredName "Status"@en; + samm:description "Status of the notification"@en; samm:characteristic :StatusEnumeration; samm:exampleValue "open". :AffectedSitesSet a samm-c:Set; @@ -110,3 +107,16 @@ samm:preferredName "Status enumeration."@en; samm:dataType xsd:string; samm-c:values ("resolved" "open"). +:text a samm:Property; + samm:preferredName "Text"@en; + samm:description "Free text description for notification. The sender MUST respect data privacy laws."@en; + samm:characteristic :UserInputCharacteristic; + samm:exampleValue "HelloWorld". +:contentChangedAt a samm:Property; + samm:preferredName "Content changed at"@en; + samm:description "The timestamp of the latest change of this notification"@en; + samm:characteristic ext-information:DateTimeStamp. +:relatedSourceMessageId a samm:Property; + samm:preferredName "Related Source Message ID"@en; + samm:description "Unique ID identifying a source message somehow related to the current one."@en; + samm:characteristic ext-uuid:UuidV4Trait. From 32996342e1405b175c358705e4f3486927105ab8 Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Wed, 17 Jan 2024 15:22:13 +0100 Subject: [PATCH 04/27] feat: updated the model according to the newest information --- .../1.0.0/Notification.ttl | 97 +++++++++++++------ 1 file changed, 66 insertions(+), 31 deletions(-) diff --git a/io.catenax.notification/1.0.0/Notification.ttl b/io.catenax.notification/1.0.0/Notification.ttl index 4a6ea64a..02ba997e 100644 --- a/io.catenax.notification/1.0.0/Notification.ttl +++ b/io.catenax.notification/1.0.0/Notification.ttl @@ -24,6 +24,7 @@ @prefix xsd: . @prefix : . @prefix ext-information: . +@prefix ext-number: . @prefix ext-uuid: . :Notification a samm:Aspect; @@ -33,7 +34,7 @@ samm:property :affectedSitesSender; samm:optional "true"^^xsd:boolean ] [ - samm:property :affectedSitesReceiver; + samm:property :affectedSitesRecipient; samm:optional "true"^^xsd:boolean ] :leadingRootCause :effect [ samm:property :text; @@ -44,24 +45,24 @@ ] :startDateOfEffect [ samm:property :expectedEndDateOfEffect; samm:optional "true"^^xsd:boolean -] :status [ - samm:property ext-information:materialNumberCustomer; +] :status :contentChangedAt :relatedSourceMessageId [ + samm:property :materialNumberSupplier; samm:optional "true"^^xsd:boolean ] [ - samm:property ext-information:materialNumberSupplier; + samm:property :materialNumberCustomer; samm:optional "true"^^xsd:boolean -] :contentChangedAt :relatedSourceMessageId); +]); samm:operations (); samm:events (). :affectedSitesSender a samm:Property; samm:preferredName "Affected sites of the sender."@en; - samm:description "A set of BPNS of the sender which are affected."@en; - samm:characteristic :AffectedSitesSet; + samm:description "The affected Business Partner SITE Numbers of the sending party.\n\nThe value must be a valid BPNS. Applicable constraints are defined in the corresponding standard.\n\nIt is RECOMMENDED to sent the sender BPNS. It MUST be possible to select multiple sender BPNS."@en; + samm:characteristic :AffectedSitesCharacteristic; samm:exampleValue "BPNS7588787849VQ". -:affectedSitesReceiver a samm:Property; - samm:preferredName "Affected sites of the receiver"@en; - samm:description "A set of BPNS of the receiver that are affected."@en; - samm:characteristic :AffectedSitesSet; +:affectedSitesRecipient a samm:Property; + samm:preferredName "Affected sites of the recipient"@en; + samm:description "The affected Business Partner SITE Numbers of the receiving party.\n\nThe value must be a valid BPNS. Applicable constraints are defined in the corresponding standard.\n\nIt is RECOMMENDED to send the receiver BPNS. It MUST be possible to select multiple receiver BPNS."@en; + samm:characteristic :AffectedSitesCharacteristic; samm:exampleValue "BPNS6666787765VQ". :leadingRootCause a samm:Property; samm:preferredName "Leading root cause"@en; @@ -70,53 +71,87 @@ samm:exampleValue "strike". :effect a samm:Property; samm:preferredName "Effect"@en; + samm:description "Message Category / Impact\n\nFrom user perspective demand/capacity reduction are most relevant values in connection with above mentioned root causes. For technical completeness demand/capacity increase are also added to the value list."@en; samm:characteristic :EffectEnumeration; samm:exampleValue "capacity-reduction". +:text a samm:Property; + samm:preferredName "Text"@en; + samm:description "Free text description for notification (max. 4000 characters).\n\nThe sender MUST respect data privacy laws."@en; + samm:characteristic :UserInputCharacteristic; + samm:exampleValue "Capacity reduction due to ongoing strike". :materialNumberDigitalTwin a samm:Property; samm:preferredName "Material number digital twin."@en; - samm:characteristic ext-uuid:UuidV4Trait; + samm:characteristic :MaterialNumberDigitalTwinCharacteristic; samm:exampleValue "f81d4fae-7dec-11d0-a765-00a0c91e6bf6". :startDateOfEffect a samm:Property; samm:preferredName "Start date of the effect."@en; + samm:description "Expected start date of the impact MUST be shared by the sender of the message.\n\nThis also covers cases where sending of the message and start of the impact differ from each other.\n\nThe value MUST be formatted according to the ISO 8601 standard."@en; samm:characteristic ext-information:DateTimeStamp; samm:exampleValue "2023-12-13T15:00:00+01:00"^^xsd:dateTime. :expectedEndDateOfEffect a samm:Property; samm:preferredName "Expected end date of effect."@en; + samm:description "Expected end date of the impact MAY be mentioned by the sender of the message.\n\nThe value MUST be formatted according to the ISO 8601 standard."@en; samm:characteristic ext-information:DateTimeStamp; samm:exampleValue "2023-12-17T08:00:00+01:00"^^xsd:dateTime. :status a samm:Property; samm:preferredName "Status"@en; - samm:description "Status of the notification"@en; + samm:description "Status of the notification."@en; samm:characteristic :StatusEnumeration; samm:exampleValue "open". -:AffectedSitesSet a samm-c:Set; - samm:preferredName "Set of affected sites."@en; - samm:dataType xsd:string. +:contentChangedAt a samm:Property; + samm:preferredName "Content changed at"@en; + samm:description "The timestamp of the latest change of this notification."@en; + samm:characteristic ext-information:DateTimeStamp; + samm:exampleValue "2023-12-13T15:00:00+01:00"^^xsd:dateTime. +:relatedSourceMessageId a samm:Property; + samm:preferredName "Related Source Message ID"@en; + samm:description "Unique ID identifying a source message somehow related to the current one."@en; + samm:characteristic :UuidV4Trait. +:materialNumberSupplier a samm:Property; + samm:preferredName "Supplier Material Number"@en; + samm:description "Material identifier as assigned by the supplier. This material number identifies the material (as estimated) in the supplier's database."@en; + samm:characteristic :MaterialNumberCharacteristic; + samm:exampleValue "MNR-8101-ID146955.001". +:materialNumberCustomer a samm:Property; + samm:preferredName "Customer Material Number"@en; + samm:description "Material identifier as assigned by the customer. This material number identifies the material (as estimated) in the customer's database. For standard parts (e.g. screws) for which a customer does not have an own number, the material number supplier should be set in this field, too."@en; + samm:characteristic :MaterialNumberCharacteristic; + samm:exampleValue "MNR-7307-AU340474.002". +:AffectedSitesCharacteristic a samm-c:Set; + samm:preferredName "Affected Sites"@en; + samm:description "A set of sites that are affected by the mentioned leadingRootCause."@en; + samm:dataType xsd:string; + samm-c:elementCharacteristic :BPNSTrait. :LeadingRootCauseEnumeration a samm-c:Enumeration; samm:preferredName "Leading root cause enumeration."@en; samm:dataType xsd:string; - samm-c:values ("strike" "earthquake" "fire" "flood" "other" "force-majeure"). + samm-c:values ("strike" "natural-disaster" "production-incident" "pandemic-or-epidemic" "logistics-disruption" "war" "other"). :EffectEnumeration a samm-c:Enumeration; - samm:preferredName "Effect enumeration."@en; + samm:preferredName "Effect enumeration"@en; + samm:description "Enumeration of possible effects due to the mentioned leadingRootCause."@en; samm:dataType xsd:string; samm-c:values ("demand-reduction" "demand-increase" "capacity-reduction" "capacity-increase"). :UserInputCharacteristic a samm:Characteristic; samm:preferredName "User input characteristic"@en; samm:dataType xsd:string. +:MaterialNumberDigitalTwinCharacteristic a samm-c:Set; + samm:preferredName "Material Number Digital Twin Characteristic"@en; + samm:dataType xsd:string; + samm-c:elementCharacteristic :UuidV4Trait. :StatusEnumeration a samm-c:Enumeration; samm:preferredName "Status enumeration."@en; samm:dataType xsd:string; samm-c:values ("resolved" "open"). -:text a samm:Property; - samm:preferredName "Text"@en; - samm:description "Free text description for notification. The sender MUST respect data privacy laws."@en; - samm:characteristic :UserInputCharacteristic; - samm:exampleValue "HelloWorld". -:contentChangedAt a samm:Property; - samm:preferredName "Content changed at"@en; - samm:description "The timestamp of the latest change of this notification"@en; - samm:characteristic ext-information:DateTimeStamp. -:relatedSourceMessageId a samm:Property; - samm:preferredName "Related Source Message ID"@en; - samm:description "Unique ID identifying a source message somehow related to the current one."@en; - samm:characteristic ext-uuid:UuidV4Trait. +:UuidV4Trait a samm-c:Trait; + samm:preferredName "UUID v4 Trait"@en; + samm-c:baseCharacteristic ext-uuid:Uuidv4Characteristic; + samm-c:constraint ext-uuid:Uuidv4RegularExpression. +:BPNSTrait a samm-c:Trait; + samm:preferredName "BPNS Trait"@en; + samm:description "Trait to ensure data format for BPNS."@en; + samm-c:baseCharacteristic ext-number:BpnsCharacteristic; + samm-c:constraint ext-number:BpnsRegularExpression. +:MaterialNumberCharacteristic a samm:Characteristic; + samm:preferredName "Material Number"@en; + samm:description "The material number is a multi-character string, usually assigned by an ERP system."@en; + samm:dataType xsd:string. From 650528a2adfdbfe159804ce3536a71778ce15278 Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Mon, 29 Jan 2024 13:37:56 +0100 Subject: [PATCH 05/27] feat: added & refined some descriptions --- .../1.0.0/Notification.ttl | 57 ++++++++++++------- 1 file changed, 36 insertions(+), 21 deletions(-) diff --git a/io.catenax.notification/1.0.0/Notification.ttl b/io.catenax.notification/1.0.0/Notification.ttl index 02ba997e..a0ae4239 100644 --- a/io.catenax.notification/1.0.0/Notification.ttl +++ b/io.catenax.notification/1.0.0/Notification.ttl @@ -45,7 +45,10 @@ ] :startDateOfEffect [ samm:property :expectedEndDateOfEffect; samm:optional "true"^^xsd:boolean -] :status :contentChangedAt :relatedSourceMessageId [ +] :status :contentChangedAt [ + samm:property :relatedSourceMessageId; + samm:optional "true"^^xsd:boolean +] [ samm:property :materialNumberSupplier; samm:optional "true"^^xsd:boolean ] [ @@ -66,21 +69,22 @@ samm:exampleValue "BPNS6666787765VQ". :leadingRootCause a samm:Property; samm:preferredName "Leading root cause"@en; - samm:description "The main cause which affects the demand or production."@en; + samm:description "The main cause that has or may have an impact on the supply of goods."@en; samm:characteristic :LeadingRootCauseEnumeration; samm:exampleValue "strike". :effect a samm:Property; samm:preferredName "Effect"@en; - samm:description "Message Category / Impact\n\nFrom user perspective demand/capacity reduction are most relevant values in connection with above mentioned root causes. For technical completeness demand/capacity increase are also added to the value list."@en; + samm:description "Effect or impact on the supply of goods as a consequence of the leadingRootCause.\n\nFrom business perspective demand/capacity reduction are most relevant values in connection with above mentioned root causes. For technical completeness demand/capacity increase are also added to the value list."@en; samm:characteristic :EffectEnumeration; samm:exampleValue "capacity-reduction". :text a samm:Property; samm:preferredName "Text"@en; - samm:description "Free text description for notification (max. 4000 characters).\n\nThe sender MUST respect data privacy laws."@en; - samm:characteristic :UserInputCharacteristic; - samm:exampleValue "Capacity reduction due to ongoing strike". + samm:description "Free text description for notification (max. 4000 characters)."@en; + samm:characteristic :UserInputTrait; + samm:exampleValue "Capacity reduction due to ongoing strike.". :materialNumberDigitalTwin a samm:Property; - samm:preferredName "Material number digital twin."@en; + samm:preferredName "Material number Digital Twin"@en; + samm:description "UUID (DT Network Identifier): Via DT (Digital Twin) UUID a receiver is able to identify the own affected material numbers, because the digital twin is common for the sender and the receiver. If a digital twin is available, it is RECOMMENDED only exchanging the DT material number."@en; samm:characteristic :MaterialNumberDigitalTwinCharacteristic; samm:exampleValue "f81d4fae-7dec-11d0-a765-00a0c91e6bf6". :startDateOfEffect a samm:Property; @@ -95,7 +99,7 @@ samm:exampleValue "2023-12-17T08:00:00+01:00"^^xsd:dateTime. :status a samm:Property; samm:preferredName "Status"@en; - samm:description "Status of the notification."@en; + samm:description "Status \"open\" should be used in the context of an effect which remains active. Status \"resolved\" should be used to inform the other business that the effect of the initial notification stopped or has been resolved."@en; samm:characteristic :StatusEnumeration; samm:exampleValue "open". :contentChangedAt a samm:Property; @@ -105,18 +109,16 @@ samm:exampleValue "2023-12-13T15:00:00+01:00"^^xsd:dateTime. :relatedSourceMessageId a samm:Property; samm:preferredName "Related Source Message ID"@en; - samm:description "Unique ID identifying a source message somehow related to the current one."@en; + samm:description "Unique ID identifying a source message somehow related to the current one.\n\nProposal: Unique ID identifying the source message that started the notification thread."@en; samm:characteristic :UuidV4Trait. :materialNumberSupplier a samm:Property; samm:preferredName "Supplier Material Number"@en; - samm:description "Material identifier as assigned by the supplier. This material number identifies the material (as estimated) in the supplier's database."@en; - samm:characteristic :MaterialNumberCharacteristic; - samm:exampleValue "MNR-8101-ID146955.001". + samm:description "Material identifier as assigned by the supplier. This material number identifies the material in the supplier's database.\n\nIf the supplier is the sender, sending supplier material number is RECOMMENDED. It MUST be possible to send multiple supplier material numbers."@en; + samm:characteristic :MaterialNumberCharacteristic. :materialNumberCustomer a samm:Property; samm:preferredName "Customer Material Number"@en; - samm:description "Material identifier as assigned by the customer. This material number identifies the material (as estimated) in the customer's database. For standard parts (e.g. screws) for which a customer does not have an own number, the material number supplier should be set in this field, too."@en; - samm:characteristic :MaterialNumberCharacteristic; - samm:exampleValue "MNR-7307-AU340474.002". + samm:description "Material identifier as assigned by the customer. This material number identifies the material in the customer's database. For standard parts (e.g. screws) for which a customer does not have an own number, the material number supplier should be set in this field, too.\n\nIf the customer is the sender, it is RECOMMENDED to send the materialNumberCustomer. It MUST be possible to send multiple customer material numbers."@en; + samm:characteristic :MaterialNumberCharacteristic. :AffectedSitesCharacteristic a samm-c:Set; samm:preferredName "Affected Sites"@en; samm:description "A set of sites that are affected by the mentioned leadingRootCause."@en; @@ -124,6 +126,7 @@ samm-c:elementCharacteristic :BPNSTrait. :LeadingRootCauseEnumeration a samm-c:Enumeration; samm:preferredName "Leading root cause enumeration."@en; + samm:description "Possible root causes."@en; samm:dataType xsd:string; samm-c:values ("strike" "natural-disaster" "production-incident" "pandemic-or-epidemic" "logistics-disruption" "war" "other"). :EffectEnumeration a samm-c:Enumeration; @@ -131,27 +134,39 @@ samm:description "Enumeration of possible effects due to the mentioned leadingRootCause."@en; samm:dataType xsd:string; samm-c:values ("demand-reduction" "demand-increase" "capacity-reduction" "capacity-increase"). -:UserInputCharacteristic a samm:Characteristic; - samm:preferredName "User input characteristic"@en; - samm:dataType xsd:string. +:UserInputTrait a samm-c:Trait; + samm:preferredName "User Input Trait"@en; + samm:description "Trait to ensure correct values for the user input."@en; + samm-c:baseCharacteristic :UserInputCharacteristic; + samm-c:constraint :Constraint1. :MaterialNumberDigitalTwinCharacteristic a samm-c:Set; samm:preferredName "Material Number Digital Twin Characteristic"@en; + samm:description "A set of Digital Twin material numbers."@en; samm:dataType xsd:string; samm-c:elementCharacteristic :UuidV4Trait. :StatusEnumeration a samm-c:Enumeration; samm:preferredName "Status enumeration."@en; + samm:description "Status can be either \"open\" or \"resolved\"."@en; samm:dataType xsd:string; samm-c:values ("resolved" "open"). :UuidV4Trait a samm-c:Trait; samm:preferredName "UUID v4 Trait"@en; samm-c:baseCharacteristic ext-uuid:Uuidv4Characteristic; samm-c:constraint ext-uuid:Uuidv4RegularExpression. +:MaterialNumberCharacteristic a samm-c:Set; + samm:preferredName "Material Number"@en; + samm:description "The material number is a multi-character string, usually assigned by an ERP system of the customer or the supplier."@en; + samm:dataType xsd:string. :BPNSTrait a samm-c:Trait; samm:preferredName "BPNS Trait"@en; samm:description "Trait to ensure data format for BPNS."@en; samm-c:baseCharacteristic ext-number:BpnsCharacteristic; samm-c:constraint ext-number:BpnsRegularExpression. -:MaterialNumberCharacteristic a samm:Characteristic; - samm:preferredName "Material Number"@en; - samm:description "The material number is a multi-character string, usually assigned by an ERP system."@en; +:UserInputCharacteristic a samm:Characteristic; + samm:preferredName "User input characteristic"@en; + samm:description "User input can be any string that is max. 4000 characters."@en; samm:dataType xsd:string. +:Constraint1 a samm-c:LengthConstraint; + samm:preferredName "UserInputConstraint"@en; + samm:description "Constraint for a string to be max. 4000 characters long."@en; + samm-c:maxValue "4000"^^xsd:nonNegativeInteger. From 0e01cea53732412f597406041d6799ba21be7587 Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Mon, 29 Jan 2024 13:43:14 +0100 Subject: [PATCH 06/27] chore: renamed to "Notifications" --- .../1.0.0/Notifications.ttl | 6 +++--- .../1.0.0/metadata.json | 0 .../RELEASE_NOTES.md | 0 3 files changed, 3 insertions(+), 3 deletions(-) rename io.catenax.notification/1.0.0/Notification.ttl => io.catenax.notifications/1.0.0/Notifications.ttl (98%) rename {io.catenax.notification => io.catenax.notifications}/1.0.0/metadata.json (100%) rename {io.catenax.notification => io.catenax.notifications}/RELEASE_NOTES.md (100%) diff --git a/io.catenax.notification/1.0.0/Notification.ttl b/io.catenax.notifications/1.0.0/Notifications.ttl similarity index 98% rename from io.catenax.notification/1.0.0/Notification.ttl rename to io.catenax.notifications/1.0.0/Notifications.ttl index a0ae4239..dc835f8d 100644 --- a/io.catenax.notification/1.0.0/Notification.ttl +++ b/io.catenax.notifications/1.0.0/Notifications.ttl @@ -27,9 +27,9 @@ @prefix ext-number: . @prefix ext-uuid: . -:Notification a samm:Aspect; - samm:preferredName "Messaging"@en; - samm:description "This aspect model defines the standard for notification exchange between business partners. Notification refers to specific events which affect production or demand."@en; +:Notifications a samm:Aspect; + samm:preferredName "Notifications"@en; + samm:description "This aspect model defines the standard for notification exchange between business partners. Notifications refer to specific events which affect production or demand."@en; samm:properties ([ samm:property :affectedSitesSender; samm:optional "true"^^xsd:boolean diff --git a/io.catenax.notification/1.0.0/metadata.json b/io.catenax.notifications/1.0.0/metadata.json similarity index 100% rename from io.catenax.notification/1.0.0/metadata.json rename to io.catenax.notifications/1.0.0/metadata.json diff --git a/io.catenax.notification/RELEASE_NOTES.md b/io.catenax.notifications/RELEASE_NOTES.md similarity index 100% rename from io.catenax.notification/RELEASE_NOTES.md rename to io.catenax.notifications/RELEASE_NOTES.md From a8ecb79c111720b039db285703fb307815a71705 Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Mon, 29 Jan 2024 15:51:40 +0100 Subject: [PATCH 07/27] feat: replaced external timestamp characteristic by local characteristic & removed reference --- io.catenax.notifications/1.0.0/Notifications.ttl | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/io.catenax.notifications/1.0.0/Notifications.ttl b/io.catenax.notifications/1.0.0/Notifications.ttl index dc835f8d..ee21ba9b 100644 --- a/io.catenax.notifications/1.0.0/Notifications.ttl +++ b/io.catenax.notifications/1.0.0/Notifications.ttl @@ -23,7 +23,6 @@ @prefix rdfs: . @prefix xsd: . @prefix : . -@prefix ext-information: . @prefix ext-number: . @prefix ext-uuid: . @@ -90,12 +89,12 @@ :startDateOfEffect a samm:Property; samm:preferredName "Start date of the effect."@en; samm:description "Expected start date of the impact MUST be shared by the sender of the message.\n\nThis also covers cases where sending of the message and start of the impact differ from each other.\n\nThe value MUST be formatted according to the ISO 8601 standard."@en; - samm:characteristic ext-information:DateTimeStamp; + samm:characteristic :DateTimeStamp; samm:exampleValue "2023-12-13T15:00:00+01:00"^^xsd:dateTime. :expectedEndDateOfEffect a samm:Property; samm:preferredName "Expected end date of effect."@en; samm:description "Expected end date of the impact MAY be mentioned by the sender of the message.\n\nThe value MUST be formatted according to the ISO 8601 standard."@en; - samm:characteristic ext-information:DateTimeStamp; + samm:characteristic :DateTimeStamp; samm:exampleValue "2023-12-17T08:00:00+01:00"^^xsd:dateTime. :status a samm:Property; samm:preferredName "Status"@en; @@ -105,7 +104,7 @@ :contentChangedAt a samm:Property; samm:preferredName "Content changed at"@en; samm:description "The timestamp of the latest change of this notification."@en; - samm:characteristic ext-information:DateTimeStamp; + samm:characteristic :DateTimeStamp; samm:exampleValue "2023-12-13T15:00:00+01:00"^^xsd:dateTime. :relatedSourceMessageId a samm:Property; samm:preferredName "Related Source Message ID"@en; @@ -138,7 +137,7 @@ samm:preferredName "User Input Trait"@en; samm:description "Trait to ensure correct values for the user input."@en; samm-c:baseCharacteristic :UserInputCharacteristic; - samm-c:constraint :Constraint1. + samm-c:constraint :TextLengthConstraint. :MaterialNumberDigitalTwinCharacteristic a samm-c:Set; samm:preferredName "Material Number Digital Twin Characteristic"@en; samm:description "A set of Digital Twin material numbers."@en; @@ -166,7 +165,12 @@ samm:preferredName "User input characteristic"@en; samm:description "User input can be any string that is max. 4000 characters."@en; samm:dataType xsd:string. -:Constraint1 a samm-c:LengthConstraint; +:TextLengthConstraint a samm-c:LengthConstraint; samm:preferredName "UserInputConstraint"@en; samm:description "Constraint for a string to be max. 4000 characters long."@en; samm-c:maxValue "4000"^^xsd:nonNegativeInteger. +:DateTimeStamp a samm:Characteristic; + samm:preferredName "Date Time Stamp Characteristic"@en; + samm:description "The Date with the timezone."@en; + samm:dataType xsd:dateTime; + samm:see . From abfdbac801311fd765c7a88b7b385cdde9c0bc42 Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Thu, 1 Feb 2024 09:59:46 +0100 Subject: [PATCH 08/27] chore: migrated to samm 2.1.0 --- .../1.0.0/Notifications.ttl | 329 +++++++++--------- 1 file changed, 165 insertions(+), 164 deletions(-) diff --git a/io.catenax.notifications/1.0.0/Notifications.ttl b/io.catenax.notifications/1.0.0/Notifications.ttl index ee21ba9b..486c3405 100644 --- a/io.catenax.notifications/1.0.0/Notifications.ttl +++ b/io.catenax.notifications/1.0.0/Notifications.ttl @@ -1,9 +1,9 @@ ####################################################################### -# Copyright (c) 2023 ISTOS GmbH (a member of the DMG Mori Group) -# Copyright (c) 2023 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST) -# Copyright (c) 2023 TRUMPF Werkzeugmaschinen SE + Co. KG -# Copyright (c) 2023 Volkswagen AG -# Copyright (c) 2023 Contributors to the Eclipse Foundation +# Copyright (c) 2023-2024 ISTOS GmbH (a member of the DMG Mori Group) +# Copyright (c) 2023-2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST) +# Copyright (c) 2023-2024 TRUMPF Werkzeugmaschinen SE + Co. KG +# Copyright (c) 2023-2024 Volkswagen AG +# Copyright (c) 2023-2024 Contributors to the Eclipse Foundation # # See the NOTICE file(s) distributed with this work for additional # information regarding copyright ownership. @@ -15,162 +15,163 @@ # # 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-number: . -@prefix ext-uuid: . - -:Notifications a samm:Aspect; - samm:preferredName "Notifications"@en; - samm:description "This aspect model defines the standard for notification exchange between business partners. Notifications refer to specific events which affect production or demand."@en; - samm:properties ([ - samm:property :affectedSitesSender; - samm:optional "true"^^xsd:boolean -] [ - samm:property :affectedSitesRecipient; - samm:optional "true"^^xsd:boolean -] :leadingRootCause :effect [ - samm:property :text; - samm:optional "true"^^xsd:boolean -] [ - samm:property :materialNumberDigitalTwin; - samm:optional "true"^^xsd:boolean -] :startDateOfEffect [ - samm:property :expectedEndDateOfEffect; - samm:optional "true"^^xsd:boolean -] :status :contentChangedAt [ - samm:property :relatedSourceMessageId; - samm:optional "true"^^xsd:boolean -] [ - samm:property :materialNumberSupplier; - samm:optional "true"^^xsd:boolean -] [ - samm:property :materialNumberCustomer; - samm:optional "true"^^xsd:boolean -]); - samm:operations (); - samm:events (). -:affectedSitesSender a samm:Property; - samm:preferredName "Affected sites of the sender."@en; - samm:description "The affected Business Partner SITE Numbers of the sending party.\n\nThe value must be a valid BPNS. Applicable constraints are defined in the corresponding standard.\n\nIt is RECOMMENDED to sent the sender BPNS. It MUST be possible to select multiple sender BPNS."@en; - samm:characteristic :AffectedSitesCharacteristic; - samm:exampleValue "BPNS7588787849VQ". -:affectedSitesRecipient a samm:Property; - samm:preferredName "Affected sites of the recipient"@en; - samm:description "The affected Business Partner SITE Numbers of the receiving party.\n\nThe value must be a valid BPNS. Applicable constraints are defined in the corresponding standard.\n\nIt is RECOMMENDED to send the receiver BPNS. It MUST be possible to select multiple receiver BPNS."@en; - samm:characteristic :AffectedSitesCharacteristic; - samm:exampleValue "BPNS6666787765VQ". -:leadingRootCause a samm:Property; - samm:preferredName "Leading root cause"@en; - samm:description "The main cause that has or may have an impact on the supply of goods."@en; - samm:characteristic :LeadingRootCauseEnumeration; - samm:exampleValue "strike". -:effect a samm:Property; - samm:preferredName "Effect"@en; - samm:description "Effect or impact on the supply of goods as a consequence of the leadingRootCause.\n\nFrom business perspective demand/capacity reduction are most relevant values in connection with above mentioned root causes. For technical completeness demand/capacity increase are also added to the value list."@en; - samm:characteristic :EffectEnumeration; - samm:exampleValue "capacity-reduction". -:text a samm:Property; - samm:preferredName "Text"@en; - samm:description "Free text description for notification (max. 4000 characters)."@en; - samm:characteristic :UserInputTrait; - samm:exampleValue "Capacity reduction due to ongoing strike.". -:materialNumberDigitalTwin a samm:Property; - samm:preferredName "Material number Digital Twin"@en; - samm:description "UUID (DT Network Identifier): Via DT (Digital Twin) UUID a receiver is able to identify the own affected material numbers, because the digital twin is common for the sender and the receiver. If a digital twin is available, it is RECOMMENDED only exchanging the DT material number."@en; - samm:characteristic :MaterialNumberDigitalTwinCharacteristic; - samm:exampleValue "f81d4fae-7dec-11d0-a765-00a0c91e6bf6". -:startDateOfEffect a samm:Property; - samm:preferredName "Start date of the effect."@en; - samm:description "Expected start date of the impact MUST be shared by the sender of the message.\n\nThis also covers cases where sending of the message and start of the impact differ from each other.\n\nThe value MUST be formatted according to the ISO 8601 standard."@en; - samm:characteristic :DateTimeStamp; - samm:exampleValue "2023-12-13T15:00:00+01:00"^^xsd:dateTime. -:expectedEndDateOfEffect a samm:Property; - samm:preferredName "Expected end date of effect."@en; - samm:description "Expected end date of the impact MAY be mentioned by the sender of the message.\n\nThe value MUST be formatted according to the ISO 8601 standard."@en; - samm:characteristic :DateTimeStamp; - samm:exampleValue "2023-12-17T08:00:00+01:00"^^xsd:dateTime. -:status a samm:Property; - samm:preferredName "Status"@en; - samm:description "Status \"open\" should be used in the context of an effect which remains active. Status \"resolved\" should be used to inform the other business that the effect of the initial notification stopped or has been resolved."@en; - samm:characteristic :StatusEnumeration; - samm:exampleValue "open". -:contentChangedAt a samm:Property; - samm:preferredName "Content changed at"@en; - samm:description "The timestamp of the latest change of this notification."@en; - samm:characteristic :DateTimeStamp; - samm:exampleValue "2023-12-13T15:00:00+01:00"^^xsd:dateTime. -:relatedSourceMessageId a samm:Property; - samm:preferredName "Related Source Message ID"@en; - samm:description "Unique ID identifying a source message somehow related to the current one.\n\nProposal: Unique ID identifying the source message that started the notification thread."@en; - samm:characteristic :UuidV4Trait. -:materialNumberSupplier a samm:Property; - samm:preferredName "Supplier Material Number"@en; - samm:description "Material identifier as assigned by the supplier. This material number identifies the material in the supplier's database.\n\nIf the supplier is the sender, sending supplier material number is RECOMMENDED. It MUST be possible to send multiple supplier material numbers."@en; - samm:characteristic :MaterialNumberCharacteristic. -:materialNumberCustomer a samm:Property; - samm:preferredName "Customer Material Number"@en; - samm:description "Material identifier as assigned by the customer. This material number identifies the material in the customer's database. For standard parts (e.g. screws) for which a customer does not have an own number, the material number supplier should be set in this field, too.\n\nIf the customer is the sender, it is RECOMMENDED to send the materialNumberCustomer. It MUST be possible to send multiple customer material numbers."@en; - samm:characteristic :MaterialNumberCharacteristic. -:AffectedSitesCharacteristic a samm-c:Set; - samm:preferredName "Affected Sites"@en; - samm:description "A set of sites that are affected by the mentioned leadingRootCause."@en; - samm:dataType xsd:string; - samm-c:elementCharacteristic :BPNSTrait. -:LeadingRootCauseEnumeration a samm-c:Enumeration; - samm:preferredName "Leading root cause enumeration."@en; - samm:description "Possible root causes."@en; - samm:dataType xsd:string; - samm-c:values ("strike" "natural-disaster" "production-incident" "pandemic-or-epidemic" "logistics-disruption" "war" "other"). -:EffectEnumeration a samm-c:Enumeration; - samm:preferredName "Effect enumeration"@en; - samm:description "Enumeration of possible effects due to the mentioned leadingRootCause."@en; - samm:dataType xsd:string; - samm-c:values ("demand-reduction" "demand-increase" "capacity-reduction" "capacity-increase"). -:UserInputTrait a samm-c:Trait; - samm:preferredName "User Input Trait"@en; - samm:description "Trait to ensure correct values for the user input."@en; - samm-c:baseCharacteristic :UserInputCharacteristic; - samm-c:constraint :TextLengthConstraint. -:MaterialNumberDigitalTwinCharacteristic a samm-c:Set; - samm:preferredName "Material Number Digital Twin Characteristic"@en; - samm:description "A set of Digital Twin material numbers."@en; - samm:dataType xsd:string; - samm-c:elementCharacteristic :UuidV4Trait. -:StatusEnumeration a samm-c:Enumeration; - samm:preferredName "Status enumeration."@en; - samm:description "Status can be either \"open\" or \"resolved\"."@en; - samm:dataType xsd:string; - samm-c:values ("resolved" "open"). -:UuidV4Trait a samm-c:Trait; - samm:preferredName "UUID v4 Trait"@en; - samm-c:baseCharacteristic ext-uuid:Uuidv4Characteristic; - samm-c:constraint ext-uuid:Uuidv4RegularExpression. -:MaterialNumberCharacteristic a samm-c:Set; - samm:preferredName "Material Number"@en; - samm:description "The material number is a multi-character string, usually assigned by an ERP system of the customer or the supplier."@en; - samm:dataType xsd:string. -:BPNSTrait a samm-c:Trait; - samm:preferredName "BPNS Trait"@en; - samm:description "Trait to ensure data format for BPNS."@en; - samm-c:baseCharacteristic ext-number:BpnsCharacteristic; - samm-c:constraint ext-number:BpnsRegularExpression. -:UserInputCharacteristic a samm:Characteristic; - samm:preferredName "User input characteristic"@en; - samm:description "User input can be any string that is max. 4000 characters."@en; - samm:dataType xsd:string. -:TextLengthConstraint a samm-c:LengthConstraint; - samm:preferredName "UserInputConstraint"@en; - samm:description "Constraint for a string to be max. 4000 characters long."@en; - samm-c:maxValue "4000"^^xsd:nonNegativeInteger. -:DateTimeStamp a samm:Characteristic; - samm:preferredName "Date Time Stamp Characteristic"@en; - samm:description "The Date with the timezone."@en; - samm:dataType xsd:dateTime; - samm:see . +@prefix samm: . +@prefix samm-c: . +@prefix samm-e: . +@prefix unit: . +@prefix rdf: . +@prefix rdfs: . +@prefix xsd: . +@prefix : . +@prefix ext-number: . +@prefix ext-uuid: . + +:Notifications a samm:Aspect ; + samm:preferredName "Notifications"@en ; + samm:description "This aspect model defines the standard for notification exchange between business partners. Notifications refer to specific events which affect production or demand."@en ; + samm:properties ( [ samm:property :affectedSitesSender; samm:optional true ] [ samm:property :affectedSitesRecipient; samm:optional true ] :leadingRootCause :effect [ samm:property :text; samm:optional true ] [ samm:property :materialNumberDigitalTwin; samm:optional true ] :startDateOfEffect [ samm:property :expectedEndDateOfEffect; samm:optional true ] :status :contentChangedAt [ samm:property :relatedSourceMessageId; samm:optional true ] [ samm:property :materialNumberSupplier; samm:optional true ] [ samm:property :materialNumberCustomer; samm:optional true ] ) ; + samm:operations ( ) ; + samm:events ( ) . + +:affectedSitesSender a samm:Property ; + samm:preferredName "Affected sites of the sender."@en ; + samm:description """The affected Business Partner SITE Numbers of the sending party. + +The value must be a valid BPNS. Applicable constraints are defined in the corresponding standard. + +It is RECOMMENDED to sent the sender BPNS. It MUST be possible to select multiple sender BPNS."""@en ; + samm:characteristic ext-number:BpnsTrait ; + samm:exampleValue "BPNS7588787849VQ" . + +:affectedSitesRecipient a samm:Property ; + samm:preferredName "Affected sites of the recipient"@en ; + samm:description """The affected Business Partner SITE Numbers of the receiving party. + +The value must be a valid BPNS. Applicable constraints are defined in the corresponding standard. + +It is RECOMMENDED to send the receiver BPNS. It MUST be possible to select multiple receiver BPNS."""@en ; + samm:characteristic ext-number:BpnsTrait ; + samm:exampleValue "BPNS6666787765VQ" . + +:leadingRootCause a samm:Property ; + samm:preferredName "Leading root cause"@en ; + samm:description "The main cause that has or may have an impact on the supply of goods."@en ; + samm:characteristic :LeadingRootCauseEnumeration ; + samm:exampleValue "strike" . + +:effect a samm:Property ; + samm:preferredName "Effect"@en ; + samm:description """Effect or impact on the supply of goods as a consequence of the leadingRootCause. + +From business perspective demand/capacity reduction are most relevant values in connection with above mentioned root causes. For technical completeness demand/capacity increase are also added to the value list."""@en ; + samm:characteristic :EffectEnumeration ; + samm:exampleValue "capacity-reduction" . + +:text a samm:Property ; + samm:preferredName "Text"@en ; + samm:description "Free text description for notification (max. 4000 characters)."@en ; + samm:characteristic :UserInputTrait ; + samm:exampleValue "Capacity reduction due to ongoing strike." . + +:materialNumberDigitalTwin a samm:Property ; + samm:preferredName "Material number Digital Twin"@en ; + samm:description "UUID (DT Network Identifier): Via DT (Digital Twin) UUID a receiver is able to identify the own affected material numbers, because the digital twin is common for the sender and the receiver. If a digital twin is available, it is RECOMMENDED only exchanging the DT material number."@en ; + samm:characteristic :MaterialNumberDigitalTwinCharacteristic ; + samm:exampleValue "f81d4fae-7dec-11d0-a765-00a0c91e6bf6" . + +:startDateOfEffect a samm:Property ; + samm:preferredName "Start date of the effect."@en ; + samm:description """Expected start date of the impact MUST be shared by the sender of the message. + +This also covers cases where sending of the message and start of the impact differ from each other. + +The value MUST be formatted according to the ISO 8601 standard."""@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2023-12-13T15:00:00+01:00"^^xsd:dateTime . + +:expectedEndDateOfEffect a samm:Property ; + samm:preferredName "Expected end date of effect."@en ; + samm:description """Expected end date of the impact MAY be mentioned by the sender of the message. + +The value MUST be formatted according to the ISO 8601 standard."""@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2023-12-17T08:00:00+01:00"^^xsd:dateTime . + +:status a samm:Property ; + samm:preferredName "Status"@en ; + samm:description "Status \"open\" should be used in the context of an effect which remains active. Status \"resolved\" should be used to inform the other business that the effect of the initial notification stopped or has been resolved."@en ; + samm:characteristic :StatusEnumeration ; + samm:exampleValue "open" . + +:contentChangedAt a samm:Property ; + samm:preferredName "Content changed at"@en ; + samm:description "The timestamp of the latest change of this notification."@en ; + samm:characteristic samm-c:Timestamp ; + samm:exampleValue "2023-12-13T15:00:00+01:00"^^xsd:dateTime . + +:relatedSourceMessageId a samm:Property ; + samm:preferredName "Related Source Message ID"@en ; + samm:description """Unique ID identifying a source message somehow related to the current one. + +Proposal: Unique ID identifying the source message that started the notification thread."""@en ; + samm:characteristic ext-uuid:UuidV4Trait . + +:materialNumberSupplier a samm:Property ; + samm:preferredName "Supplier Material Number"@en ; + samm:description """Material identifier as assigned by the supplier. This material number identifies the material in the supplier's database. + +If the supplier is the sender, sending supplier material number is RECOMMENDED. It MUST be possible to send multiple supplier material numbers."""@en ; + samm:characteristic :MaterialNumberCharacteristic . + +:materialNumberCustomer a samm:Property ; + samm:preferredName "Customer Material Number"@en ; + samm:description """Material identifier as assigned by the customer. This material number identifies the material in the customer's database. For standard parts (e.g. screws) for which a customer does not have an own number, the material number supplier should be set in this field, too. + +If the customer is the sender, it is RECOMMENDED to send the materialNumberCustomer. It MUST be possible to send multiple customer material numbers."""@en ; + samm:characteristic :MaterialNumberCharacteristic . + +:LeadingRootCauseEnumeration a samm-c:Enumeration ; + samm:preferredName "Leading root cause enumeration."@en ; + samm:description "Possible root causes."@en ; + samm:dataType xsd:string ; + samm-c:values ( "strike" "natural-disaster" "production-incident" "pandemic-or-epidemic" "logistics-disruption" "war" "other" ) . + +:EffectEnumeration a samm-c:Enumeration ; + samm:preferredName "Effect enumeration"@en ; + samm:description "Enumeration of possible effects due to the mentioned leadingRootCause."@en ; + samm:dataType xsd:string ; + samm-c:values ( "demand-reduction" "demand-increase" "capacity-reduction" "capacity-increase" ) . + +:UserInputTrait a samm-c:Trait ; + samm:preferredName "User Input Trait"@en ; + samm:description "Trait to ensure correct values for the user input."@en ; + samm-c:baseCharacteristic :UserInputCharacteristic ; + samm-c:constraint :TextLengthConstraint . + +:MaterialNumberDigitalTwinCharacteristic a samm-c:Set ; + samm:preferredName "Material Number Digital Twin Characteristic"@en ; + samm:description "A set of Digital Twin material numbers."@en ; + samm:dataType xsd:string ; + samm-c:elementCharacteristic ext-uuid:Uuidv4Characteristic . + +:StatusEnumeration a samm-c:Enumeration ; + samm:preferredName "Status enumeration."@en ; + samm:description "Status can be either \"open\" or \"resolved\"."@en ; + samm:dataType xsd:string ; + samm-c:values ( "resolved" "open" ) . + +:MaterialNumberCharacteristic a samm-c:Set ; + samm:preferredName "Material Number"@en ; + samm:description "The material number is a multi-character string, usually assigned by an ERP system of the customer or the supplier."@en ; + samm:dataType xsd:string . + +:UserInputCharacteristic a samm:Characteristic ; + samm:preferredName "User input characteristic"@en ; + samm:description "User input can be any string that is max. 4000 characters."@en ; + samm:dataType xsd:string . + +:TextLengthConstraint a samm-c:LengthConstraint ; + samm:preferredName "UserInputConstraint"@en ; + samm:description "Constraint for a string to be max. 4000 characters long."@en ; + samm-c:maxValue "4000"^^xsd:nonNegativeInteger . + From f6a63082eb670ba7a2384902b3b0cb433c49853e Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Thu, 1 Feb 2024 10:09:11 +0100 Subject: [PATCH 09/27] fix: namespace was wrong --- io.catenax.notifications/1.0.0/Notifications.ttl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/io.catenax.notifications/1.0.0/Notifications.ttl b/io.catenax.notifications/1.0.0/Notifications.ttl index 486c3405..f9b19611 100644 --- a/io.catenax.notifications/1.0.0/Notifications.ttl +++ b/io.catenax.notifications/1.0.0/Notifications.ttl @@ -22,7 +22,7 @@ @prefix rdf: . @prefix rdfs: . @prefix xsd: . -@prefix : . +@prefix : . @prefix ext-number: . @prefix ext-uuid: . From 95d668cad13d68d2b4c7a108fab5d408d0822971 Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Thu, 1 Feb 2024 11:02:23 +0100 Subject: [PATCH 10/27] feat: renamed to manufacturer/customerPartId --- .../1.0.0/Notifications.ttl | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/io.catenax.notifications/1.0.0/Notifications.ttl b/io.catenax.notifications/1.0.0/Notifications.ttl index f9b19611..2a6c36f1 100644 --- a/io.catenax.notifications/1.0.0/Notifications.ttl +++ b/io.catenax.notifications/1.0.0/Notifications.ttl @@ -29,7 +29,7 @@ :Notifications a samm:Aspect ; samm:preferredName "Notifications"@en ; samm:description "This aspect model defines the standard for notification exchange between business partners. Notifications refer to specific events which affect production or demand."@en ; - samm:properties ( [ samm:property :affectedSitesSender; samm:optional true ] [ samm:property :affectedSitesRecipient; samm:optional true ] :leadingRootCause :effect [ samm:property :text; samm:optional true ] [ samm:property :materialNumberDigitalTwin; samm:optional true ] :startDateOfEffect [ samm:property :expectedEndDateOfEffect; samm:optional true ] :status :contentChangedAt [ samm:property :relatedSourceMessageId; samm:optional true ] [ samm:property :materialNumberSupplier; samm:optional true ] [ samm:property :materialNumberCustomer; samm:optional true ] ) ; + samm:properties ( [ samm:property :affectedSitesSender; samm:optional true ] [ samm:property :affectedSitesRecipient; samm:optional true ] :leadingRootCause :effect [ samm:property :text; samm:optional true ] [ samm:property :materialNumberDigitalTwin; samm:optional true ] :startDateOfEffect [ samm:property :expectedEndDateOfEffect; samm:optional true ] :status :contentChangedAt [ samm:property :relatedSourceMessageId; samm:optional true ] [ samm:property :manufacturerPartId; samm:optional true ] [ samm:property :customerPartId; samm:optional true ] ) ; samm:operations ( ) ; samm:events ( ) . @@ -105,7 +105,7 @@ The value MUST be formatted according to the ISO 8601 standard."""@en ; :contentChangedAt a samm:Property ; samm:preferredName "Content changed at"@en ; - samm:description "The timestamp of the latest change of this notification."@en ; + samm:description "The timestamp of the latest change of this notification. Date and time are set according to a timezone."@en ; samm:characteristic samm-c:Timestamp ; samm:exampleValue "2023-12-13T15:00:00+01:00"^^xsd:dateTime . @@ -116,18 +116,18 @@ The value MUST be formatted according to the ISO 8601 standard."""@en ; Proposal: Unique ID identifying the source message that started the notification thread."""@en ; samm:characteristic ext-uuid:UuidV4Trait . -:materialNumberSupplier a samm:Property ; - samm:preferredName "Supplier Material Number"@en ; - samm:description """Material identifier as assigned by the supplier. This material number identifies the material in the supplier's database. +:manufacturerPartId a samm:Property ; + samm:preferredName "Manufacturer Part ID"@en ; + samm:description """Part identifier as assigned by the manufacturer. This property identifies the part in the manufacturer's database. -If the supplier is the sender, sending supplier material number is RECOMMENDED. It MUST be possible to send multiple supplier material numbers."""@en ; +If the manufacturer is the data provider, sending manufacturer part ID is RECOMMENDED."""@en ; samm:characteristic :MaterialNumberCharacteristic . -:materialNumberCustomer a samm:Property ; - samm:preferredName "Customer Material Number"@en ; - samm:description """Material identifier as assigned by the customer. This material number identifies the material in the customer's database. For standard parts (e.g. screws) for which a customer does not have an own number, the material number supplier should be set in this field, too. +:customerPartId a samm:Property ; + samm:preferredName "Customer Part ID"@en ; + samm:description """Part identifier as assigned by the customer. This property identifies the part in the customer's database. For standard parts (e.g. screws) for which a customer does not have an own ID, the manufacturerPartId supplier should be set in this field, too. -If the customer is the sender, it is RECOMMENDED to send the materialNumberCustomer. It MUST be possible to send multiple customer material numbers."""@en ; +If the customer is the data provider, it is RECOMMENDED to send the customerPartId."""@en ; samm:characteristic :MaterialNumberCharacteristic . :LeadingRootCauseEnumeration a samm-c:Enumeration ; @@ -162,7 +162,7 @@ If the customer is the sender, it is RECOMMENDED to send the materialNumberCusto :MaterialNumberCharacteristic a samm-c:Set ; samm:preferredName "Material Number"@en ; - samm:description "The material number is a multi-character string, usually assigned by an ERP system of the customer or the supplier."@en ; + samm:description "The material number is a multi-character string, usually assigned by an ERP system of the customer or the manufacturer."@en ; samm:dataType xsd:string . :UserInputCharacteristic a samm:Characteristic ; From 550d7458937ba800630931bdccf5e7f31eb74be8 Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Fri, 2 Feb 2024 08:38:27 +0100 Subject: [PATCH 11/27] chore: update bpn reference to 2.0.0 --- io.catenax.notifications/1.0.0/Notifications.ttl | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/io.catenax.notifications/1.0.0/Notifications.ttl b/io.catenax.notifications/1.0.0/Notifications.ttl index 2a6c36f1..94a8592e 100644 --- a/io.catenax.notifications/1.0.0/Notifications.ttl +++ b/io.catenax.notifications/1.0.0/Notifications.ttl @@ -23,7 +23,7 @@ @prefix rdfs: . @prefix xsd: . @prefix : . -@prefix ext-number: . +@prefix ext-number: . @prefix ext-uuid: . :Notifications a samm:Aspect ; @@ -40,8 +40,8 @@ The value must be a valid BPNS. Applicable constraints are defined in the corresponding standard. It is RECOMMENDED to sent the sender BPNS. It MUST be possible to select multiple sender BPNS."""@en ; - samm:characteristic ext-number:BpnsTrait ; - samm:exampleValue "BPNS7588787849VQ" . + samm:exampleValue "BPNS7588787849VQ" ; + samm:characteristic :AffectedSitesCharacteristic . :affectedSitesRecipient a samm:Property ; samm:preferredName "Affected sites of the recipient"@en ; @@ -50,7 +50,7 @@ It is RECOMMENDED to sent the sender BPNS. It MUST be possible to select multipl The value must be a valid BPNS. Applicable constraints are defined in the corresponding standard. It is RECOMMENDED to send the receiver BPNS. It MUST be possible to select multiple receiver BPNS."""@en ; - samm:characteristic ext-number:BpnsTrait ; + samm:characteristic :AffectedSitesCharacteristic ; samm:exampleValue "BPNS6666787765VQ" . :leadingRootCause a samm:Property ; @@ -130,6 +130,11 @@ If the manufacturer is the data provider, sending manufacturer part ID is RECOMM If the customer is the data provider, it is RECOMMENDED to send the customerPartId."""@en ; samm:characteristic :MaterialNumberCharacteristic . +:AffectedSitesCharacteristic a samm-c:Set ; + samm:preferredName "Affected Sites Characteristic"@en ; + samm:description "A list of BPNS that are affected."@en ; + samm-c:elementCharacteristic ext-number:BpnsTrait . + :LeadingRootCauseEnumeration a samm-c:Enumeration ; samm:preferredName "Leading root cause enumeration."@en ; samm:description "Possible root causes."@en ; From d28bb1749337cc200431831e8a6d562e4baf7eed Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Fri, 2 Feb 2024 08:53:40 +0100 Subject: [PATCH 12/27] chore: removed unnecessary spaces --- .../1.0.0/Notifications.ttl | 58 ++++++------------- 1 file changed, 19 insertions(+), 39 deletions(-) diff --git a/io.catenax.notifications/1.0.0/Notifications.ttl b/io.catenax.notifications/1.0.0/Notifications.ttl index 94a8592e..2573cd77 100644 --- a/io.catenax.notifications/1.0.0/Notifications.ttl +++ b/io.catenax.notifications/1.0.0/Notifications.ttl @@ -1,9 +1,9 @@ ####################################################################### -# Copyright (c) 2023-2024 ISTOS GmbH (a member of the DMG Mori Group) -# Copyright (c) 2023-2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST) -# Copyright (c) 2023-2024 TRUMPF Werkzeugmaschinen SE + Co. KG -# Copyright (c) 2023-2024 Volkswagen AG -# Copyright (c) 2023-2024 Contributors to the Eclipse Foundation +# Copyright (c) 2024 ISTOS GmbH (a member of the DMG Mori Group) +# Copyright (c) 2024 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. (represented by Fraunhofer ISST) +# Copyright (c) 2024 TRUMPF Werkzeugmaschinen SE + Co. KG +# Copyright (c) 2024 Volkswagen AG +# Copyright (c) 2024 Contributors to the Eclipse Foundation # # See the NOTICE file(s) distributed with this work for additional # information regarding copyright ownership. @@ -35,21 +35,13 @@ :affectedSitesSender a samm:Property ; samm:preferredName "Affected sites of the sender."@en ; - samm:description """The affected Business Partner SITE Numbers of the sending party. - -The value must be a valid BPNS. Applicable constraints are defined in the corresponding standard. - -It is RECOMMENDED to sent the sender BPNS. It MUST be possible to select multiple sender BPNS."""@en ; - samm:exampleValue "BPNS7588787849VQ" ; - samm:characteristic :AffectedSitesCharacteristic . + samm:description "The affected Business Partner SITE Numbers of the sending party. The value must be a valid BPNS. Applicable constraints are defined in the corresponding standard. It is RECOMMENDED to sent the sender BPNS. It MUST be possible to select multiple sender BPNS."@en ; + samm:characteristic :AffectedSitesCharacteristic ; + samm:exampleValue "BPNS7588787849VQ" . :affectedSitesRecipient a samm:Property ; samm:preferredName "Affected sites of the recipient"@en ; - samm:description """The affected Business Partner SITE Numbers of the receiving party. - -The value must be a valid BPNS. Applicable constraints are defined in the corresponding standard. - -It is RECOMMENDED to send the receiver BPNS. It MUST be possible to select multiple receiver BPNS."""@en ; + samm:description "The affected Business Partner SITE Numbers of the receiving party. The value must be a valid BPNS. Applicable constraints are defined in the corresponding standard. It is RECOMMENDED to send the receiver BPNS. It MUST be possible to select multiple receiver BPNS."@en ; samm:characteristic :AffectedSitesCharacteristic ; samm:exampleValue "BPNS6666787765VQ" . @@ -61,9 +53,7 @@ It is RECOMMENDED to send the receiver BPNS. It MUST be possible to select multi :effect a samm:Property ; samm:preferredName "Effect"@en ; - samm:description """Effect or impact on the supply of goods as a consequence of the leadingRootCause. - -From business perspective demand/capacity reduction are most relevant values in connection with above mentioned root causes. For technical completeness demand/capacity increase are also added to the value list."""@en ; + samm:description "Effect or impact on the supply of goods as a consequence of the leadingRootCause. From business perspective demand/capacity reduction are most relevant values in connection with above mentioned root causes. For technical completeness demand/capacity increase are also added to the value list."@en ; samm:characteristic :EffectEnumeration ; samm:exampleValue "capacity-reduction" . @@ -81,19 +71,13 @@ From business perspective demand/capacity reduction are most relevant values in :startDateOfEffect a samm:Property ; samm:preferredName "Start date of the effect."@en ; - samm:description """Expected start date of the impact MUST be shared by the sender of the message. - -This also covers cases where sending of the message and start of the impact differ from each other. - -The value MUST be formatted according to the ISO 8601 standard."""@en ; + samm:description "Expected start date of the impact MUST be shared by the sender of the message. This also covers cases where sending of the message and start of the impact differ from each other. The value MUST be formatted according to the ISO 8601 standard."@en ; samm:characteristic samm-c:Timestamp ; samm:exampleValue "2023-12-13T15:00:00+01:00"^^xsd:dateTime . :expectedEndDateOfEffect a samm:Property ; samm:preferredName "Expected end date of effect."@en ; - samm:description """Expected end date of the impact MAY be mentioned by the sender of the message. - -The value MUST be formatted according to the ISO 8601 standard."""@en ; + samm:description "Expected end date of the impact MAY be mentioned by the sender of the message. The value MUST be formatted according to the ISO 8601 standard."@en ; samm:characteristic samm-c:Timestamp ; samm:exampleValue "2023-12-17T08:00:00+01:00"^^xsd:dateTime . @@ -111,24 +95,20 @@ The value MUST be formatted according to the ISO 8601 standard."""@en ; :relatedSourceMessageId a samm:Property ; samm:preferredName "Related Source Message ID"@en ; - samm:description """Unique ID identifying a source message somehow related to the current one. - -Proposal: Unique ID identifying the source message that started the notification thread."""@en ; + samm:description "Unique ID identifying the source message that started the notification thread."@en ; samm:characteristic ext-uuid:UuidV4Trait . :manufacturerPartId a samm:Property ; samm:preferredName "Manufacturer Part ID"@en ; - samm:description """Part identifier as assigned by the manufacturer. This property identifies the part in the manufacturer's database. - -If the manufacturer is the data provider, sending manufacturer part ID is RECOMMENDED."""@en ; - samm:characteristic :MaterialNumberCharacteristic . + samm:description "Part identifier as assigned by the manufacturer. This property identifies the part in the manufacturer's database. If the manufacturer is the data provider, sending this property is RECOMMENDED."@en ; + samm:characteristic :MaterialNumberCharacteristic ; + samm:exampleValue "MNR-8101-ID146955.001" . :customerPartId a samm:Property ; samm:preferredName "Customer Part ID"@en ; - samm:description """Part identifier as assigned by the customer. This property identifies the part in the customer's database. For standard parts (e.g. screws) for which a customer does not have an own ID, the manufacturerPartId supplier should be set in this field, too. - -If the customer is the data provider, it is RECOMMENDED to send the customerPartId."""@en ; - samm:characteristic :MaterialNumberCharacteristic . + samm:description "Part identifier as assigned by the customer. This property identifies the part in the customer's database. For standard parts (e.g. screws) for which a customer does not have an own ID, the manufacturerPartId supplier should be set in this field, too. If the customer is the data provider, sending this property is RECOMMENDED."@en ; + samm:characteristic :MaterialNumberCharacteristic ; + samm:exampleValue "MNR-7307-AU340474.002" . :AffectedSitesCharacteristic a samm-c:Set ; samm:preferredName "Affected Sites Characteristic"@en ; From e92c926b055bca48a41683fe8ae0f4e938334e05 Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Fri, 2 Feb 2024 09:44:11 +0100 Subject: [PATCH 13/27] feat: added uuid type and example to materialNumberDigitalTwin --- io.catenax.notifications/1.0.0/Notifications.ttl | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/io.catenax.notifications/1.0.0/Notifications.ttl b/io.catenax.notifications/1.0.0/Notifications.ttl index 2573cd77..1983cd53 100644 --- a/io.catenax.notifications/1.0.0/Notifications.ttl +++ b/io.catenax.notifications/1.0.0/Notifications.ttl @@ -24,7 +24,7 @@ @prefix xsd: . @prefix : . @prefix ext-number: . -@prefix ext-uuid: . +@prefix ext-uuid: . :Notifications a samm:Aspect ; samm:preferredName "Notifications"@en ; @@ -96,7 +96,8 @@ :relatedSourceMessageId a samm:Property ; samm:preferredName "Related Source Message ID"@en ; samm:description "Unique ID identifying the source message that started the notification thread."@en ; - samm:characteristic ext-uuid:UuidV4Trait . + samm:characteristic ext-uuid:UuidV4Trait ; + samm:exampleValue "d8b6b4ca-ca9c-42d9-8a34-f62591a1c68a" . :manufacturerPartId a samm:Property ; samm:preferredName "Manufacturer Part ID"@en ; @@ -112,7 +113,7 @@ :AffectedSitesCharacteristic a samm-c:Set ; samm:preferredName "Affected Sites Characteristic"@en ; - samm:description "A list of BPNS that are affected."@en ; + samm:description "A set of BPNS that are affected."@en ; samm-c:elementCharacteristic ext-number:BpnsTrait . :LeadingRootCauseEnumeration a samm-c:Enumeration ; @@ -136,8 +137,7 @@ :MaterialNumberDigitalTwinCharacteristic a samm-c:Set ; samm:preferredName "Material Number Digital Twin Characteristic"@en ; samm:description "A set of Digital Twin material numbers."@en ; - samm:dataType xsd:string ; - samm-c:elementCharacteristic ext-uuid:Uuidv4Characteristic . + samm-c:elementCharacteristic ext-uuid:UuidV4Trait . :StatusEnumeration a samm-c:Enumeration ; samm:preferredName "Status enumeration."@en ; From 6d08736eb2002abbcd8facca2e385ebf6b6359ed Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Fri, 2 Feb 2024 09:46:02 +0100 Subject: [PATCH 14/27] feat: renamed a characteristic to PartIdsCharacteristic --- .../1.0.0/Notifications.ttl | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/io.catenax.notifications/1.0.0/Notifications.ttl b/io.catenax.notifications/1.0.0/Notifications.ttl index 1983cd53..b32c4803 100644 --- a/io.catenax.notifications/1.0.0/Notifications.ttl +++ b/io.catenax.notifications/1.0.0/Notifications.ttl @@ -29,7 +29,7 @@ :Notifications a samm:Aspect ; samm:preferredName "Notifications"@en ; samm:description "This aspect model defines the standard for notification exchange between business partners. Notifications refer to specific events which affect production or demand."@en ; - samm:properties ( [ samm:property :affectedSitesSender; samm:optional true ] [ samm:property :affectedSitesRecipient; samm:optional true ] :leadingRootCause :effect [ samm:property :text; samm:optional true ] [ samm:property :materialNumberDigitalTwin; samm:optional true ] :startDateOfEffect [ samm:property :expectedEndDateOfEffect; samm:optional true ] :status :contentChangedAt [ samm:property :relatedSourceMessageId; samm:optional true ] [ samm:property :manufacturerPartId; samm:optional true ] [ samm:property :customerPartId; samm:optional true ] ) ; + samm:properties ( [ samm:property :affectedSitesSender; samm:optional true ] [ samm:property :affectedSitesRecipient; samm:optional true ] :leadingRootCause :effect [ samm:property :text; samm:optional true ] [ samm:property :materialNumberDigitalTwin; samm:optional true ] :startDateOfEffect [ samm:property :expectedEndDateOfEffect; samm:optional true ] :status :contentChangedAt [ samm:property :relatedSourceMessageId; samm:optional true ] [ samm:property :manufacturerPartIds; samm:optional true ] [ samm:property :customerPartIds; samm:optional true ] ) ; samm:operations ( ) ; samm:events ( ) . @@ -99,16 +99,16 @@ samm:characteristic ext-uuid:UuidV4Trait ; samm:exampleValue "d8b6b4ca-ca9c-42d9-8a34-f62591a1c68a" . -:manufacturerPartId a samm:Property ; - samm:preferredName "Manufacturer Part ID"@en ; - samm:description "Part identifier as assigned by the manufacturer. This property identifies the part in the manufacturer's database. If the manufacturer is the data provider, sending this property is RECOMMENDED."@en ; - samm:characteristic :MaterialNumberCharacteristic ; +:manufacturerPartIds a samm:Property ; + samm:preferredName "Manufacturer Part IDs"@en ; + samm:description "Part identifiers as assigned by the manufacturer. This property identifies the parts in the manufacturer's database. If the manufacturer is the data provider, sending this property is RECOMMENDED."@en ; + samm:characteristic :PartIdsCharacteristic ; samm:exampleValue "MNR-8101-ID146955.001" . -:customerPartId a samm:Property ; - samm:preferredName "Customer Part ID"@en ; - samm:description "Part identifier as assigned by the customer. This property identifies the part in the customer's database. For standard parts (e.g. screws) for which a customer does not have an own ID, the manufacturerPartId supplier should be set in this field, too. If the customer is the data provider, sending this property is RECOMMENDED."@en ; - samm:characteristic :MaterialNumberCharacteristic ; +:customerPartIds a samm:Property ; + samm:preferredName "Customer Part IDs"@en ; + samm:description "Part identifiers as assigned by the customer. This property identifies the parts in the customer's database. For standard parts (e.g. screws) for which a customer does not have an own ID, the manufacturer part ID should be set in this field, too. If the customer is the data provider, sending this property is RECOMMENDED."@en ; + samm:characteristic :PartIdsCharacteristic ; samm:exampleValue "MNR-7307-AU340474.002" . :AffectedSitesCharacteristic a samm-c:Set ; @@ -145,9 +145,9 @@ samm:dataType xsd:string ; samm-c:values ( "resolved" "open" ) . -:MaterialNumberCharacteristic a samm-c:Set ; - samm:preferredName "Material Number"@en ; - samm:description "The material number is a multi-character string, usually assigned by an ERP system of the customer or the manufacturer."@en ; +:PartIdsCharacteristic a samm-c:Set ; + samm:preferredName "Part IDs Characteristic"@en ; + samm:description "The part ID is a multi-character string, usually assigned by an ERP system of the customer or the manufacturer."@en ; samm:dataType xsd:string . :UserInputCharacteristic a samm:Characteristic ; From 78a28e017db5577ccec400fd6b092e1f8a4d1fe1 Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Mon, 5 Feb 2024 16:30:23 +0100 Subject: [PATCH 15/27] chore: rename to DisruptionNotifications --- .../1.0.0/DisruptionNotifications.ttl | 14 +++++++------- .../1.0.0/metadata.json | 0 .../RELEASE_NOTES.md | 1 - 3 files changed, 7 insertions(+), 8 deletions(-) rename io.catenax.notifications/1.0.0/Notifications.ttl => io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl (92%) rename {io.catenax.notifications => io.catenax.disruption_notifications}/1.0.0/metadata.json (100%) rename {io.catenax.notifications => io.catenax.disruption_notifications}/RELEASE_NOTES.md (99%) diff --git a/io.catenax.notifications/1.0.0/Notifications.ttl b/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl similarity index 92% rename from io.catenax.notifications/1.0.0/Notifications.ttl rename to io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl index b32c4803..4a319fa4 100644 --- a/io.catenax.notifications/1.0.0/Notifications.ttl +++ b/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl @@ -22,14 +22,14 @@ @prefix rdf: . @prefix rdfs: . @prefix xsd: . -@prefix : . +@prefix : . @prefix ext-number: . @prefix ext-uuid: . -:Notifications a samm:Aspect ; - samm:preferredName "Notifications"@en ; - samm:description "This aspect model defines the standard for notification exchange between business partners. Notifications refer to specific events which affect production or demand."@en ; - samm:properties ( [ samm:property :affectedSitesSender; samm:optional true ] [ samm:property :affectedSitesRecipient; samm:optional true ] :leadingRootCause :effect [ samm:property :text; samm:optional true ] [ samm:property :materialNumberDigitalTwin; samm:optional true ] :startDateOfEffect [ samm:property :expectedEndDateOfEffect; samm:optional true ] :status :contentChangedAt [ samm:property :relatedSourceMessageId; samm:optional true ] [ samm:property :manufacturerPartIds; samm:optional true ] [ samm:property :customerPartIds; samm:optional true ] ) ; +:DisruptionNotifications a samm:Aspect ; + samm:preferredName "Disruption Notifications"@en ; + samm:description "This aspect model defines the standard for disruption notification exchange between business partners. Disruption Notifications refer to specific events which affect production or demand."@en ; + samm:properties ( [ samm:property :affectedSitesSender; samm:optional true ] [ samm:property :affectedSitesRecipient; samm:optional true ] :leadingRootCause :effect [ samm:property :text; samm:optional true ] [ samm:property :materialGlobalAssetId; samm:optional true ] :startDateOfEffect [ samm:property :expectedEndDateOfEffect; samm:optional true ] :status :contentChangedAt [ samm:property :relatedSourceMessageId; samm:optional true ] [ samm:property :manufacturerPartIds; samm:optional true ] [ samm:property :customerPartIds; samm:optional true ] ) ; samm:operations ( ) ; samm:events ( ) . @@ -63,8 +63,8 @@ samm:characteristic :UserInputTrait ; samm:exampleValue "Capacity reduction due to ongoing strike." . -:materialNumberDigitalTwin a samm:Property ; - samm:preferredName "Material number Digital Twin"@en ; +:materialGlobalAssetId a samm:Property ; + samm:preferredName "Material Number UUID of the Customer's Twin"@en ; samm:description "UUID (DT Network Identifier): Via DT (Digital Twin) UUID a receiver is able to identify the own affected material numbers, because the digital twin is common for the sender and the receiver. If a digital twin is available, it is RECOMMENDED only exchanging the DT material number."@en ; samm:characteristic :MaterialNumberDigitalTwinCharacteristic ; samm:exampleValue "f81d4fae-7dec-11d0-a765-00a0c91e6bf6" . diff --git a/io.catenax.notifications/1.0.0/metadata.json b/io.catenax.disruption_notifications/1.0.0/metadata.json similarity index 100% rename from io.catenax.notifications/1.0.0/metadata.json rename to io.catenax.disruption_notifications/1.0.0/metadata.json diff --git a/io.catenax.notifications/RELEASE_NOTES.md b/io.catenax.disruption_notifications/RELEASE_NOTES.md similarity index 99% rename from io.catenax.notifications/RELEASE_NOTES.md rename to io.catenax.disruption_notifications/RELEASE_NOTES.md index 054ad929..45670e67 100644 --- a/io.catenax.notifications/RELEASE_NOTES.md +++ b/io.catenax.disruption_notifications/RELEASE_NOTES.md @@ -4,4 +4,3 @@ All notable changes to this model will be documented in this file. ## [1.0.0] ### Added - initial model - From 31477451841b4c18d099a90997a3d46f094ff541 Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Mon, 5 Feb 2024 16:49:25 +0100 Subject: [PATCH 16/27] chore: renamed back to materialNumberSupplier/Customer --- .../1.0.0/DisruptionNotifications.ttl | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl b/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl index 4a319fa4..864c795a 100644 --- a/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl +++ b/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl @@ -29,7 +29,7 @@ :DisruptionNotifications a samm:Aspect ; samm:preferredName "Disruption Notifications"@en ; samm:description "This aspect model defines the standard for disruption notification exchange between business partners. Disruption Notifications refer to specific events which affect production or demand."@en ; - samm:properties ( [ samm:property :affectedSitesSender; samm:optional true ] [ samm:property :affectedSitesRecipient; samm:optional true ] :leadingRootCause :effect [ samm:property :text; samm:optional true ] [ samm:property :materialGlobalAssetId; samm:optional true ] :startDateOfEffect [ samm:property :expectedEndDateOfEffect; samm:optional true ] :status :contentChangedAt [ samm:property :relatedSourceMessageId; samm:optional true ] [ samm:property :manufacturerPartIds; samm:optional true ] [ samm:property :customerPartIds; samm:optional true ] ) ; + samm:properties ( [ samm:property :affectedSitesSender; samm:optional true ] [ samm:property :affectedSitesRecipient; samm:optional true ] :leadingRootCause :effect [ samm:property :text; samm:optional true ] [ samm:property :materialGlobalAssetId; samm:optional true ] :startDateOfEffect [ samm:property :expectedEndDateOfEffect; samm:optional true ] :status :contentChangedAt [ samm:property :relatedSourceMessageId; samm:optional true ] [ samm:property :materialNumberSupplier; samm:optional true ] [ samm:property :materialNumberCustomer; samm:optional true ] ) ; samm:operations ( ) ; samm:events ( ) . @@ -99,15 +99,15 @@ samm:characteristic ext-uuid:UuidV4Trait ; samm:exampleValue "d8b6b4ca-ca9c-42d9-8a34-f62591a1c68a" . -:manufacturerPartIds a samm:Property ; - samm:preferredName "Manufacturer Part IDs"@en ; - samm:description "Part identifiers as assigned by the manufacturer. This property identifies the parts in the manufacturer's database. If the manufacturer is the data provider, sending this property is RECOMMENDED."@en ; +:materialNumberSupplier a samm:Property ; + samm:preferredName "Material Number Supplier"@en ; + samm:description "Material identifiers as assigned by the supplier or manufacturer. This property identifies the material in the supplier's database. If the supplier is the data provider, sending this property is RECOMMENDED."@en ; samm:characteristic :PartIdsCharacteristic ; samm:exampleValue "MNR-8101-ID146955.001" . -:customerPartIds a samm:Property ; - samm:preferredName "Customer Part IDs"@en ; - samm:description "Part identifiers as assigned by the customer. This property identifies the parts in the customer's database. For standard parts (e.g. screws) for which a customer does not have an own ID, the manufacturer part ID should be set in this field, too. If the customer is the data provider, sending this property is RECOMMENDED."@en ; +:materialNumberCustomer a samm:Property ; + samm:preferredName "Material Number Customer"@en ; + samm:description "Material identifier as assigned by the customer. This property identifies the material in the customer's database. For standard materials (e.g. screws) for which a customer does not have an own ID, the manufacturer material ID should be set in this field, too. If the customer is the data provider, sending this property is RECOMMENDED."@en ; samm:characteristic :PartIdsCharacteristic ; samm:exampleValue "MNR-7307-AU340474.002" . From 061ee5167617c44bbf479b44a8259539afee07f3 Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Thu, 8 Feb 2024 10:07:06 +0100 Subject: [PATCH 17/27] feat: refined the descriptions --- .../1.0.0/DisruptionNotifications.ttl | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl b/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl index 864c795a..5e850b68 100644 --- a/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl +++ b/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl @@ -34,14 +34,14 @@ samm:events ( ) . :affectedSitesSender a samm:Property ; - samm:preferredName "Affected sites of the sender."@en ; - samm:description "The affected Business Partner SITE Numbers of the sending party. The value must be a valid BPNS. Applicable constraints are defined in the corresponding standard. It is RECOMMENDED to sent the sender BPNS. It MUST be possible to select multiple sender BPNS."@en ; + samm:preferredName "Affected sites of the sender"@en ; + samm:description "The affected Business Partner Site Numbers of the sender. It is RECOMMENDED to set this property."@en ; samm:characteristic :AffectedSitesCharacteristic ; samm:exampleValue "BPNS7588787849VQ" . :affectedSitesRecipient a samm:Property ; samm:preferredName "Affected sites of the recipient"@en ; - samm:description "The affected Business Partner SITE Numbers of the receiving party. The value must be a valid BPNS. Applicable constraints are defined in the corresponding standard. It is RECOMMENDED to send the receiver BPNS. It MUST be possible to select multiple receiver BPNS."@en ; + samm:description "The affected Business Partner Site Numbers of the receiver. It is RECOMMENDED to set this property."@en ; samm:characteristic :AffectedSitesCharacteristic ; samm:exampleValue "BPNS6666787765VQ" . @@ -53,7 +53,7 @@ :effect a samm:Property ; samm:preferredName "Effect"@en ; - samm:description "Effect or impact on the supply of goods as a consequence of the leadingRootCause. From business perspective demand/capacity reduction are most relevant values in connection with above mentioned root causes. For technical completeness demand/capacity increase are also added to the value list."@en ; + samm:description "Effect or impact on the supply of goods as a consequence mentioned in the leadingRootCause. From business perspective demand/capacity reduction are most relevant values in connection with mentioned root causes. For technical completeness demand/capacity increase are also added to the enumeration."@en ; samm:characteristic :EffectEnumeration ; samm:exampleValue "capacity-reduction" . @@ -65,19 +65,19 @@ :materialGlobalAssetId a samm:Property ; samm:preferredName "Material Number UUID of the Customer's Twin"@en ; - samm:description "UUID (DT Network Identifier): Via DT (Digital Twin) UUID a receiver is able to identify the own affected material numbers, because the digital twin is common for the sender and the receiver. If a digital twin is available, it is RECOMMENDED only exchanging the DT material number."@en ; + samm:description "Material identifier used uniquely within Catena-X to identify the Material that is affected by the mentioned leadingRootCause. If this number is available, it is RECOMMENDED to only exchange this material number and not materialNumberCustomer and materialNumberSupplier."@en ; samm:characteristic :MaterialNumberDigitalTwinCharacteristic ; samm:exampleValue "f81d4fae-7dec-11d0-a765-00a0c91e6bf6" . :startDateOfEffect a samm:Property ; samm:preferredName "Start date of the effect."@en ; - samm:description "Expected start date of the impact MUST be shared by the sender of the message. This also covers cases where sending of the message and start of the impact differ from each other. The value MUST be formatted according to the ISO 8601 standard."@en ; + samm:description "This property defines the start date and time of the effect regardless of the time the DisruptionNotification was sent."@en ; samm:characteristic samm-c:Timestamp ; samm:exampleValue "2023-12-13T15:00:00+01:00"^^xsd:dateTime . :expectedEndDateOfEffect a samm:Property ; samm:preferredName "Expected end date of effect."@en ; - samm:description "Expected end date of the impact MAY be mentioned by the sender of the message. The value MUST be formatted according to the ISO 8601 standard."@en ; + samm:description "Expected end date of the impact MAY be defined by the sender of the message."@en ; samm:characteristic samm-c:Timestamp ; samm:exampleValue "2023-12-17T08:00:00+01:00"^^xsd:dateTime . @@ -113,18 +113,18 @@ :AffectedSitesCharacteristic a samm-c:Set ; samm:preferredName "Affected Sites Characteristic"@en ; - samm:description "A set of BPNS that are affected."@en ; + samm:description "A set of Business Partner Number Sites (BPNS) that are affected."@en ; samm-c:elementCharacteristic ext-number:BpnsTrait . :LeadingRootCauseEnumeration a samm-c:Enumeration ; - samm:preferredName "Leading root cause enumeration."@en ; - samm:description "Possible root causes."@en ; + samm:preferredName "Leading root cause enumeration"@en ; + samm:description "Enumeration of the available leading root causes."@en ; samm:dataType xsd:string ; samm-c:values ( "strike" "natural-disaster" "production-incident" "pandemic-or-epidemic" "logistics-disruption" "war" "other" ) . :EffectEnumeration a samm-c:Enumeration ; samm:preferredName "Effect enumeration"@en ; - samm:description "Enumeration of possible effects due to the mentioned leadingRootCause."@en ; + samm:description "Enumeration of the available effects due to the mentioned leadingRootCause."@en ; samm:dataType xsd:string ; samm-c:values ( "demand-reduction" "demand-increase" "capacity-reduction" "capacity-increase" ) . From de78feb874e2c843b1ea36a5abb1c08c9f04a118 Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Thu, 8 Feb 2024 10:12:41 +0100 Subject: [PATCH 18/27] chore: renamed to MaterialNumberSet --- .../1.0.0/DisruptionNotifications.ttl | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl b/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl index 5e850b68..b7aedce2 100644 --- a/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl +++ b/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl @@ -102,13 +102,13 @@ :materialNumberSupplier a samm:Property ; samm:preferredName "Material Number Supplier"@en ; samm:description "Material identifiers as assigned by the supplier or manufacturer. This property identifies the material in the supplier's database. If the supplier is the data provider, sending this property is RECOMMENDED."@en ; - samm:characteristic :PartIdsCharacteristic ; + samm:characteristic :MaterialNumberSet ; samm:exampleValue "MNR-8101-ID146955.001" . :materialNumberCustomer a samm:Property ; samm:preferredName "Material Number Customer"@en ; samm:description "Material identifier as assigned by the customer. This property identifies the material in the customer's database. For standard materials (e.g. screws) for which a customer does not have an own ID, the manufacturer material ID should be set in this field, too. If the customer is the data provider, sending this property is RECOMMENDED."@en ; - samm:characteristic :PartIdsCharacteristic ; + samm:characteristic :MaterialNumberSet ; samm:exampleValue "MNR-7307-AU340474.002" . :AffectedSitesCharacteristic a samm-c:Set ; @@ -145,9 +145,9 @@ samm:dataType xsd:string ; samm-c:values ( "resolved" "open" ) . -:PartIdsCharacteristic a samm-c:Set ; - samm:preferredName "Part IDs Characteristic"@en ; - samm:description "The part ID is a multi-character string, usually assigned by an ERP system of the customer or the manufacturer."@en ; +:MaterialNumberSet a samm-c:Set ; + samm:preferredName "Material Number Set"@en ; + samm:description "The set of material numbers, usually a multi-character string assigned by an ERP system of the customer or the supplier."@en ; samm:dataType xsd:string . :UserInputCharacteristic a samm:Characteristic ; From d77d37173f1dd1fe59212493e2c9c4004e455b70 Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Thu, 8 Feb 2024 11:42:17 +0100 Subject: [PATCH 19/27] chore: rename receiver to recipient --- .../1.0.0/DisruptionNotifications.ttl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl b/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl index b7aedce2..9caddd02 100644 --- a/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl +++ b/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl @@ -41,7 +41,7 @@ :affectedSitesRecipient a samm:Property ; samm:preferredName "Affected sites of the recipient"@en ; - samm:description "The affected Business Partner Site Numbers of the receiver. It is RECOMMENDED to set this property."@en ; + samm:description "The affected Business Partner Site Numbers of the recipient. It is RECOMMENDED to set this property."@en ; samm:characteristic :AffectedSitesCharacteristic ; samm:exampleValue "BPNS6666787765VQ" . From 9ca51b2ea67e334bf791f83e91f6847c3caa13a9 Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Thu, 8 Feb 2024 11:43:12 +0100 Subject: [PATCH 20/27] chore: added date for 1.0.0 release in RELEASE_NOTES.md --- io.catenax.disruption_notifications/RELEASE_NOTES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/io.catenax.disruption_notifications/RELEASE_NOTES.md b/io.catenax.disruption_notifications/RELEASE_NOTES.md index 45670e67..8c2841ce 100644 --- a/io.catenax.disruption_notifications/RELEASE_NOTES.md +++ b/io.catenax.disruption_notifications/RELEASE_NOTES.md @@ -1,6 +1,6 @@ # Changelog All notable changes to this model will be documented in this file. -## [1.0.0] +## [1.0.0] - 2024-02-12 ### Added - initial model From b22438f120a43c548bab1ecc2b2cbde72be05193 Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Thu, 8 Feb 2024 17:07:45 +0100 Subject: [PATCH 21/27] feat: specified the sender and recipient --- .../1.0.0/DisruptionNotifications.ttl | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl b/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl index 9caddd02..6499b4fe 100644 --- a/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl +++ b/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl @@ -35,13 +35,13 @@ :affectedSitesSender a samm:Property ; samm:preferredName "Affected sites of the sender"@en ; - samm:description "The affected Business Partner Site Numbers of the sender. It is RECOMMENDED to set this property."@en ; + samm:description "The affected Business Partner Site Numbers of the sender of the notification. It is RECOMMENDED to set this property."@en ; samm:characteristic :AffectedSitesCharacteristic ; samm:exampleValue "BPNS7588787849VQ" . :affectedSitesRecipient a samm:Property ; samm:preferredName "Affected sites of the recipient"@en ; - samm:description "The affected Business Partner Site Numbers of the recipient. It is RECOMMENDED to set this property."@en ; + samm:description "The affected Business Partner Site Numbers of the recipient of the notification. It is RECOMMENDED to set this property."@en ; samm:characteristic :AffectedSitesCharacteristic ; samm:exampleValue "BPNS6666787765VQ" . @@ -77,7 +77,7 @@ :expectedEndDateOfEffect a samm:Property ; samm:preferredName "Expected end date of effect."@en ; - samm:description "Expected end date of the impact MAY be defined by the sender of the message."@en ; + samm:description "Expected end date of the impact MAY be defined by the sender of the notification."@en ; samm:characteristic samm-c:Timestamp ; samm:exampleValue "2023-12-17T08:00:00+01:00"^^xsd:dateTime . From 67d40ccbf5601862d14ad9dda677920f10491941 Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Mon, 12 Feb 2024 16:29:36 +0100 Subject: [PATCH 22/27] feat(DisruptionNotifications): adjusted property affectedSitesRecipient --- .../1.0.0/DisruptionNotifications.ttl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl b/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl index 6499b4fe..690181c3 100644 --- a/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl +++ b/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl @@ -41,7 +41,7 @@ :affectedSitesRecipient a samm:Property ; samm:preferredName "Affected sites of the recipient"@en ; - samm:description "The affected Business Partner Site Numbers of the recipient of the notification. It is RECOMMENDED to set this property."@en ; + samm:description "The affected Business Partner Site Numbers of the recipient of the notification. It is RECOMMENDED to set this property. It MUST NOT contain any BPNS that doesn't belong to the receiver."@en ; samm:characteristic :AffectedSitesCharacteristic ; samm:exampleValue "BPNS6666787765VQ" . From 44123fae76e2afedef524378e3f5a4280b695b98 Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Thu, 15 Feb 2024 17:09:45 +0100 Subject: [PATCH 23/27] chore: rename DisruptionNotifications to DemandAndCapacityNotification --- .../1.0.0/DemandAndCapacityNotification.ttl | 4 ++-- .../1.0.0/metadata.json | 0 .../RELEASE_NOTES.md | 0 3 files changed, 2 insertions(+), 2 deletions(-) rename io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl => io.catenax.demand_and_capacity_notification/1.0.0/DemandAndCapacityNotification.ttl (98%) rename {io.catenax.disruption_notifications => io.catenax.demand_and_capacity_notification}/1.0.0/metadata.json (100%) rename {io.catenax.disruption_notifications => io.catenax.demand_and_capacity_notification}/RELEASE_NOTES.md (100%) diff --git a/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl b/io.catenax.demand_and_capacity_notification/1.0.0/DemandAndCapacityNotification.ttl similarity index 98% rename from io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl rename to io.catenax.demand_and_capacity_notification/1.0.0/DemandAndCapacityNotification.ttl index 690181c3..68d6e539 100644 --- a/io.catenax.disruption_notifications/1.0.0/DisruptionNotifications.ttl +++ b/io.catenax.demand_and_capacity_notification/1.0.0/DemandAndCapacityNotification.ttl @@ -22,11 +22,11 @@ @prefix rdf: . @prefix rdfs: . @prefix xsd: . -@prefix : . +@prefix : . @prefix ext-number: . @prefix ext-uuid: . -:DisruptionNotifications a samm:Aspect ; +:DemandAndCapacityNotification a samm:Aspect ; samm:preferredName "Disruption Notifications"@en ; samm:description "This aspect model defines the standard for disruption notification exchange between business partners. Disruption Notifications refer to specific events which affect production or demand."@en ; samm:properties ( [ samm:property :affectedSitesSender; samm:optional true ] [ samm:property :affectedSitesRecipient; samm:optional true ] :leadingRootCause :effect [ samm:property :text; samm:optional true ] [ samm:property :materialGlobalAssetId; samm:optional true ] :startDateOfEffect [ samm:property :expectedEndDateOfEffect; samm:optional true ] :status :contentChangedAt [ samm:property :relatedSourceMessageId; samm:optional true ] [ samm:property :materialNumberSupplier; samm:optional true ] [ samm:property :materialNumberCustomer; samm:optional true ] ) ; diff --git a/io.catenax.disruption_notifications/1.0.0/metadata.json b/io.catenax.demand_and_capacity_notification/1.0.0/metadata.json similarity index 100% rename from io.catenax.disruption_notifications/1.0.0/metadata.json rename to io.catenax.demand_and_capacity_notification/1.0.0/metadata.json diff --git a/io.catenax.disruption_notifications/RELEASE_NOTES.md b/io.catenax.demand_and_capacity_notification/RELEASE_NOTES.md similarity index 100% rename from io.catenax.disruption_notifications/RELEASE_NOTES.md rename to io.catenax.demand_and_capacity_notification/RELEASE_NOTES.md From a537ad492a834249bc7ebe5e7da5197935493bbf Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Thu, 15 Feb 2024 17:22:34 +0100 Subject: [PATCH 24/27] chore: adapt property descriptions to the new name --- .../1.0.0/DemandAndCapacityNotification.ttl | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/io.catenax.demand_and_capacity_notification/1.0.0/DemandAndCapacityNotification.ttl b/io.catenax.demand_and_capacity_notification/1.0.0/DemandAndCapacityNotification.ttl index 68d6e539..d4314a6a 100644 --- a/io.catenax.demand_and_capacity_notification/1.0.0/DemandAndCapacityNotification.ttl +++ b/io.catenax.demand_and_capacity_notification/1.0.0/DemandAndCapacityNotification.ttl @@ -27,8 +27,8 @@ @prefix ext-uuid: . :DemandAndCapacityNotification a samm:Aspect ; - samm:preferredName "Disruption Notifications"@en ; - samm:description "This aspect model defines the standard for disruption notification exchange between business partners. Disruption Notifications refer to specific events which affect production or demand."@en ; + samm:preferredName "Demand and Capacity Notification"@en ; + samm:description "This aspect model defines the standard for demand and capacity notification exchange between business partners. Demand and Capacity Notifications refer to specific events within the supply chain which affect production or demand."@en ; samm:properties ( [ samm:property :affectedSitesSender; samm:optional true ] [ samm:property :affectedSitesRecipient; samm:optional true ] :leadingRootCause :effect [ samm:property :text; samm:optional true ] [ samm:property :materialGlobalAssetId; samm:optional true ] :startDateOfEffect [ samm:property :expectedEndDateOfEffect; samm:optional true ] :status :contentChangedAt [ samm:property :relatedSourceMessageId; samm:optional true ] [ samm:property :materialNumberSupplier; samm:optional true ] [ samm:property :materialNumberCustomer; samm:optional true ] ) ; samm:operations ( ) ; samm:events ( ) . @@ -71,7 +71,7 @@ :startDateOfEffect a samm:Property ; samm:preferredName "Start date of the effect."@en ; - samm:description "This property defines the start date and time of the effect regardless of the time the DisruptionNotification was sent."@en ; + samm:description "This property defines the start date and time of the effect regardless of the time the notification was sent."@en ; samm:characteristic samm-c:Timestamp ; samm:exampleValue "2023-12-13T15:00:00+01:00"^^xsd:dateTime . @@ -83,7 +83,7 @@ :status a samm:Property ; samm:preferredName "Status"@en ; - samm:description "Status \"open\" should be used in the context of an effect which remains active. Status \"resolved\" should be used to inform the other business that the effect of the initial notification stopped or has been resolved."@en ; + samm:description "Status \"open\" should be used in the context of an effect which remains active. Status \"resolved\" should be used to inform the partner that the effect of the initial notification stopped or has been resolved."@en ; samm:characteristic :StatusEnumeration ; samm:exampleValue "open" . From c6ee8ac43aa1474eff09db9043c5f999d2390ad3 Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Thu, 15 Feb 2024 17:24:10 +0100 Subject: [PATCH 25/27] chore: change the release date --- io.catenax.demand_and_capacity_notification/RELEASE_NOTES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/io.catenax.demand_and_capacity_notification/RELEASE_NOTES.md b/io.catenax.demand_and_capacity_notification/RELEASE_NOTES.md index 8c2841ce..e198080d 100644 --- a/io.catenax.demand_and_capacity_notification/RELEASE_NOTES.md +++ b/io.catenax.demand_and_capacity_notification/RELEASE_NOTES.md @@ -1,6 +1,6 @@ # Changelog All notable changes to this model will be documented in this file. -## [1.0.0] - 2024-02-12 +## [1.0.0] - 2024-02-19 ### Added - initial model From 2b475e9ef0013506f9c7700eba932d22337d6153 Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Mon, 19 Feb 2024 15:35:22 +0100 Subject: [PATCH 26/27] chore: add "urn:uuid:" prefix to examples of uuid --- .../1.0.0/DemandAndCapacityNotification.ttl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/io.catenax.demand_and_capacity_notification/1.0.0/DemandAndCapacityNotification.ttl b/io.catenax.demand_and_capacity_notification/1.0.0/DemandAndCapacityNotification.ttl index d4314a6a..3f66cdd1 100644 --- a/io.catenax.demand_and_capacity_notification/1.0.0/DemandAndCapacityNotification.ttl +++ b/io.catenax.demand_and_capacity_notification/1.0.0/DemandAndCapacityNotification.ttl @@ -67,7 +67,7 @@ samm:preferredName "Material Number UUID of the Customer's Twin"@en ; samm:description "Material identifier used uniquely within Catena-X to identify the Material that is affected by the mentioned leadingRootCause. If this number is available, it is RECOMMENDED to only exchange this material number and not materialNumberCustomer and materialNumberSupplier."@en ; samm:characteristic :MaterialNumberDigitalTwinCharacteristic ; - samm:exampleValue "f81d4fae-7dec-11d0-a765-00a0c91e6bf6" . + samm:exampleValue "urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6" . :startDateOfEffect a samm:Property ; samm:preferredName "Start date of the effect."@en ; @@ -97,7 +97,7 @@ samm:preferredName "Related Source Message ID"@en ; samm:description "Unique ID identifying the source message that started the notification thread."@en ; samm:characteristic ext-uuid:UuidV4Trait ; - samm:exampleValue "d8b6b4ca-ca9c-42d9-8a34-f62591a1c68a" . + samm:exampleValue "urn:uuid:d8b6b4ca-ca9c-42d9-8a34-f62591a1c68a" . :materialNumberSupplier a samm:Property ; samm:preferredName "Material Number Supplier"@en ; From 91cc1f30bb82d1693efcd96aa9b55bfe159379bf Mon Sep 17 00:00:00 2001 From: Iwan Stoliar Date: Thu, 22 Feb 2024 16:14:55 +0100 Subject: [PATCH 27/27] chore: adapted material number definitions --- .../1.0.0/DemandAndCapacityNotification.ttl | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/io.catenax.demand_and_capacity_notification/1.0.0/DemandAndCapacityNotification.ttl b/io.catenax.demand_and_capacity_notification/1.0.0/DemandAndCapacityNotification.ttl index 3f66cdd1..5480102b 100644 --- a/io.catenax.demand_and_capacity_notification/1.0.0/DemandAndCapacityNotification.ttl +++ b/io.catenax.demand_and_capacity_notification/1.0.0/DemandAndCapacityNotification.ttl @@ -63,11 +63,11 @@ samm:characteristic :UserInputTrait ; samm:exampleValue "Capacity reduction due to ongoing strike." . -:materialGlobalAssetId a samm:Property ; - samm:preferredName "Material Number UUID of the Customer's Twin"@en ; - samm:description "Material identifier used uniquely within Catena-X to identify the Material that is affected by the mentioned leadingRootCause. If this number is available, it is RECOMMENDED to only exchange this material number and not materialNumberCustomer and materialNumberSupplier."@en ; - samm:characteristic :MaterialNumberDigitalTwinCharacteristic ; - samm:exampleValue "urn:uuid:f81d4fae-7dec-11d0-a765-00a0c91e6bf6" . +:materialGlobalAssetId a samm:Property; + samm:preferredName "UUID of the Part Type Twin"@en; + samm:description "Identifier used uniquely to identify part type twin."@en; + samm:characteristic :MaterialNumberDigitalTwinCharacteristic ; + samm:exampleValue "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df" . :startDateOfEffect a samm:Property ; samm:preferredName "Start date of the effect."@en ; @@ -103,13 +103,15 @@ samm:preferredName "Material Number Supplier"@en ; samm:description "Material identifiers as assigned by the supplier or manufacturer. This property identifies the material in the supplier's database. If the supplier is the data provider, sending this property is RECOMMENDED."@en ; samm:characteristic :MaterialNumberSet ; - samm:exampleValue "MNR-8101-ID146955.001" . + samm:exampleValue "MNR-8101-ID146955.001" ; + samm:see . :materialNumberCustomer a samm:Property ; samm:preferredName "Material Number Customer"@en ; samm:description "Material identifier as assigned by the customer. This property identifies the material in the customer's database. For standard materials (e.g. screws) for which a customer does not have an own ID, the manufacturer material ID should be set in this field, too. If the customer is the data provider, sending this property is RECOMMENDED."@en ; samm:characteristic :MaterialNumberSet ; - samm:exampleValue "MNR-7307-AU340474.002" . + samm:exampleValue "MNR-7307-AU340474.002" ; + samm:see . :AffectedSitesCharacteristic a samm-c:Set ; samm:preferredName "Affected Sites Characteristic"@en ;