From 1af4ef6a85132d7bd9df39c94c91bc31a2d638c6 Mon Sep 17 00:00:00 2001 From: --show-origin Date: Mon, 21 Aug 2023 07:10:41 -0700 Subject: [PATCH 01/21] feat: initial structure based on product stock --- .../1.0.0/PlannedProduction.ttl | 218 ++++++++++++++++++ .../1.0.0/metadata.json | 1 + .../RELEASE_NOTES.md | 7 + 3 files changed, 226 insertions(+) create mode 100644 io.catenax.planned_production/1.0.0/PlannedProduction.ttl create mode 100644 io.catenax.planned_production/1.0.0/metadata.json create mode 100644 io.catenax.planned_production/RELEASE_NOTES.md diff --git a/io.catenax.planned_production/1.0.0/PlannedProduction.ttl b/io.catenax.planned_production/1.0.0/PlannedProduction.ttl new file mode 100644 index 000000000..7808d8e94 --- /dev/null +++ b/io.catenax.planned_production/1.0.0/PlannedProduction.ttl @@ -0,0 +1,218 @@ +####################################################################### +# 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 bamm: . +@prefix bamm-c: . +@prefix bamm-e: . +@prefix unit: . +@prefix rdf: . +@prefix rdfs: . +@prefix xsd: . +@prefix : . + +:PlannedProduction a bamm:Aspect; + bamm:properties (:positions :materialNumberCustomer [ + bamm:property :materialNumberCatenaX; + bamm:optional "true"^^xsd:boolean +] [ + bamm:property :materialNumberSupplier; + bamm:optional "true"^^xsd:boolean +]); + bamm:operations (); + bamm:events (); + bamm:preferredName "Stock of Products of a Supplier"@en; + bamm:description "This aspect represents the latest quantities of a supplier's products that are on stock. The stock represent the build-to-order (BTO) stocks already available for the customer.\n"@en. +:positions a bamm:Property; + bamm:preferredName "Positions"@en; + bamm:description "The positions refer to positions within an order that refer to the given product (see materialNumberSupplier, materialNumberCustomer and materialNumberDataSpace) for which the stocks are transferred. The positions are differentiated by the orderPositionReference."@en; + bamm:characteristic :PositionsCollection. +:materialNumberCustomer a bamm:Property; + bamm:preferredName "Customer Material Number"@en; + bamm:description "Material identifier as assigned by customer. This material number identifies the material (as planned) in customer's database. For standard parts (e.g. screws) for which a customer does not have an own number, the materialNumberSupplier should be set in this field, too."@en; + bamm:characteristic :MaterialNumber; + bamm:exampleValue "MNR-7307-AU340474.002". +:materialNumberCatenaX a bamm:Property; + bamm:preferredName "Material UUID Used in Catena-X"@en; + bamm:description "Material identifier used uniquely within Catena-X to identify the Material (e.g. PartAsPlanned)."@en; + bamm:characteristic :CatenaXIdTraitCharacteristic; + bamm:exampleValue "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df". +:PositionsCollection a bamm-c:Collection; + bamm:preferredName "Positions Collection"@en; + bamm:description "If any stock is available, then there is at least one position. If the supplier does differentiate the stock according to the order positions (an OrderPositionReference is set), then multiple positions can be given. There could also be only one position without an OrderPositionReference indicating an anonymous stock which is allocated to the customer."@en; + bamm:dataType :Position. +:Position a bamm:Entity; + bamm:properties ([ + bamm:property :orderPositionReference; + bamm:optional "true"^^xsd:boolean +] :lastUpdatedOnDateTime :allocatedStocks); + bamm:preferredName "Position"@en; + bamm:description "The Position can be located at several stocks. A position may be anonymous or may reference an position within an order."@en. +:orderPositionReference a bamm:Property; + bamm:preferredName "Order Position Reference"@en; + bamm:description "The order position reference contains information to identify a position within an order."@en; + bamm:characteristic :OrderPositionReferenceCharacteristic. +:lastUpdatedOnDateTime a bamm:Property; + bamm:preferredName "Lasted Updated on Date"@en; + bamm:description "Date and time at which the position has been updated by the supplier's systems. Date and time are set according to a timezone."@en; + bamm:characteristic :DateTimeStamp; + bamm:exampleValue "2023-04-01T14:23:00"^^xsd:date. +:allocatedStocks a bamm:Property; + bamm:preferredName "Allocated Stocks"@en; + bamm:description "Stocks already allocated to the customer. There is one AllocatedStock per supplierStockLocation."@en; + bamm:characteristic :AllocatedStockCollection. +:OrderPositionReferenceCharacteristic a bamm:Characteristic; + bamm:preferredName "Order Position Reference Characteristic"@en; + bamm:description "The order position reference includes reference numbers for the order and the ID. As these information are meant for the customer, the customer reference numbers are mandatory."@en; + bamm:dataType :OrderPositionReference. +:DateTimeStamp a bamm:Characteristic; + bamm:preferredName "Date Time Stamp Characteristic"@en; + bamm:description "The Date with the the timezone of the involved site."@en; + bamm:dataType xsd:date; + bamm:see . +:AllocatedStockCollection a bamm-c:Collection; + bamm:preferredName "Allocated Stock Collection"@en; + bamm:description "Collection of AllocatedStocks that may relate to different supplierStockLocations."@en; + bamm:dataType :AllocatedStock. +:OrderPositionReference a bamm:Entity; + bamm:properties ([ + bamm:property :supplierOrderId; + bamm:optional "true"^^xsd:boolean +] :customerOrderId :customerOrderPositionId); + bamm:preferredName "Reference to Order Position"@en; + bamm:description "Encapsulates the references to identify a position within an order."@en. +:AllocatedStock a bamm:Entity; + bamm:properties (:quantityOnAllocatedStock :supplierStockLocationId); + bamm:preferredName "Stock Allocated to Customer"@en; + bamm:description "This is the quantity of already produced goods at a given location that has not yet been shipped. The allocated stock is the stock available for the customer and may refer to a given position (see OrderPositionReference). Quantities of Materials belonging to this stock are not available for other positions or customers. This stock consists only of the good parts."@en. +:supplierOrderId a bamm:Property; + bamm:preferredName "Supplier Order ID"@en; + bamm:description "This is the order number on the supplier side that is given by e.g., the supplier's enterprise resource planning system."@en; + bamm:characteristic :OrderIdCharacteristic; + bamm:exampleValue "M-Nbr-4711". +:customerOrderId a bamm:Property; + bamm:preferredName "Customer Order ID"@en; + bamm:description "This is the order number on the customer side that can be given by e.g., the customer's enterprise resource planning system."@en; + bamm:characteristic :OrderIdCharacteristic; + bamm:exampleValue "C-Nbr-4711". +:customerOrderPositionId a bamm:Property; + bamm:preferredName "Customer Order Position ID"@en; + bamm:description "This is an identifier for the position of an order defined by the customer. It's not a technical identifier, such as an UUID. This identifier is used within the business context when talking about the position."@en; + bamm:characteristic :OrderPositionIdCharacteristic; + bamm:exampleValue "PositionId-01". +:quantityOnAllocatedStock a bamm:Property; + bamm:preferredName "Quantity on Allocated Stock"@en; + bamm:description "This is the quantity of the material within the position that is already ready to be delivered."@en; + bamm:characteristic :QuantityCharacteristic. +:supplierStockLocationId a bamm:Property; + bamm:preferredName "Location ID of Supplier's Stock"@en; + bamm:description "One stock has always one location. The location is identified using BPNs. The location can be identified differently depending on the partner."@en; + bamm:characteristic :SupplierStockLocationIDCharacteristic; + bamm:see . +:OrderIdCharacteristic a bamm:Characteristic; + bamm:preferredName "Order ID Characteristic"@en; + bamm:description "This is a proprietary order ID, generated by either the supplier side or customer side."@en; + bamm:dataType xsd:string. +:OrderPositionIdCharacteristic a bamm:Characteristic; + bamm:preferredName "Position ID within Order"@en; + bamm:description "The position ID is unique for an order and used within business context to refer to a position."@en; + bamm:dataType xsd:string. +:SupplierStockLocationIDCharacteristic a bamm:Characteristic; + bamm:preferredName "Location ID Characteristic of Supplier's Stock"@en; + bamm:description "This is the location where the stock is located."@en; + bamm:dataType :LocationId. +:LocationId a bamm:Entity; + bamm:properties (:locationIdType :locationId); + bamm:preferredName "Location ID"@en; + bamm:description "A location can be described by different kinds of identifiers. Within Catena-X, a location can either be described by a BPNS or BPNA."@en. +:locationIdType a bamm:Property; + bamm:preferredName "Type of Location ID"@en; + bamm:description "Type of the location's ID."@en; + bamm:characteristic :LocationIdTypeEnum; + bamm:exampleValue "BPNS". +:locationId a bamm:Property; + bamm:preferredName "Location ID"@en; + bamm:description "The actual ID reflecting the type (locationIdType) of the location."@en; + bamm:characteristic :LocationIdCharacteristic; + bamm:exampleValue "BPNS0123456789ZZ". +:LocationIdTypeEnum a bamm-c:Enumeration; + bamm:preferredName "Location ID Type Enum"@en; + bamm:description "Enumeration specifying types of keys for locations within Catena-X."@en; + bamm:dataType xsd:string; + bamm:see ; + bamm-c:values ("BPNS" "BPNA"). +:LocationIdCharacteristic a bamm:Characteristic; + bamm:preferredName "Location ID Characteristic"@en; + bamm:description "The actual key based on the type."@en; + bamm:dataType xsd:string; + bamm:see . + +:QuantityCharacteristic a bamm-c:Quantifiable; + bamm:preferredName "Quantity Characteristic"@en; + bamm:description "Describes the quantity in which the child part is assembled in the given parent object by providing a quantity value and the measurement unit in which the quantity is measured."@en; + bamm:dataType :Quantity. + +:Quantity a bamm:Entity; + bamm:preferredName "Quantity"@en; + bamm:description "Comprises the number of objects and the unit of measurement for the respective child objects"@en; + bamm:properties (:quantityNumber :measurementUnit). + +:quantityNumber a bamm:Property; + bamm:preferredName "Quantity Number"@en; + bamm:description "The number of objects related to the measurement unit"@en; + bamm:characteristic :NumberofObjects; + bamm:exampleValue "2.5"^^xsd:double. + +:measurementUnit a bamm:Property; + bamm:preferredName "Measurement Unit"@en; + bamm:description "Unit of measurement for the quantity of objects.\nIf possible, use units from the aspect meta model unit catalog, which is based on the UNECE Recommendation No. 20 \"Codes for Units of Measure used in International Trade\"."@en; + bamm:characteristic bamm-c:UnitReference; + bamm:exampleValue "unit:litre"^^bamm:curie; + bamm:see . + +:NumberofObjects a bamm:Characteristic; + bamm:preferredName "Number of Objects"@en; + bamm:description "Quantifiable number of objects in reference to the measurementUnit"@en; + bamm:dataType xsd:double. + +:materialNumberSupplier a bamm:Property; + bamm:preferredName "Supplier Material Number"@en; + bamm:description "Material identifier as assigned by supplier. This material number identifies the material (as planned) in supplier's database."@en; + bamm:characteristic :MaterialNumber; + bamm:exampleValue "MNR-8101-ID146955.001". + +:MaterialNumber a bamm:Characteristic; + bamm:preferredName "Material Number"@en; + bamm:description "The material number is a multi-character string, usually assigned by an ERP system."@en; + bamm:dataType xsd:string. + +:CatenaXIdTraitCharacteristic a bamm-c:Trait; + bamm:preferredName "Catena-X ID Trait"@en; + bamm:description "Trait to ensure UUID v4 data format"@en; + bamm-c:baseCharacteristic :Uuidv4Characteristic; + bamm-c:constraint :Uuidv4RegularExpression. + +:Uuidv4Characteristic a bamm:Characteristic; + bamm:preferredName "UUID v4"@en; + bamm:description "A version 4 UUID is a universally unique identifier that is generated using random 32 hexadecimal characters."@en; + bamm:dataType xsd:string; + bamm:see . + +:Uuidv4RegularExpression a bamm-c:RegularExpressionConstraint; + bamm:preferredName "Catena-X ID Regular Expression"@en; + bamm:description "The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by \"urn:uuid:\" to make it an IRI."@en; + bamm:see ; + bamm:value "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)". diff --git a/io.catenax.planned_production/1.0.0/metadata.json b/io.catenax.planned_production/1.0.0/metadata.json new file mode 100644 index 000000000..e2a5a0225 --- /dev/null +++ b/io.catenax.planned_production/1.0.0/metadata.json @@ -0,0 +1 @@ +{ "status" : "draft"} diff --git a/io.catenax.planned_production/RELEASE_NOTES.md b/io.catenax.planned_production/RELEASE_NOTES.md new file mode 100644 index 000000000..5b6b26a56 --- /dev/null +++ b/io.catenax.planned_production/RELEASE_NOTES.md @@ -0,0 +1,7 @@ +# Changelog +All notable changes to this model will be documented in this file. + +## [Unreleased] +### Added +- initial model + From 68c692f87916b310ba06cf1d00f0d0dc4c6b6a35 Mon Sep 17 00:00:00 2001 From: --show-origin Date: Thu, 24 Aug 2023 06:18:25 -0700 Subject: [PATCH 02/21] feat: adjusted initial draft based on product stock --- .../1.0.0/PlannedProduction.ttl | 412 +++++++++--------- 1 file changed, 194 insertions(+), 218 deletions(-) diff --git a/io.catenax.planned_production/1.0.0/PlannedProduction.ttl b/io.catenax.planned_production/1.0.0/PlannedProduction.ttl index 7808d8e94..b7a32fc54 100644 --- a/io.catenax.planned_production/1.0.0/PlannedProduction.ttl +++ b/io.catenax.planned_production/1.0.0/PlannedProduction.ttl @@ -1,218 +1,194 @@ -####################################################################### -# 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 bamm: . -@prefix bamm-c: . -@prefix bamm-e: . -@prefix unit: . -@prefix rdf: . -@prefix rdfs: . -@prefix xsd: . -@prefix : . - -:PlannedProduction a bamm:Aspect; - bamm:properties (:positions :materialNumberCustomer [ - bamm:property :materialNumberCatenaX; - bamm:optional "true"^^xsd:boolean -] [ - bamm:property :materialNumberSupplier; - bamm:optional "true"^^xsd:boolean -]); - bamm:operations (); - bamm:events (); - bamm:preferredName "Stock of Products of a Supplier"@en; - bamm:description "This aspect represents the latest quantities of a supplier's products that are on stock. The stock represent the build-to-order (BTO) stocks already available for the customer.\n"@en. -:positions a bamm:Property; - bamm:preferredName "Positions"@en; - bamm:description "The positions refer to positions within an order that refer to the given product (see materialNumberSupplier, materialNumberCustomer and materialNumberDataSpace) for which the stocks are transferred. The positions are differentiated by the orderPositionReference."@en; - bamm:characteristic :PositionsCollection. -:materialNumberCustomer a bamm:Property; - bamm:preferredName "Customer Material Number"@en; - bamm:description "Material identifier as assigned by customer. This material number identifies the material (as planned) in customer's database. For standard parts (e.g. screws) for which a customer does not have an own number, the materialNumberSupplier should be set in this field, too."@en; - bamm:characteristic :MaterialNumber; - bamm:exampleValue "MNR-7307-AU340474.002". -:materialNumberCatenaX a bamm:Property; - bamm:preferredName "Material UUID Used in Catena-X"@en; - bamm:description "Material identifier used uniquely within Catena-X to identify the Material (e.g. PartAsPlanned)."@en; - bamm:characteristic :CatenaXIdTraitCharacteristic; - bamm:exampleValue "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df". -:PositionsCollection a bamm-c:Collection; - bamm:preferredName "Positions Collection"@en; - bamm:description "If any stock is available, then there is at least one position. If the supplier does differentiate the stock according to the order positions (an OrderPositionReference is set), then multiple positions can be given. There could also be only one position without an OrderPositionReference indicating an anonymous stock which is allocated to the customer."@en; - bamm:dataType :Position. -:Position a bamm:Entity; - bamm:properties ([ - bamm:property :orderPositionReference; - bamm:optional "true"^^xsd:boolean -] :lastUpdatedOnDateTime :allocatedStocks); - bamm:preferredName "Position"@en; - bamm:description "The Position can be located at several stocks. A position may be anonymous or may reference an position within an order."@en. -:orderPositionReference a bamm:Property; - bamm:preferredName "Order Position Reference"@en; - bamm:description "The order position reference contains information to identify a position within an order."@en; - bamm:characteristic :OrderPositionReferenceCharacteristic. -:lastUpdatedOnDateTime a bamm:Property; - bamm:preferredName "Lasted Updated on Date"@en; - bamm:description "Date and time at which the position has been updated by the supplier's systems. Date and time are set according to a timezone."@en; - bamm:characteristic :DateTimeStamp; - bamm:exampleValue "2023-04-01T14:23:00"^^xsd:date. -:allocatedStocks a bamm:Property; - bamm:preferredName "Allocated Stocks"@en; - bamm:description "Stocks already allocated to the customer. There is one AllocatedStock per supplierStockLocation."@en; - bamm:characteristic :AllocatedStockCollection. -:OrderPositionReferenceCharacteristic a bamm:Characteristic; - bamm:preferredName "Order Position Reference Characteristic"@en; - bamm:description "The order position reference includes reference numbers for the order and the ID. As these information are meant for the customer, the customer reference numbers are mandatory."@en; - bamm:dataType :OrderPositionReference. -:DateTimeStamp a bamm:Characteristic; - bamm:preferredName "Date Time Stamp Characteristic"@en; - bamm:description "The Date with the the timezone of the involved site."@en; - bamm:dataType xsd:date; - bamm:see . -:AllocatedStockCollection a bamm-c:Collection; - bamm:preferredName "Allocated Stock Collection"@en; - bamm:description "Collection of AllocatedStocks that may relate to different supplierStockLocations."@en; - bamm:dataType :AllocatedStock. -:OrderPositionReference a bamm:Entity; - bamm:properties ([ - bamm:property :supplierOrderId; - bamm:optional "true"^^xsd:boolean -] :customerOrderId :customerOrderPositionId); - bamm:preferredName "Reference to Order Position"@en; - bamm:description "Encapsulates the references to identify a position within an order."@en. -:AllocatedStock a bamm:Entity; - bamm:properties (:quantityOnAllocatedStock :supplierStockLocationId); - bamm:preferredName "Stock Allocated to Customer"@en; - bamm:description "This is the quantity of already produced goods at a given location that has not yet been shipped. The allocated stock is the stock available for the customer and may refer to a given position (see OrderPositionReference). Quantities of Materials belonging to this stock are not available for other positions or customers. This stock consists only of the good parts."@en. -:supplierOrderId a bamm:Property; - bamm:preferredName "Supplier Order ID"@en; - bamm:description "This is the order number on the supplier side that is given by e.g., the supplier's enterprise resource planning system."@en; - bamm:characteristic :OrderIdCharacteristic; - bamm:exampleValue "M-Nbr-4711". -:customerOrderId a bamm:Property; - bamm:preferredName "Customer Order ID"@en; - bamm:description "This is the order number on the customer side that can be given by e.g., the customer's enterprise resource planning system."@en; - bamm:characteristic :OrderIdCharacteristic; - bamm:exampleValue "C-Nbr-4711". -:customerOrderPositionId a bamm:Property; - bamm:preferredName "Customer Order Position ID"@en; - bamm:description "This is an identifier for the position of an order defined by the customer. It's not a technical identifier, such as an UUID. This identifier is used within the business context when talking about the position."@en; - bamm:characteristic :OrderPositionIdCharacteristic; - bamm:exampleValue "PositionId-01". -:quantityOnAllocatedStock a bamm:Property; - bamm:preferredName "Quantity on Allocated Stock"@en; - bamm:description "This is the quantity of the material within the position that is already ready to be delivered."@en; - bamm:characteristic :QuantityCharacteristic. -:supplierStockLocationId a bamm:Property; - bamm:preferredName "Location ID of Supplier's Stock"@en; - bamm:description "One stock has always one location. The location is identified using BPNs. The location can be identified differently depending on the partner."@en; - bamm:characteristic :SupplierStockLocationIDCharacteristic; - bamm:see . -:OrderIdCharacteristic a bamm:Characteristic; - bamm:preferredName "Order ID Characteristic"@en; - bamm:description "This is a proprietary order ID, generated by either the supplier side or customer side."@en; - bamm:dataType xsd:string. -:OrderPositionIdCharacteristic a bamm:Characteristic; - bamm:preferredName "Position ID within Order"@en; - bamm:description "The position ID is unique for an order and used within business context to refer to a position."@en; - bamm:dataType xsd:string. -:SupplierStockLocationIDCharacteristic a bamm:Characteristic; - bamm:preferredName "Location ID Characteristic of Supplier's Stock"@en; - bamm:description "This is the location where the stock is located."@en; - bamm:dataType :LocationId. -:LocationId a bamm:Entity; - bamm:properties (:locationIdType :locationId); - bamm:preferredName "Location ID"@en; - bamm:description "A location can be described by different kinds of identifiers. Within Catena-X, a location can either be described by a BPNS or BPNA."@en. -:locationIdType a bamm:Property; - bamm:preferredName "Type of Location ID"@en; - bamm:description "Type of the location's ID."@en; - bamm:characteristic :LocationIdTypeEnum; - bamm:exampleValue "BPNS". -:locationId a bamm:Property; - bamm:preferredName "Location ID"@en; - bamm:description "The actual ID reflecting the type (locationIdType) of the location."@en; - bamm:characteristic :LocationIdCharacteristic; - bamm:exampleValue "BPNS0123456789ZZ". -:LocationIdTypeEnum a bamm-c:Enumeration; - bamm:preferredName "Location ID Type Enum"@en; - bamm:description "Enumeration specifying types of keys for locations within Catena-X."@en; - bamm:dataType xsd:string; - bamm:see ; - bamm-c:values ("BPNS" "BPNA"). -:LocationIdCharacteristic a bamm:Characteristic; - bamm:preferredName "Location ID Characteristic"@en; - bamm:description "The actual key based on the type."@en; - bamm:dataType xsd:string; - bamm:see . - -:QuantityCharacteristic a bamm-c:Quantifiable; - bamm:preferredName "Quantity Characteristic"@en; - bamm:description "Describes the quantity in which the child part is assembled in the given parent object by providing a quantity value and the measurement unit in which the quantity is measured."@en; - bamm:dataType :Quantity. - -:Quantity a bamm:Entity; - bamm:preferredName "Quantity"@en; - bamm:description "Comprises the number of objects and the unit of measurement for the respective child objects"@en; - bamm:properties (:quantityNumber :measurementUnit). - -:quantityNumber a bamm:Property; - bamm:preferredName "Quantity Number"@en; - bamm:description "The number of objects related to the measurement unit"@en; - bamm:characteristic :NumberofObjects; - bamm:exampleValue "2.5"^^xsd:double. - -:measurementUnit a bamm:Property; - bamm:preferredName "Measurement Unit"@en; - bamm:description "Unit of measurement for the quantity of objects.\nIf possible, use units from the aspect meta model unit catalog, which is based on the UNECE Recommendation No. 20 \"Codes for Units of Measure used in International Trade\"."@en; - bamm:characteristic bamm-c:UnitReference; - bamm:exampleValue "unit:litre"^^bamm:curie; - bamm:see . - -:NumberofObjects a bamm:Characteristic; - bamm:preferredName "Number of Objects"@en; - bamm:description "Quantifiable number of objects in reference to the measurementUnit"@en; - bamm:dataType xsd:double. - -:materialNumberSupplier a bamm:Property; - bamm:preferredName "Supplier Material Number"@en; - bamm:description "Material identifier as assigned by supplier. This material number identifies the material (as planned) in supplier's database."@en; - bamm:characteristic :MaterialNumber; - bamm:exampleValue "MNR-8101-ID146955.001". - -:MaterialNumber a bamm:Characteristic; - bamm:preferredName "Material Number"@en; - bamm:description "The material number is a multi-character string, usually assigned by an ERP system."@en; - bamm:dataType xsd:string. - -:CatenaXIdTraitCharacteristic a bamm-c:Trait; - bamm:preferredName "Catena-X ID Trait"@en; - bamm:description "Trait to ensure UUID v4 data format"@en; - bamm-c:baseCharacteristic :Uuidv4Characteristic; - bamm-c:constraint :Uuidv4RegularExpression. - -:Uuidv4Characteristic a bamm:Characteristic; - bamm:preferredName "UUID v4"@en; - bamm:description "A version 4 UUID is a universally unique identifier that is generated using random 32 hexadecimal characters."@en; - bamm:dataType xsd:string; - bamm:see . - -:Uuidv4RegularExpression a bamm-c:RegularExpressionConstraint; - bamm:preferredName "Catena-X ID Regular Expression"@en; - bamm:description "The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by \"urn:uuid:\" to make it an IRI."@en; - bamm:see ; - bamm:value "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)". +@prefix samm: . +@prefix samm-c: . +@prefix samm-e: . +@prefix unit: . +@prefix rdf: . +@prefix rdfs: . +@prefix xsd: . +@prefix : . + +:PlannedProduction a samm:Aspect ; + samm:preferredName "Stock of Products of a Supplier"@en ; + samm:description "This aspect represents the latest quantities of a supplier's products that are on stock. The stock represent the build-to-order (BTO) stocks already available for the customer."@en ; + samm:properties ( :positions :materialNumberCustomer [ samm:property :materialNumberCatenaX; samm:optional true ] [ samm:property :materialNumberSupplier; samm:optional true ] ) ; + samm:operations ( ) ; + samm:events ( ) . + +:positions a samm:Property ; + samm:preferredName "Positions"@en ; + samm:description "The positions refer to positions within an order that refer to the given product (see materialNumberSupplier, materialNumberCustomer and materialNumberDataSpace) for which the stocks are transferred. The positions are differentiated by the orderPositionReference."@en ; + samm:characteristic :PositionsCollection . + +:materialNumberCustomer a samm:Property ; + samm:preferredName "Customer Material Number"@en ; + samm:description "Material identifier as assigned by customer. This material number identifies the material (as planned) in customer's database. For standard parts (e.g. screws) for which a customer does not have an own number, the materialNumberSupplier should be set in this field, too."@en ; + samm:characteristic :MaterialNumber ; + samm:exampleValue "MNR-7307-AU340474.002" . + +:materialNumberCatenaX a samm:Property ; + samm:preferredName "Material UUID Used in Catena-X"@en ; + samm:description "Material identifier used uniquely within Catena-X to identify the Material (e.g. PartAsPlanned)."@en ; + samm:characteristic :CatenaXIdTraitCharacteristic ; + samm:exampleValue "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df" . + +:materialNumberSupplier a samm:Property ; + samm:preferredName "Supplier Material Number"@en ; + samm:description "Material identifier as assigned by supplier. This material number identifies the material (as planned) in supplier's database."@en ; + samm:characteristic :MaterialNumber ; + samm:exampleValue "MNR-8101-ID146955.001" . + +:PositionsCollection a samm-c:Collection ; + samm:preferredName "Positions Collection"@en ; + samm:description "If any stock is available, then there is at least one position. If the supplier does differentiate the stock according to the order positions (an OrderPositionReference is set), then multiple positions can be given. There could also be only one position without an OrderPositionReference indicating an anonymous stock which is allocated to the customer."@en ; + samm:dataType :Position . + +:MaterialNumber 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 . + +:CatenaXIdTraitCharacteristic a samm-c:Trait ; + samm:preferredName "Catena-X ID Trait"@en ; + samm:description "Trait to ensure UUID v4 data format"@en ; + samm-c:baseCharacteristic :Uuidv4Characteristic ; + samm-c:constraint :Uuidv4RegularExpression . + +:Position a samm:Entity ; + samm:preferredName "Position"@en ; + samm:description "The Position can be located at several stocks. A position may be anonymous or may reference an position within an order."@en ; + samm:properties ( [ samm:property :orderPositionReference; samm:optional true ] :lastUpdatedOnDateTime :allocatedProductionOutputs ) . + +:Uuidv4Characteristic a samm:Characteristic ; + samm:preferredName "UUID v4"@en ; + samm:description "A version 4 UUID is a universally unique identifier that is generated using random 32 hexadecimal characters."@en ; + samm:see ; + samm:dataType xsd:string . + +:Uuidv4RegularExpression a samm-c:RegularExpressionConstraint ; + samm:preferredName "Catena-X ID Regular Expression"@en ; + samm:description "The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by \"urn:uuid:\" to make it an IRI."@en ; + samm:see ; + samm:value "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)" . + +:orderPositionReference a samm:Property ; + samm:preferredName "Order Position Reference"@en ; + samm:description "The order position reference contains information to identify a position within an order."@en ; + samm:characteristic :OrderPositionReferenceCharacteristic . + +:lastUpdatedOnDateTime a samm:Property ; + samm:preferredName "Lasted Updated on Date"@en ; + samm:description "Date and time at which the position has been updated by the supplier's systems. Date and time are set according to a timezone."@en ; + samm:characteristic :DateTimeStamp ; + samm:exampleValue "2023-04-01T14:23:00"^^xsd:date . + +:allocatedProductionOutputs a samm:Property ; + samm:preferredName "Allocated Production Outpus"@en ; + samm:description "Planned Production already allocated to the customer."@en ; + samm:characteristic :AllocatedProductionOutputCollection . + +:OrderPositionReferenceCharacteristic a samm:Characteristic ; + samm:preferredName "Order Position Reference Characteristic"@en ; + samm:description "The order position reference includes reference numbers for the order and the ID. As these information are meant for the customer, the customer reference numbers are mandatory."@en ; + samm:dataType :OrderPositionReference . + +:DateTimeStamp a samm:Characteristic ; + samm:preferredName "Date Time Stamp Characteristic"@en ; + samm:description "The Date with the the timezone of the involved site."@en ; + samm:see ; + samm:dataType xsd:date . + +:AllocatedProductionOutputCollection a samm-c:Collection ; + samm:preferredName "Allocated Production Output Collection"@en ; + samm:description "Collection of PlannedProductionOutputs that may relate to different production locations and estimated time of completions."@en ; + samm:dataType :PlannedProductionOutput . + +:OrderPositionReference a samm:Entity ; + samm:preferredName "Reference to Order Position"@en ; + samm:description "Encapsulates the references to identify a position within an order."@en ; + samm:properties ( [ samm:property :supplierOrderId; samm:optional true ] :customerOrderId :customerOrderPositionId ) . + +:PlannedProductionOutput a samm:Entity ; + samm:preferredName "Planned Production Output"@en ; + samm:description "TBD: This is the quantity of already produced goods at a given location that has not yet been shipped. The allocated stock is the stock available for the customer and may refer to a given position (see OrderPositionReference). Quantities of Materials belonging to this stock are not available for other positions or customers. This stock consists only of the good parts."@en ; + samm:properties ( :plannedProductionQuantity :productionSiteBpns :estimatedTimeOfCompletion ) . + +:supplierOrderId a samm:Property ; + samm:preferredName "Supplier Order ID"@en ; + samm:description "This is the order number on the supplier side that is given by e.g., the supplier's enterprise resource planning system."@en ; + samm:characteristic :OrderIdCharacteristic ; + samm:exampleValue "M-Nbr-4711" . + +:customerOrderId a samm:Property ; + samm:preferredName "Customer Order ID"@en ; + samm:description "This is the order number on the customer side that can be given by e.g., the customer's enterprise resource planning system."@en ; + samm:characteristic :OrderIdCharacteristic ; + samm:exampleValue "C-Nbr-4711" . + +:customerOrderPositionId a samm:Property ; + samm:preferredName "Customer Order Position ID"@en ; + samm:description "This is an identifier for the position of an order defined by the customer. It's not a technical identifier, such as an UUID. This identifier is used within the business context when talking about the position."@en ; + samm:characteristic :OrderPositionIdCharacteristic ; + samm:exampleValue "PositionId-01" . + +:plannedProductionQuantity a samm:Property ; + samm:preferredName "Planned Production Quantity"@en ; + samm:description "TBD: This is the quantity of the material within the position that is already ready to be delivered."@en ; + samm:characteristic :QuantityCharacteristic . + +:productionSiteBpns a samm:Property ; + samm:preferredName "BPNS of Supplier's Production Location"@en ; + samm:description "One PlannedProductionOutput has always one site. The location is identified using BPNS."@en ; + samm:see ; + samm:characteristic :BpnsCharacteristic ; + samm:exampleValue "BPNS0123456789ZZ" . + +:estimatedTimeOfCompletion a samm:Property ; + samm:preferredName "Estimated Time of Completion"@en ; + samm:description "TBD: ISO"@en ; + samm:characteristic :DateTimeStamp . + +:OrderIdCharacteristic a samm:Characteristic ; + samm:preferredName "Order ID Characteristic"@en ; + samm:description "This is a proprietary order ID, generated by either the supplier side or customer side."@en ; + samm:dataType xsd:string . + +:OrderPositionIdCharacteristic a samm:Characteristic ; + samm:preferredName "Position ID within Order"@en ; + samm:description "The position ID is unique for an order and used within business context to refer to a position."@en ; + samm:dataType xsd:string . + +:QuantityCharacteristic a samm-c:Quantifiable ; + samm:preferredName "Quantity Characteristic"@en ; + samm:description "Describes the quantity in which the child part is assembled in the given parent object by providing a quantity value and the measurement unit in which the quantity is measured."@en ; + samm:dataType :Quantity . + +:BpnsCharacteristic a samm:Characteristic ; + samm:preferredName "BPNS Characteristic"@en ; + samm:description "TODO Tom"@en ; + samm:see ; + samm:dataType xsd:string . + +:Quantity a samm:Entity ; + samm:preferredName "Quantity"@en ; + samm:description "Comprises the number of objects and the unit of measurement for the respective child objects"@en ; + samm:properties ( :quantityNumber :measurementUnit ) . + +:quantityNumber a samm:Property ; + samm:preferredName "Quantity Number"@en ; + samm:description "The number of objects related to the measurement unit"@en ; + samm:characteristic :NumberofObjects ; + samm:exampleValue "2.5"^^xsd:double . + +:measurementUnit a samm:Property ; + samm:preferredName "Measurement Unit"@en ; + samm:description """Unit of measurement for the quantity of objects. +If possible, use units from the aspect meta model unit catalog, which is based on the UNECE Recommendation No. 20 \"Codes for Units of Measure used in International Trade\"."""@en ; + samm:see ; + samm:characteristic samm-c:UnitReference ; + samm:exampleValue "unit:litre"^^samm:curie . + +:NumberofObjects a samm:Characteristic ; + samm:preferredName "Number of Objects"@en ; + samm:description "Quantifiable number of objects in reference to the measurementUnit"@en ; + samm:dataType xsd:double . + From ed7ca42fb71b469b70d62f2dd0fbae652263f9d8 Mon Sep 17 00:00:00 2001 From: --show-origin Date: Mon, 28 Aug 2023 01:24:53 -0700 Subject: [PATCH 03/21] feat: first completed draft of planned production --- .../PlannedProduction-documentation.html | 1303 +++++++++++++++++ .../1.0.0/PlannedProduction.ttl | 39 +- 2 files changed, 1320 insertions(+), 22 deletions(-) create mode 100644 io.catenax.planned_production/1.0.0/PlannedProduction-documentation.html diff --git a/io.catenax.planned_production/1.0.0/PlannedProduction-documentation.html b/io.catenax.planned_production/1.0.0/PlannedProduction-documentation.html new file mode 100644 index 000000000..d5395e98a --- /dev/null +++ b/io.catenax.planned_production/1.0.0/PlannedProduction-documentation.html @@ -0,0 +1,1303 @@ + + + + + + + + + + + + + + Documentation Stock of Products of a Supplier + + +
+
+
+
+

Aspect Model Stock of Products of a Supplier

+
urn:samm:io.catenax.planned_production:1.0.0#PlannedProduction
+
+
+
+
+
+
+
+ +
+ + + + +
+

Overview

+
+
+
+
+ Aspect Model Diagram +
+
+
+ + +
+
+

Properties

+
+ +
+ +
+

Customer Material Number

+
+ +Material identifier as assigned by customer. This material number identifies the material (as planned) in customer's database. For standard parts (e.g. screws) for which a customer does not have an own number, the materialNumberSupplier should be set in this field, too. + +
+
Name
+
materialNumberCustomer
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialNumberCustomer
+
+ + +
+
+ +
+

Material UUID Used in Catena-X

+
+ +Material identifier used uniquely within Catena-X to identify the Material (e.g. PartAsPlanned). + +
+
Name
+
materialNumberCatenaX
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialNumberCatenaX
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Catena-X ID Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by "urn:uuid:" to make it an IRI.
    +
    + +
    +
    Reference
    +
    +
    +
      +
    • https://datatracker.ietf.org/doc/html/rfc4122
      • +
    +
    +
    +
    + +
    +
    Regular expression
    +
    $regularExpressionConstraint.getValue()
    +
    + +
    • +
+
+
+
+
+ +
+

Positions

+
+ +The positions refer to positions within an order that refer to the given product (see materialNumberSupplier, materialNumberCustomer and materialNumberDataSpace) for which the stocks are transferred. The positions are differentiated by the orderPositionReference. + +
+
Name
+
positions
+
+ + + +
+
Characteristic
+
+
+
+
Collection
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.planned_production:1.0.0#Position + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
positions
+
+ + +
+
+ +
+

Supplier Material Number

+
+ +Material identifier as assigned by supplier. This material number identifies the material (as planned) in supplier's database. + +
+
Name
+
materialNumberSupplier
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialNumberSupplier
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

Planned Production Output

+
+
+ Quantity, site of the supplier and date with time at which a production of a certain material for a certain customer is planned to be finished. +
+ +
+

Properties

+
+
+ +
+
Planned Production Quantity
+
+ +Quantity of a product that a supplier plans to produce on a certain date and time for a specific customer (that is: that will be allocated in a specific customer's "allocated product stock"). +Quantities already produced are put on stock or delivered. Therefore those quantities MUST NOT be considered in the allocated production output to build a consistent view on the supply situation. + +
+
Name
+
plannedProductionQuantity
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
Describes the quantity in which the child part is assembled in the given parent object by providing a quantity value and the measurement unit in which the quantity is measured.
+
+
+
+ Type urn:samm:io.catenax.planned_production:1.0.0#Quantity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
plannedProductionQuantity
+
+ + +
+
+ +
+
BPNS of Supplier's Production Location
+
+ +One PlannedProductionOutput has always one site. The location is identified using BPNS. + +
+
Name
+
productionSiteBpns
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productionSiteBpns
+
+ +
+
Reference
+
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + BPNS Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two uppercase letters.
    +
    + + +
    +
    Regular expression
    +
    $regularExpressionConstraint.getValue()
    +
    + +
    • +
+
+
+
+
+ +
+
Estimated Time of Completion
+
+ +Date and time on which the allocated production output is planned to be completed. Date and time are set according to a timezone of the supplier's production site. + +
+
Name
+
estimatedTimeOfCompletion
+
+ + + +
+
Characteristic
+
+
+
+
+ Reference +
+
    +
  • https://www.iso.org/iso-8601-date-and-time-format.html
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#date + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
estimatedTimeOfCompletion
+
+ + +
+
+
+
+

Position

+
+
+ The Position can be located at several stocks. A position may be anonymous or may reference an position within an order. +
+ +
+

Properties

+
+
+ +
+
Order Position Reference
+
+ +The order position reference contains information to identify a position within an order. + +
+
Name
+
orderPositionReference
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.planned_production:1.0.0#OrderPositionReference + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
orderPositionReference
+
+ + +
+
+ +
+
Lasted Updated on Date
+
+ +Date and time at which the position has been updated by the supplier's systems. Date and time are set according to a timezone. + +
+
Name
+
lastUpdatedOnDateTime
+
+ + + +
+
Characteristic
+
+
+
+
+ Reference +
+
    +
  • https://www.iso.org/iso-8601-date-and-time-format.html
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#date + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lastUpdatedOnDateTime
+
+ + +
+
+ +
+
Allocated Production Outpus
+
+ +Planned Production already allocated to the customer. + +
+
Name
+
allocatedProductionOutputs
+
+ + + +
+
Characteristic
+
+
+
+
Collection
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.planned_production:1.0.0#PlannedProductionOutput + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
allocatedProductionOutputs
+
+ + +
+
+
+
+

Quantity

+
+
+ Comprises the number of objects and the unit of measurement for the respective child objects +
+ +
+

Properties

+
+
+ +
+
Quantity Number
+
+ +The number of objects related to the measurement unit + +
+
Name
+
quantityNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
quantityNumber
+
+ + +
+
+ +
+
Unit of Measure
+
+ +Unit of measurement for demand quantities. + +
+
Name
+
unitOfMeasure
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
+
+
+
+
+ Reference +
+
    +
  • https://tfig.unece.org/contents/recommendation-20.htm
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unitOfMeasure
+
+ + +
+
+
+
+

Reference to Order Position

+
+
+ Encapsulates the references to identify a position within an order. +
+ +
+

Properties

+
+
+ +
+
Supplier Order ID
+
+ +This is the order number on the supplier side that is given by e.g., the supplier's enterprise resource planning system. + +
+
Name
+
supplierOrderId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
supplierOrderId
+
+ + +
+
+ +
+
Customer Order ID
+
+ +This is the order number on the customer side that can be given by e.g., the customer's enterprise resource planning system. + +
+
Name
+
customerOrderId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
customerOrderId
+
+ + +
+
+ +
+
Customer Order Position ID
+
+ +This is an identifier for the position of an order defined by the customer. It's not a technical identifier, such as an UUID. This identifier is used within the business context when talking about the position. + +
+
Name
+
customerOrderPositionId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
customerOrderPositionId
+
+ + +
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.planned_production/1.0.0/PlannedProduction.ttl b/io.catenax.planned_production/1.0.0/PlannedProduction.ttl index b7a32fc54..33912d95b 100644 --- a/io.catenax.planned_production/1.0.0/PlannedProduction.ttl +++ b/io.catenax.planned_production/1.0.0/PlannedProduction.ttl @@ -6,6 +6,7 @@ @prefix rdfs: . @prefix xsd: . @prefix : . +@prefix ext-demand: . :PlannedProduction a samm:Aspect ; samm:preferredName "Stock of Products of a Supplier"@en ; @@ -79,7 +80,7 @@ samm:preferredName "Lasted Updated on Date"@en ; samm:description "Date and time at which the position has been updated by the supplier's systems. Date and time are set according to a timezone."@en ; samm:characteristic :DateTimeStamp ; - samm:exampleValue "2023-04-01T14:23:00"^^xsd:date . + samm:exampleValue "2023-04-01T14:23:00+01:00"^^xsd:date . :allocatedProductionOutputs a samm:Property ; samm:preferredName "Allocated Production Outpus"@en ; @@ -93,7 +94,7 @@ :DateTimeStamp a samm:Characteristic ; samm:preferredName "Date Time Stamp Characteristic"@en ; - samm:description "The Date with the the timezone of the involved site."@en ; + samm:description "The Date with the timezone of the involved site."@en ; samm:see ; samm:dataType xsd:date . @@ -109,7 +110,7 @@ :PlannedProductionOutput a samm:Entity ; samm:preferredName "Planned Production Output"@en ; - samm:description "TBD: This is the quantity of already produced goods at a given location that has not yet been shipped. The allocated stock is the stock available for the customer and may refer to a given position (see OrderPositionReference). Quantities of Materials belonging to this stock are not available for other positions or customers. This stock consists only of the good parts."@en ; + samm:description "Quantity, site of the supplier and date with time at which a production of a certain material for a certain customer is planned to be finished."@en ; samm:properties ( :plannedProductionQuantity :productionSiteBpns :estimatedTimeOfCompletion ) . :supplierOrderId a samm:Property ; @@ -132,20 +133,22 @@ :plannedProductionQuantity a samm:Property ; samm:preferredName "Planned Production Quantity"@en ; - samm:description "TBD: This is the quantity of the material within the position that is already ready to be delivered."@en ; + samm:description """Quantity of a product that a supplier plans to produce on a certain date and time for a specific customer (that is: that will be allocated in a specific customer's \"allocated product stock\"). +Quantities already produced are put on stock or delivered. Therefore those quantities MUST NOT be considered in the allocated production output to build a consistent view on the supply situation. """@en ; samm:characteristic :QuantityCharacteristic . :productionSiteBpns a samm:Property ; samm:preferredName "BPNS of Supplier's Production Location"@en ; samm:description "One PlannedProductionOutput has always one site. The location is identified using BPNS."@en ; samm:see ; - samm:characteristic :BpnsCharacteristic ; + samm:characteristic ext-demand:BPNSTrait ; samm:exampleValue "BPNS0123456789ZZ" . :estimatedTimeOfCompletion a samm:Property ; samm:preferredName "Estimated Time of Completion"@en ; - samm:description "TBD: ISO"@en ; - samm:characteristic :DateTimeStamp . + samm:description "Date and time on which the allocated production output is planned to be completed. Date and time are set according to a timezone of the supplier's production site."@en ; + samm:characteristic :DateTimeStamp ; + samm:exampleValue "2023-04-01T14:23:00+01:00"^^xsd:date . :OrderIdCharacteristic a samm:Characteristic ; samm:preferredName "Order ID Characteristic"@en ; @@ -162,16 +165,10 @@ samm:description "Describes the quantity in which the child part is assembled in the given parent object by providing a quantity value and the measurement unit in which the quantity is measured."@en ; samm:dataType :Quantity . -:BpnsCharacteristic a samm:Characteristic ; - samm:preferredName "BPNS Characteristic"@en ; - samm:description "TODO Tom"@en ; - samm:see ; - samm:dataType xsd:string . - :Quantity a samm:Entity ; samm:preferredName "Quantity"@en ; samm:description "Comprises the number of objects and the unit of measurement for the respective child objects"@en ; - samm:properties ( :quantityNumber :measurementUnit ) . + samm:properties ( :quantityNumber ext-demand:unitOfMeasure ) . :quantityNumber a samm:Property ; samm:preferredName "Quantity Number"@en ; @@ -179,16 +176,14 @@ samm:characteristic :NumberofObjects ; samm:exampleValue "2.5"^^xsd:double . -:measurementUnit a samm:Property ; - samm:preferredName "Measurement Unit"@en ; - samm:description """Unit of measurement for the quantity of objects. -If possible, use units from the aspect meta model unit catalog, which is based on the UNECE Recommendation No. 20 \"Codes for Units of Measure used in International Trade\"."""@en ; - samm:see ; - samm:characteristic samm-c:UnitReference ; - samm:exampleValue "unit:litre"^^samm:curie . - :NumberofObjects a samm:Characteristic ; samm:preferredName "Number of Objects"@en ; samm:description "Quantifiable number of objects in reference to the measurementUnit"@en ; samm:dataType xsd:double . +:BpnsCharacteristic a samm:Characteristic ; + samm:preferredName "BPNS Characteristic"@en ; + samm:description "TODO Tom"@en ; + samm:see ; + samm:dataType xsd:string . + From 96e5e60a8021c79b626f84409f7d535cfae6f2e2 Mon Sep 17 00:00:00 2001 From: --show-origin Date: Wed, 30 Aug 2023 07:12:33 -0700 Subject: [PATCH 04/21] feat: reframing production output to planned production output --- .../1.0.0/PlannedProductionOutput.ttl | 169 ++++++++++++++++++ .../1.0.0/metadata.json | 1 + .../RELEASE_NOTES.md | 7 + 3 files changed, 177 insertions(+) create mode 100644 io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl create mode 100644 io.catenax.planned_production_output/1.0.0/metadata.json create mode 100644 io.catenax.planned_production_output/RELEASE_NOTES.md diff --git a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl new file mode 100644 index 000000000..9e9bbed54 --- /dev/null +++ b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl @@ -0,0 +1,169 @@ +@prefix samm: . +@prefix samm-c: . +@prefix samm-e: . +@prefix unit: . +@prefix rdf: . +@prefix rdfs: . +@prefix xsd: . +@prefix : . +@prefix ext-demand: . + +:PlannedProductionOutput a samm:Aspect; + samm:preferredName "Planned Production Output of a Supplier"@en; + samm:description "This aspect represents the remaining and planned production output of a supplier. A planned production output is described by a quantity, the site of the supplier and the date with time at which a production of a certain material for a certain customer is planned to be finished. TODO: check if positions need to be considered somehow?"@en; + samm:properties (:positions :materialNumberCustomer [ + samm:property :materialNumberCatenaX; + samm:optional "true"^^xsd:boolean +] [ + samm:property :materialNumberSupplier; + samm:optional "true"^^xsd:boolean +]); + samm:operations (); + samm:events (). +:positions a samm:Property; + samm:preferredName "Positions"@en; + samm:description "The positions refer to positions within an order of the given product (see material number supplier, materialNumber customer and material number Catena-x) for which the production outputs are transferred. The positions can be differentiated by the order position reference. If no order position reference is given, then there is only one position containing all planned production outputs of the product."@en; + samm:characteristic :PositionsCollection. +: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 planned) 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 :MaterialNumber; + samm:exampleValue "MNR-7307-AU340474.002". +:materialNumberCatenaX a samm:Property; + samm:preferredName "Material UUID Used in Catena-X"@en; + samm:description "Material identifier used uniquely within Catena-X to identify the material (e.g. PartAsPlanned)."@en; + samm:characteristic :CatenaXIdTraitCharacteristic; + samm:exampleValue "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df". +: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 planned) in the supplier's database."@en; + samm:characteristic :MaterialNumber; + samm:exampleValue "MNR-8101-ID146955.001". +:PositionsCollection a samm-c:Collection; + samm:preferredName "Positions Collection"@en; + samm:description "If any production for the customer is planned, then there is at least one position. If the supplier does differentiate the planned production according to the order positions (an OrderPositionReference is set), then multiple positions can be given. Among the positions, there could be only one position without an OrderPositionReference to either report the planned production independently of orders or to report internal stock orders planned for the customer."@en; + samm:dataType :Position. +:MaterialNumber 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. +:CatenaXIdTraitCharacteristic a samm-c:Trait; + samm:preferredName "Catena-X ID Trait"@en; + samm:description "Trait to ensure UUID v4 data format."@en; + samm-c:baseCharacteristic :Uuidv4Characteristic; + samm-c:constraint :Uuidv4RegularExpression. +:Position a samm:Entity; + samm:preferredName "Position"@en; + samm:description "The Position can be planned for production at several sites. A position may be anonymous or may reference an position within an order."@en; + samm:properties ([ + samm:property :orderPositionReference; + samm:optional "true"^^xsd:boolean +] :lastUpdatedOnDateTime :allocatedProductionOutputs). +:Uuidv4Characteristic a samm:Characteristic; + samm:preferredName "UUID v4"@en; + samm:description "A version 4 UUID is a universally unique identifier that is generated using random 32 hexadecimal characters."@en; + samm:dataType xsd:string; + samm:see . +:Uuidv4RegularExpression a samm-c:RegularExpressionConstraint; + samm:preferredName "Catena-X ID Regular Expression"@en; + samm:description "The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by \"urn:uuid:\" to make it an IRI."@en; + samm:see ; + samm:value "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)". +:orderPositionReference a samm:Property; + samm:preferredName "Order Position Reference"@en; + samm:description "The order position reference contains information to identify a position within an order."@en; + samm:characteristic :OrderPositionReferenceCharacteristic. +:lastUpdatedOnDateTime a samm:Property; + samm:preferredName "Lasted Updated on Date"@en; + samm:description "Date and time at which the position has been updated by the supplier's systems. Date and time are set according to a timezone."@en; + samm:characteristic :DateTimeStamp; + samm:exampleValue "2023-04-01T14:23:00+01:00"^^xsd:date. +:allocatedProductionOutputs a samm:Property; + samm:preferredName "Allocated Production Outpus"@en; + samm:description "Planned Production already allocated to the customer."@en; + samm:characteristic :AllocatedProductionOutputCollection. +:OrderPositionReferenceCharacteristic a samm:Characteristic; + samm:preferredName "Order Position Reference Characteristic"@en; + samm:description "The order position reference includes reference numbers for the order and the ID. As these information are meant for the customer, the customer reference numbers are mandatory."@en; + samm:dataType :OrderPositionReference. +:DateTimeStamp a samm:Characteristic; + samm:preferredName "Date Time Stamp Characteristic"@en; + samm:description "The Date with the timezone of the involved site."@en; + samm:dataType xsd:date; + samm:see . +:AllocatedProductionOutputCollection a samm-c:Collection; + samm:preferredName "Allocated Production Output Collection"@en; + samm:description "Collection of PlannedProductionOutputs that may relate to different production locations and estimated time of completions."@en; + samm:dataType :PlannedProductionOutput. +:OrderPositionReference a samm:Entity; + samm:preferredName "Reference to Order Position"@en; + samm:description "Encapsulates the references to identify a position within an order."@en; + samm:properties ([ + samm:property :supplierOrderId; + samm:optional "true"^^xsd:boolean +] :customerOrderId :customerOrderPositionId). +:PlannedProductionOutput a samm:Entity; + samm:preferredName "Planned Production Output"@en; + samm:description "Quantity, site of the supplier and date with time at which a production of a certain material for a certain customer is planned to be finished."@en; + samm:properties (:plannedProductionQuantity :productionSiteBpns :estimatedTimeOfCompletion). +:supplierOrderId a samm:Property; + samm:preferredName "Supplier Order ID"@en; + samm:description "This is the order number on the supplier side that is given by e.g., the supplier's enterprise resource planning system."@en; + samm:characteristic :OrderIdCharacteristic; + samm:exampleValue "M-Nbr-4711". +:customerOrderId a samm:Property; + samm:preferredName "Customer Order ID"@en; + samm:description "This is the order number on the customer side that can be given by e.g., the customer's enterprise resource planning system."@en; + samm:characteristic :OrderIdCharacteristic; + samm:exampleValue "C-Nbr-4711". +:customerOrderPositionId a samm:Property; + samm:preferredName "Customer Order Position ID"@en; + samm:description "This is an identifier for the position of an order defined by the customer. It's not a technical identifier, such as an UUID. This identifier is used within the business context when talking about the position."@en; + samm:characteristic :OrderPositionIdCharacteristic; + samm:exampleValue "PositionId-01". +:plannedProductionQuantity a samm:Property; + samm:preferredName "Planned Production Quantity"@en; + samm:description "Quantity of a product that a supplier plans to produce on a certain date and time for a specific customer (that is: that will be allocated in a specific customer's \"allocated product stock\").\nQuantities already produced are put on stock or delivered. Therefore those quantities MUST NOT be considered in the allocated production output to build a consistent view on the supply situation. "@en; + samm:characteristic :QuantityCharacteristic. +:productionSiteBpns a samm:Property; + samm:preferredName "BPNS of Supplier's Production Location"@en; + samm:description "One PlannedProductionOutput has always one site. The location is identified using BPNS."@en; + samm:characteristic ext-demand:BPNSTrait; + samm:exampleValue "BPNS0123456789ZZ"; + samm:see . +:estimatedTimeOfCompletion a samm:Property; + samm:preferredName "Estimated Time of Completion"@en; + samm:description "Date and time on which the allocated production output is planned to be completed. Date and time are set according to a timezone of the supplier's production site."@en; + samm:characteristic :DateTimeStamp; + samm:exampleValue "2023-04-01T14:23:00+01:00"^^xsd:date. +:OrderIdCharacteristic a samm:Characteristic; + samm:preferredName "Order ID Characteristic"@en; + samm:description "This is a proprietary order ID, generated by either the supplier side or customer side."@en; + samm:dataType xsd:string. +:OrderPositionIdCharacteristic a samm:Characteristic; + samm:preferredName "Position ID within Order"@en; + samm:description "The position ID is unique for an order and used within business context to refer to a position."@en; + samm:dataType xsd:string. +:QuantityCharacteristic a samm-c:Quantifiable; + samm:preferredName "Quantity Characteristic"@en; + samm:description "Describes the quantity in which the child part is assembled in the given parent object by providing a quantity value and the measurement unit in which the quantity is measured."@en; + samm:dataType :Quantity. +:Quantity a samm:Entity; + samm:preferredName "Quantity"@en; + samm:description "Comprises the number of objects and the unit of measurement for the respective child objects"@en; + samm:properties (:quantityNumber ext-demand:unitOfMeasure). +:quantityNumber a samm:Property; + samm:preferredName "Quantity Number"@en; + samm:description "The number of objects related to the measurement unit"@en; + samm:characteristic :NumberofObjects; + samm:exampleValue "2.5"^^xsd:double. +:NumberofObjects a samm:Characteristic; + samm:preferredName "Number of Objects"@en; + samm:description "Quantifiable number of objects in reference to the measurementUnit"@en; + samm:dataType xsd:double. +:BpnsCharacteristic a samm:Characteristic; + samm:preferredName "BPNS Characteristic"@en; + samm:description "TODO Tom"@en; + samm:dataType xsd:string; + samm:see . + diff --git a/io.catenax.planned_production_output/1.0.0/metadata.json b/io.catenax.planned_production_output/1.0.0/metadata.json new file mode 100644 index 000000000..e2a5a0225 --- /dev/null +++ b/io.catenax.planned_production_output/1.0.0/metadata.json @@ -0,0 +1 @@ +{ "status" : "draft"} diff --git a/io.catenax.planned_production_output/RELEASE_NOTES.md b/io.catenax.planned_production_output/RELEASE_NOTES.md new file mode 100644 index 000000000..5b6b26a56 --- /dev/null +++ b/io.catenax.planned_production_output/RELEASE_NOTES.md @@ -0,0 +1,7 @@ +# Changelog +All notable changes to this model will be documented in this file. + +## [Unreleased] +### Added +- initial model + From e32814308698ee36a63781bc62213053eb42f4ed Mon Sep 17 00:00:00 2001 From: --show-origin Date: Thu, 31 Aug 2023 07:12:22 -0700 Subject: [PATCH 05/21] feat: renamed model, enhanced semantics --- .../1.0.0/PlannedProductionOutput.ttl | 46 +++++++++---------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl index 9e9bbed54..946ccccf4 100644 --- a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl +++ b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl @@ -58,7 +58,7 @@ samm:properties ([ samm:property :orderPositionReference; samm:optional "true"^^xsd:boolean -] :lastUpdatedOnDateTime :allocatedProductionOutputs). +] :lastUpdatedOnDateTime :allocatedPlannedProductionOutputs). :Uuidv4Characteristic a samm:Characteristic; samm:preferredName "UUID v4"@en; samm:description "A version 4 UUID is a universally unique identifier that is generated using random 32 hexadecimal characters."@en; @@ -75,26 +75,26 @@ samm:characteristic :OrderPositionReferenceCharacteristic. :lastUpdatedOnDateTime a samm:Property; samm:preferredName "Lasted Updated on Date"@en; - samm:description "Date and time at which the position has been updated by the supplier's systems. Date and time are set according to a timezone."@en; + samm:description "Date and time at which the position has been updated by the supplier's systems. Date and time are set according to the timezone."@en; samm:characteristic :DateTimeStamp; samm:exampleValue "2023-04-01T14:23:00+01:00"^^xsd:date. -:allocatedProductionOutputs a samm:Property; - samm:preferredName "Allocated Production Outpus"@en; - samm:description "Planned Production already allocated to the customer."@en; +:allocatedPlannedProductionOutputs a samm:Property; + samm:preferredName "Planned and Allocated Production Outpus"@en; + samm:description "Planned Production Outputs already allocated to the customer."@en; samm:characteristic :AllocatedProductionOutputCollection. :OrderPositionReferenceCharacteristic a samm:Characteristic; samm:preferredName "Order Position Reference Characteristic"@en; - samm:description "The order position reference includes reference numbers for the order and the ID. As these information are meant for the customer, the customer reference numbers are mandatory."@en; + samm:description "The order position reference includes reference numbers for the order and the position. As these information are meant for the customer, the customer reference numbers are mandatory."@en; samm:dataType :OrderPositionReference. :DateTimeStamp a samm:Characteristic; samm:preferredName "Date Time Stamp Characteristic"@en; - samm:description "The Date with the timezone of the involved site."@en; + samm:description "The Date with the timezone."@en; samm:dataType xsd:date; samm:see . -:AllocatedProductionOutputCollection a samm-c:Collection; - samm:preferredName "Allocated Production Output Collection"@en; - samm:description "Collection of PlannedProductionOutputs that may relate to different production locations and estimated time of completions."@en; - samm:dataType :PlannedProductionOutput. +:AllocatedPlannedProductionOutputCollection a samm-c:Collection; + samm:preferredName "Planned and Allocated Production Output Collection"@en; + samm:description "Collection of planned and allocated production outputs that may relate to different production locations and estimated time of completions."@en; + samm:dataType :AllocatedPlannedProductionOutput. :OrderPositionReference a samm:Entity; samm:preferredName "Reference to Order Position"@en; samm:description "Encapsulates the references to identify a position within an order."@en; @@ -102,8 +102,8 @@ samm:property :supplierOrderId; samm:optional "true"^^xsd:boolean ] :customerOrderId :customerOrderPositionId). -:PlannedProductionOutput a samm:Entity; - samm:preferredName "Planned Production Output"@en; +:AllocatedPlannedProductionOutput a samm:Entity; + samm:preferredName "Planned and Allocated Production Output"@en; samm:description "Quantity, site of the supplier and date with time at which a production of a certain material for a certain customer is planned to be finished."@en; samm:properties (:plannedProductionQuantity :productionSiteBpns :estimatedTimeOfCompletion). :supplierOrderId a samm:Property; @@ -123,17 +123,17 @@ samm:exampleValue "PositionId-01". :plannedProductionQuantity a samm:Property; samm:preferredName "Planned Production Quantity"@en; - samm:description "Quantity of a product that a supplier plans to produce on a certain date and time for a specific customer (that is: that will be allocated in a specific customer's \"allocated product stock\").\nQuantities already produced are put on stock or delivered. Therefore those quantities MUST NOT be considered in the allocated production output to build a consistent view on the supply situation. "@en; + samm:description "Quantity of a product that a supplier plans to produce on a certain date and time for a specific customer (that is: that will be allocated in a specific customer's \"allocated product stock\").\nQuantities that have already been produced are put on stock or delivered. Therefore those quantities MUST NOT be considered in the allocated production output to build a consistent view on the supply situation. "@en; samm:characteristic :QuantityCharacteristic. :productionSiteBpns a samm:Property; - samm:preferredName "BPNS of Supplier's Production Location"@en; - samm:description "One PlannedProductionOutput has always one site. The location is identified using BPNS."@en; + samm:preferredName "BPNS of Supplier's Production Site"@en; + samm:description "One planned and alllocated production output has always one site. The site is identified by the BPNS."@en; samm:characteristic ext-demand:BPNSTrait; samm:exampleValue "BPNS0123456789ZZ"; samm:see . :estimatedTimeOfCompletion a samm:Property; samm:preferredName "Estimated Time of Completion"@en; - samm:description "Date and time on which the allocated production output is planned to be completed. Date and time are set according to a timezone of the supplier's production site."@en; + samm:description "Date and time on which the planned and allocated production output is estimated to be completed. Date and time are set according to a timezone."@en; samm:characteristic :DateTimeStamp; samm:exampleValue "2023-04-01T14:23:00+01:00"^^xsd:date. :OrderIdCharacteristic a samm:Characteristic; @@ -146,24 +146,24 @@ samm:dataType xsd:string. :QuantityCharacteristic a samm-c:Quantifiable; samm:preferredName "Quantity Characteristic"@en; - samm:description "Describes the quantity in which the child part is assembled in the given parent object by providing a quantity value and the measurement unit in which the quantity is measured."@en; + samm:description "Describes the quantity and the unit of measure with which the planned and allocated production output is measured."@en; samm:dataType :Quantity. :Quantity a samm:Entity; samm:preferredName "Quantity"@en; - samm:description "Comprises the number of objects and the unit of measurement for the respective child objects"@en; - samm:properties (:quantityNumber ext-demand:unitOfMeasure). + samm:description "Comprises the number of objects and the unit of measurement."@en; + samm:properties (:quantityNumber ext-demand:unitOfMeasure). #TODO: Tom :quantityNumber a samm:Property; samm:preferredName "Quantity Number"@en; - samm:description "The number of objects related to the measurement unit"@en; + samm:description "The number of objects related to the unit of measure."@en; samm:characteristic :NumberofObjects; samm:exampleValue "2.5"^^xsd:double. :NumberofObjects a samm:Characteristic; samm:preferredName "Number of Objects"@en; - samm:description "Quantifiable number of objects in reference to the measurementUnit"@en; + samm:description "Quantifiable number of objects in reference to the unit of measure."@en; samm:dataType xsd:double. :BpnsCharacteristic a samm:Characteristic; samm:preferredName "BPNS Characteristic"@en; - samm:description "TODO Tom"@en; + samm:description "TODO: Tom"@en; samm:dataType xsd:string; samm:see . From 2643eaa9295f17bc11c9e2390d5dece9d3160b12 Mon Sep 17 00:00:00 2001 From: --show-origin Date: Thu, 31 Aug 2023 08:57:24 -0700 Subject: [PATCH 06/21] fix: added missing characteristics and renaming faults --- .../1.0.0/PlannedProductionOutput.ttl | 37 ++++++++++++++----- 1 file changed, 27 insertions(+), 10 deletions(-) diff --git a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl index 946ccccf4..0deb1fc90 100644 --- a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl +++ b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl @@ -6,7 +6,6 @@ @prefix rdfs: . @prefix xsd: . @prefix : . -@prefix ext-demand: . :PlannedProductionOutput a samm:Aspect; samm:preferredName "Planned Production Output of a Supplier"@en; @@ -81,7 +80,7 @@ :allocatedPlannedProductionOutputs a samm:Property; samm:preferredName "Planned and Allocated Production Outpus"@en; samm:description "Planned Production Outputs already allocated to the customer."@en; - samm:characteristic :AllocatedProductionOutputCollection. + samm:characteristic :AllocatedPlannedProductionOutputCollection. :OrderPositionReferenceCharacteristic a samm:Characteristic; samm:preferredName "Order Position Reference Characteristic"@en; samm:description "The order position reference includes reference numbers for the order and the position. As these information are meant for the customer, the customer reference numbers are mandatory."@en; @@ -128,7 +127,7 @@ :productionSiteBpns a samm:Property; samm:preferredName "BPNS of Supplier's Production Site"@en; samm:description "One planned and alllocated production output has always one site. The site is identified by the BPNS."@en; - samm:characteristic ext-demand:BPNSTrait; + samm:characteristic :BPNSTrait; samm:exampleValue "BPNS0123456789ZZ"; samm:see . :estimatedTimeOfCompletion a samm:Property; @@ -151,7 +150,18 @@ :Quantity a samm:Entity; samm:preferredName "Quantity"@en; samm:description "Comprises the number of objects and the unit of measurement."@en; - samm:properties (:quantityNumber ext-demand:unitOfMeasure). #TODO: Tom + samm:properties (:quantityNumber :unitOfMeasure). +:unitOfMeasure a samm:Property; + samm:preferredName "Unit of Measure"@en; + samm:description "Unit of measurement for demand quantities."@en; + samm:characteristic :UnitOfMeasure; + samm:exampleValue "KGM". +:UnitOfMeasure a samm-c:Enumeration; + samm:preferredName "Unit of Measure"@en; + samm:description "The Enumeration lists a selection of allowed units of measure referenced by their official code according to Codes for Units of Measure Used in International Trade"@en; + samm:dataType xsd:string; + samm:see ; + samm-c:values ("GRM" "KGM" "TNE" "STN" "ONZ" "LBR" "CMT" "MTR" "KTM" "INH" "FOT" "YRD" "CMK" "MTK" "INK" "FTK" "YDK" "CMQ" "MTQ" "INQ" "FTQ" "YDQ" "MLT" "LTR" "HLT" "H87" "SET" "PR" "ZP" "KWH" ""). :quantityNumber a samm:Property; samm:preferredName "Quantity Number"@en; samm:description "The number of objects related to the unit of measure."@en; @@ -161,9 +171,16 @@ samm:preferredName "Number of Objects"@en; samm:description "Quantifiable number of objects in reference to the unit of measure."@en; samm:dataType xsd:double. -:BpnsCharacteristic a samm:Characteristic; - samm:preferredName "BPNS Characteristic"@en; - samm:description "TODO: Tom"@en; - samm:dataType xsd:string; - samm:see . - +:BPNSTrait a samm-c:Trait; + samm:preferredName "BPNS Trait"@en; + samm:description "Trait to ensure data format for BPNS."@en; + samm-c:baseCharacteristic :BPNS; + samm-c:constraint :BPNSRegularExpression. +:BPNS a samm:Characteristic; + samm:preferredName "Business Partner Number Site"@en; + samm:description "BPNS represents a site which can be a production plant inside one location."@en; + samm:dataType xsd:string. +:BPNSRegularExpression a samm-c:RegularExpressionConstraint; + samm:preferredName "BPNS Regular Expression"@en; + samm:description "The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two uppercase letters."@en; + samm:value "^BPNS[0-9]{8}[a-zA-Z0-9]{4}$". From d01f70c76a405330022a04409ce2a3e1a2a4325c Mon Sep 17 00:00:00 2001 From: --show-origin Date: Thu, 31 Aug 2023 08:58:37 -0700 Subject: [PATCH 07/21] chore: added html doc for easier accessability during modelling --- ...PlannedProductionOutput-documentation.html | 1303 +++++++++++++++++ 1 file changed, 1303 insertions(+) create mode 100644 io.catenax.planned_production_output/1.0.0/PlannedProductionOutput-documentation.html diff --git a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput-documentation.html b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput-documentation.html new file mode 100644 index 000000000..100c581bb --- /dev/null +++ b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput-documentation.html @@ -0,0 +1,1303 @@ + + + + + + + + + + + + + + Documentation Planned Production Output of a Supplier + + +
+
+
+
+

Aspect Model Planned Production Output of a Supplier

+
urn:samm:io.catenax.planned_production_output:1.0.0#PlannedProductionOutput
+
+
+
+
+
+
+
+ +
+ + + + +
+

Overview

+
+
+
+
+ Aspect Model Diagram +
+
+
+ + +
+
+

Properties

+
+ +
+ +
+

Customer Material Number

+
+ +Material identifier as assigned by the customer. This material number identifies the material (as planned) 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. + +
+
Name
+
materialNumberCustomer
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialNumberCustomer
+
+ + +
+
+ +
+

Material UUID Used in Catena-X

+
+ +Material identifier used uniquely within Catena-X to identify the material (e.g. PartAsPlanned). + +
+
Name
+
materialNumberCatenaX
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialNumberCatenaX
+
+ + +
+
Constraints
+
+
    +
  • +
    + +
    + Catena-X ID Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by "urn:uuid:" to make it an IRI.
    +
    + +
    +
    Reference
    +
    +
    +
      +
    • https://datatracker.ietf.org/doc/html/rfc4122
      • +
    +
    +
    +
    + +
    +
    Regular expression
    +
    $regularExpressionConstraint.getValue()
    +
    + +
    • +
+
+
+
+
+ +
+

Positions

+
+ +The positions refer to positions within an order of the given product (see material number supplier, materialNumber customer and material number Catena-x) for which the production outputs are transferred. The positions can be differentiated by the order position reference. If no order position reference is given, then there is only one position containing all planned production outputs of the product. + +
+
Name
+
positions
+
+ + + +
+
Characteristic
+
+
+
+
Collection
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.planned_production_output:1.0.0#Position + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
positions
+
+ + +
+
+ +
+

Supplier Material Number

+
+ +Material identifier as assigned by the supplier. This material number identifies the material (as planned) in the supplier's database. + +
+
Name
+
materialNumberSupplier
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
materialNumberSupplier
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

Planned and Allocated Production Output

+
+
+ Quantity, site of the supplier and date with time at which a production of a certain material for a certain customer is planned to be finished. +
+ +
+

Properties

+
+
+ +
+
Planned Production Quantity
+
+ +Quantity of a product that a supplier plans to produce on a certain date and time for a specific customer (that is: that will be allocated in a specific customer's "allocated product stock"). +Quantities that have already been produced are put on stock or delivered. Therefore those quantities MUST NOT be considered in the allocated production output to build a consistent view on the supply situation. + +
+
Name
+
plannedProductionQuantity
+
+ + + +
+
Characteristic
+
+
+
+
Quantifiable
+
+
+
Duration
+
+
+
Describes the quantity and the unit of measure with which the planned and allocated production output is measured.
+
+
+
+ Type urn:samm:io.catenax.planned_production_output:1.0.0#Quantity + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
plannedProductionQuantity
+
+ + +
+
+ +
+
BPNS of Supplier's Production Site
+
+ +One planned and alllocated production output has always one site. The site is identified by the BPNS. + +
+
Name
+
productionSiteBpns
+
+ + + +
+
Characteristic
+
+
+
+
Trait
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
productionSiteBpns
+
+ +
+
Reference
+
+
    +
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • +
+
+
+ +
+
Constraints
+
+
    +
  • +
    + +
    + BPNS Regular Expression +
    + +
    +
    Description
    +
    The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two uppercase letters.
    +
    + + +
    +
    Regular expression
    +
    $regularExpressionConstraint.getValue()
    +
    + +
    • +
+
+
+
+
+ +
+
Estimated Time of Completion
+
+ +Date and time on which the planned and allocated production output is estimated to be completed. Date and time are set according to a timezone. + +
+
Name
+
estimatedTimeOfCompletion
+
+ + + +
+
Characteristic
+
+
+
+
+ Reference +
+
    +
  • https://www.iso.org/iso-8601-date-and-time-format.html
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#date + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
estimatedTimeOfCompletion
+
+ + +
+
+
+
+

Position

+
+
+ The Position can be planned for production at several sites. A position may be anonymous or may reference an position within an order. +
+ +
+

Properties

+
+
+ +
+
Order Position Reference
+
+ +The order position reference contains information to identify a position within an order. + +
+
Name
+
orderPositionReference
+
+ + + +
+
Characteristic
+
+
+
+
SingleEntity
+
+
+
+ Type urn:samm:io.catenax.planned_production_output:1.0.0#OrderPositionReference + +
+
+
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
orderPositionReference
+
+ + +
+
+ +
+
Lasted Updated on Date
+
+ +Date and time at which the position has been updated by the supplier's systems. Date and time are set according to the timezone. + +
+
Name
+
lastUpdatedOnDateTime
+
+ + + +
+
Characteristic
+
+
+
+
+ Reference +
+
    +
  • https://www.iso.org/iso-8601-date-and-time-format.html
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#date + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
lastUpdatedOnDateTime
+
+ + +
+
+ +
+
Planned and Allocated Production Outpus
+
+ +Planned Production Outputs already allocated to the customer. + +
+
Name
+
allocatedPlannedProductionOutputs
+
+ + + +
+
Characteristic
+
+
+
+
Collection
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+
+
+ Type urn:samm:io.catenax.planned_production_output:1.0.0#AllocatedPlannedProductionOutput + +
+
+
+
+
+ + +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
allocatedPlannedProductionOutputs
+
+ + +
+
+
+
+

Quantity

+
+
+ Comprises the number of objects and the unit of measurement. +
+ +
+

Properties

+
+
+ +
+
Quantity Number
+
+ +The number of objects related to the unit of measure. + +
+
Name
+
quantityNumber
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#double + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
quantityNumber
+
+ + +
+
+ +
+
Unit of Measure
+
+ +Unit of measurement for demand quantities. + +
+
Name
+
unitOfMeasure
+
+ + + +
+
Characteristic
+
+
+
+
Enumeration
+
+
+
Values
+
+
+
+
    +
+
+
+
+
+ Reference +
+
    +
  • https://tfig.unece.org/contents/recommendation-20.htm
    • +
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
unitOfMeasure
+
+ + +
+
+
+
+

Reference to Order Position

+
+
+ Encapsulates the references to identify a position within an order. +
+ +
+

Properties

+
+
+ +
+
Supplier Order ID
+
+ +This is the order number on the supplier side that is given by e.g., the supplier's enterprise resource planning system. + +
+
Name
+
supplierOrderId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
supplierOrderId
+
+ + +
+
+ +
+
Customer Order ID
+
+ +This is the order number on the customer side that can be given by e.g., the customer's enterprise resource planning system. + +
+
Name
+
customerOrderId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
customerOrderId
+
+ + +
+
+ +
+
Customer Order Position ID
+
+ +This is an identifier for the position of an order defined by the customer. It's not a technical identifier, such as an UUID. This identifier is used within the business context when talking about the position. + +
+
Name
+
customerOrderPositionId
+
+ + + +
+
Characteristic
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string + +
+
+
+
+
+ +
+
Example
+
$property.getExampleValue().get().getValue()
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
customerOrderPositionId
+
+ + +
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file From 6aa5b58faf956efd053e343ef6d21dd9cf0e0058 Mon Sep 17 00:00:00 2001 From: --show-origin Date: Mon, 4 Sep 2023 05:24:43 -0700 Subject: [PATCH 08/21] chore: cleanup prior to MS 2 --- ...PlannedProductionOutput-documentation.html | 1303 ----------------- 1 file changed, 1303 deletions(-) delete mode 100644 io.catenax.planned_production_output/1.0.0/PlannedProductionOutput-documentation.html diff --git a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput-documentation.html b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput-documentation.html deleted file mode 100644 index 100c581bb..000000000 --- a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput-documentation.html +++ /dev/null @@ -1,1303 +0,0 @@ - - - - - - - - - - - - - - Documentation Planned Production Output of a Supplier - - -
-
-
-
-

Aspect Model Planned Production Output of a Supplier

-
urn:samm:io.catenax.planned_production_output:1.0.0#PlannedProductionOutput
-
-
-
-
-
-
-
- -
- - - - -
-

Overview

-
-
-
-
- Aspect Model Diagram -
-
-
- - -
-
-

Properties

-
- -
- -
-

Customer Material Number

-
- -Material identifier as assigned by the customer. This material number identifies the material (as planned) 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. - -
-
Name
-
materialNumberCustomer
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
$property.getExampleValue().get().getValue()
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
materialNumberCustomer
-
- - -
-
- -
-

Material UUID Used in Catena-X

-
- -Material identifier used uniquely within Catena-X to identify the material (e.g. PartAsPlanned). - -
-
Name
-
materialNumberCatenaX
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
$property.getExampleValue().get().getValue()
-
- -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
materialNumberCatenaX
-
- - -
-
Constraints
-
-
    -
  • -
    - -
    - Catena-X ID Regular Expression -
    - -
    -
    Description
    -
    The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by "urn:uuid:" to make it an IRI.
    -
    - -
    -
    Reference
    -
    -
    -
      -
    • https://datatracker.ietf.org/doc/html/rfc4122
      • -
    -
    -
    -
    - -
    -
    Regular expression
    -
    $regularExpressionConstraint.getValue()
    -
    - -
    • -
-
-
-
-
- -
-

Positions

-
- -The positions refer to positions within an order of the given product (see material number supplier, materialNumber customer and material number Catena-x) for which the production outputs are transferred. The positions can be differentiated by the order position reference. If no order position reference is given, then there is only one position containing all planned production outputs of the product. - -
-
Name
-
positions
-
- - - -
-
Characteristic
-
-
-
-
Collection
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Type urn:samm:io.catenax.planned_production_output:1.0.0#Position - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
positions
-
- - -
-
- -
-

Supplier Material Number

-
- -Material identifier as assigned by the supplier. This material number identifies the material (as planned) in the supplier's database. - -
-
Name
-
materialNumberSupplier
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
$property.getExampleValue().get().getValue()
-
- -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
materialNumberSupplier
-
- - -
-
- - - -
-
-

Entities

-
- -
-
-

Planned and Allocated Production Output

-
-
- Quantity, site of the supplier and date with time at which a production of a certain material for a certain customer is planned to be finished. -
- -
-

Properties

-
-
- -
-
Planned Production Quantity
-
- -Quantity of a product that a supplier plans to produce on a certain date and time for a specific customer (that is: that will be allocated in a specific customer's "allocated product stock"). -Quantities that have already been produced are put on stock or delivered. Therefore those quantities MUST NOT be considered in the allocated production output to build a consistent view on the supply situation. - -
-
Name
-
plannedProductionQuantity
-
- - - -
-
Characteristic
-
-
-
-
Quantifiable
-
-
-
Duration
-
-
-
Describes the quantity and the unit of measure with which the planned and allocated production output is measured.
-
-
-
- Type urn:samm:io.catenax.planned_production_output:1.0.0#Quantity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
plannedProductionQuantity
-
- - -
-
- -
-
BPNS of Supplier's Production Site
-
- -One planned and alllocated production output has always one site. The site is identified by the BPNS. - -
-
Name
-
productionSiteBpns
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
$property.getExampleValue().get().getValue()
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
productionSiteBpns
-
- -
-
Reference
-
-
    -
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • -
-
-
- -
-
Constraints
-
-
    -
  • -
    - -
    - BPNS Regular Expression -
    - -
    -
    Description
    -
    The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two uppercase letters.
    -
    - - -
    -
    Regular expression
    -
    $regularExpressionConstraint.getValue()
    -
    - -
    • -
-
-
-
-
- -
-
Estimated Time of Completion
-
- -Date and time on which the planned and allocated production output is estimated to be completed. Date and time are set according to a timezone. - -
-
Name
-
estimatedTimeOfCompletion
-
- - - -
-
Characteristic
-
-
-
-
- Reference -
-
    -
  • https://www.iso.org/iso-8601-date-and-time-format.html
    • -
-
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#date - -
-
-
-
-
- -
-
Example
-
$property.getExampleValue().get().getValue()
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
estimatedTimeOfCompletion
-
- - -
-
-
-
-

Position

-
-
- The Position can be planned for production at several sites. A position may be anonymous or may reference an position within an order. -
- -
-

Properties

-
-
- -
-
Order Position Reference
-
- -The order position reference contains information to identify a position within an order. - -
-
Name
-
orderPositionReference
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:samm:io.catenax.planned_production_output:1.0.0#OrderPositionReference - -
-
-
-
-
- - -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
orderPositionReference
-
- - -
-
- -
-
Lasted Updated on Date
-
- -Date and time at which the position has been updated by the supplier's systems. Date and time are set according to the timezone. - -
-
Name
-
lastUpdatedOnDateTime
-
- - - -
-
Characteristic
-
-
-
-
- Reference -
-
    -
  • https://www.iso.org/iso-8601-date-and-time-format.html
    • -
-
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#date - -
-
-
-
-
- -
-
Example
-
$property.getExampleValue().get().getValue()
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
lastUpdatedOnDateTime
-
- - -
-
- -
-
Planned and Allocated Production Outpus
-
- -Planned Production Outputs already allocated to the customer. - -
-
Name
-
allocatedPlannedProductionOutputs
-
- - - -
-
Characteristic
-
-
-
-
Collection
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Type urn:samm:io.catenax.planned_production_output:1.0.0#AllocatedPlannedProductionOutput - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
allocatedPlannedProductionOutputs
-
- - -
-
-
-
-

Quantity

-
-
- Comprises the number of objects and the unit of measurement. -
- -
-

Properties

-
-
- -
-
Quantity Number
-
- -The number of objects related to the unit of measure. - -
-
Name
-
quantityNumber
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#double - -
-
-
-
-
- -
-
Example
-
$property.getExampleValue().get().getValue()
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
quantityNumber
-
- - -
-
- -
-
Unit of Measure
-
- -Unit of measurement for demand quantities. - -
-
Name
-
unitOfMeasure
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Values
-
-
-
-
    -
-
-
-
-
- Reference -
-
    -
  • https://tfig.unece.org/contents/recommendation-20.htm
    • -
-
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
$property.getExampleValue().get().getValue()
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
unitOfMeasure
-
- - -
-
-
-
-

Reference to Order Position

-
-
- Encapsulates the references to identify a position within an order. -
- -
-

Properties

-
-
- -
-
Supplier Order ID
-
- -This is the order number on the supplier side that is given by e.g., the supplier's enterprise resource planning system. - -
-
Name
-
supplierOrderId
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
$property.getExampleValue().get().getValue()
-
- -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
supplierOrderId
-
- - -
-
- -
-
Customer Order ID
-
- -This is the order number on the customer side that can be given by e.g., the customer's enterprise resource planning system. - -
-
Name
-
customerOrderId
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
$property.getExampleValue().get().getValue()
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
customerOrderId
-
- - -
-
- -
-
Customer Order Position ID
-
- -This is an identifier for the position of an order defined by the customer. It's not a technical identifier, such as an UUID. This identifier is used within the business context when talking about the position. - -
-
Name
-
customerOrderPositionId
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
$property.getExampleValue().get().getValue()
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
customerOrderPositionId
-
- - -
-
-
- -
- Third party licenses - -
- -
- - -
- - - \ No newline at end of file From d9704a8181f726c4b7c7111d5fdf8e7cd2ba3e8b Mon Sep 17 00:00:00 2001 From: --show-origin Date: Mon, 4 Sep 2023 05:30:46 -0700 Subject: [PATCH 09/21] fix: removed old named files --- .../PlannedProduction-documentation.html | 1303 ----------------- .../1.0.0/PlannedProduction.ttl | 189 --- .../1.0.0/metadata.json | 1 - .../RELEASE_NOTES.md | 7 - 4 files changed, 1500 deletions(-) delete mode 100644 io.catenax.planned_production/1.0.0/PlannedProduction-documentation.html delete mode 100644 io.catenax.planned_production/1.0.0/PlannedProduction.ttl delete mode 100644 io.catenax.planned_production/1.0.0/metadata.json delete mode 100644 io.catenax.planned_production/RELEASE_NOTES.md diff --git a/io.catenax.planned_production/1.0.0/PlannedProduction-documentation.html b/io.catenax.planned_production/1.0.0/PlannedProduction-documentation.html deleted file mode 100644 index d5395e98a..000000000 --- a/io.catenax.planned_production/1.0.0/PlannedProduction-documentation.html +++ /dev/null @@ -1,1303 +0,0 @@ - - - - - - - - - - - - - - Documentation Stock of Products of a Supplier - - -
-
-
-
-

Aspect Model Stock of Products of a Supplier

-
urn:samm:io.catenax.planned_production:1.0.0#PlannedProduction
-
-
-
-
-
-
-
- -
- - - - -
-

Overview

-
-
-
-
- Aspect Model Diagram -
-
-
- - -
-
-

Properties

-
- -
- -
-

Customer Material Number

-
- -Material identifier as assigned by customer. This material number identifies the material (as planned) in customer's database. For standard parts (e.g. screws) for which a customer does not have an own number, the materialNumberSupplier should be set in this field, too. - -
-
Name
-
materialNumberCustomer
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
$property.getExampleValue().get().getValue()
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
materialNumberCustomer
-
- - -
-
- -
-

Material UUID Used in Catena-X

-
- -Material identifier used uniquely within Catena-X to identify the Material (e.g. PartAsPlanned). - -
-
Name
-
materialNumberCatenaX
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
$property.getExampleValue().get().getValue()
-
- -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
materialNumberCatenaX
-
- - -
-
Constraints
-
-
    -
  • -
    - -
    - Catena-X ID Regular Expression -
    - -
    -
    Description
    -
    The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by "urn:uuid:" to make it an IRI.
    -
    - -
    -
    Reference
    -
    -
    -
      -
    • https://datatracker.ietf.org/doc/html/rfc4122
      • -
    -
    -
    -
    - -
    -
    Regular expression
    -
    $regularExpressionConstraint.getValue()
    -
    - -
    • -
-
-
-
-
- -
-

Positions

-
- -The positions refer to positions within an order that refer to the given product (see materialNumberSupplier, materialNumberCustomer and materialNumberDataSpace) for which the stocks are transferred. The positions are differentiated by the orderPositionReference. - -
-
Name
-
positions
-
- - - -
-
Characteristic
-
-
-
-
Collection
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Type urn:samm:io.catenax.planned_production:1.0.0#Position - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
positions
-
- - -
-
- -
-

Supplier Material Number

-
- -Material identifier as assigned by supplier. This material number identifies the material (as planned) in supplier's database. - -
-
Name
-
materialNumberSupplier
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
$property.getExampleValue().get().getValue()
-
- -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
materialNumberSupplier
-
- - -
-
- - - -
-
-

Entities

-
- -
-
-

Planned Production Output

-
-
- Quantity, site of the supplier and date with time at which a production of a certain material for a certain customer is planned to be finished. -
- -
-

Properties

-
-
- -
-
Planned Production Quantity
-
- -Quantity of a product that a supplier plans to produce on a certain date and time for a specific customer (that is: that will be allocated in a specific customer's "allocated product stock"). -Quantities already produced are put on stock or delivered. Therefore those quantities MUST NOT be considered in the allocated production output to build a consistent view on the supply situation. - -
-
Name
-
plannedProductionQuantity
-
- - - -
-
Characteristic
-
-
-
-
Quantifiable
-
-
-
Duration
-
-
-
Describes the quantity in which the child part is assembled in the given parent object by providing a quantity value and the measurement unit in which the quantity is measured.
-
-
-
- Type urn:samm:io.catenax.planned_production:1.0.0#Quantity - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
plannedProductionQuantity
-
- - -
-
- -
-
BPNS of Supplier's Production Location
-
- -One PlannedProductionOutput has always one site. The location is identified using BPNS. - -
-
Name
-
productionSiteBpns
-
- - - -
-
Characteristic
-
-
-
-
Trait
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
$property.getExampleValue().get().getValue()
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
productionSiteBpns
-
- -
-
Reference
-
-
    -
  • https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf
    • -
-
-
- -
-
Constraints
-
-
    -
  • -
    - -
    - BPNS Regular Expression -
    - -
    -
    Description
    -
    The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two uppercase letters.
    -
    - - -
    -
    Regular expression
    -
    $regularExpressionConstraint.getValue()
    -
    - -
    • -
-
-
-
-
- -
-
Estimated Time of Completion
-
- -Date and time on which the allocated production output is planned to be completed. Date and time are set according to a timezone of the supplier's production site. - -
-
Name
-
estimatedTimeOfCompletion
-
- - - -
-
Characteristic
-
-
-
-
- Reference -
-
    -
  • https://www.iso.org/iso-8601-date-and-time-format.html
    • -
-
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#date - -
-
-
-
-
- -
-
Example
-
$property.getExampleValue().get().getValue()
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
estimatedTimeOfCompletion
-
- - -
-
-
-
-

Position

-
-
- The Position can be located at several stocks. A position may be anonymous or may reference an position within an order. -
- -
-

Properties

-
-
- -
-
Order Position Reference
-
- -The order position reference contains information to identify a position within an order. - -
-
Name
-
orderPositionReference
-
- - - -
-
Characteristic
-
-
-
-
SingleEntity
-
-
-
- Type urn:samm:io.catenax.planned_production:1.0.0#OrderPositionReference - -
-
-
-
-
- - -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
orderPositionReference
-
- - -
-
- -
-
Lasted Updated on Date
-
- -Date and time at which the position has been updated by the supplier's systems. Date and time are set according to a timezone. - -
-
Name
-
lastUpdatedOnDateTime
-
- - - -
-
Characteristic
-
-
-
-
- Reference -
-
    -
  • https://www.iso.org/iso-8601-date-and-time-format.html
    • -
-
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#date - -
-
-
-
-
- -
-
Example
-
$property.getExampleValue().get().getValue()
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
lastUpdatedOnDateTime
-
- - -
-
- -
-
Allocated Production Outpus
-
- -Planned Production already allocated to the customer. - -
-
Name
-
allocatedProductionOutputs
-
- - - -
-
Characteristic
-
-
-
-
Collection
-
-
-
Has no order
-
-
-
Duplicates not allowed
-
-
-
- Type urn:samm:io.catenax.planned_production:1.0.0#PlannedProductionOutput - -
-
-
-
-
- - -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
allocatedProductionOutputs
-
- - -
-
-
-
-

Quantity

-
-
- Comprises the number of objects and the unit of measurement for the respective child objects -
- -
-

Properties

-
-
- -
-
Quantity Number
-
- -The number of objects related to the measurement unit - -
-
Name
-
quantityNumber
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#double - -
-
-
-
-
- -
-
Example
-
$property.getExampleValue().get().getValue()
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
quantityNumber
-
- - -
-
- -
-
Unit of Measure
-
- -Unit of measurement for demand quantities. - -
-
Name
-
unitOfMeasure
-
- - - -
-
Characteristic
-
-
-
-
Enumeration
-
-
-
Values
-
-
-
-
    -
-
-
-
-
- Reference -
-
    -
  • https://tfig.unece.org/contents/recommendation-20.htm
    • -
-
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
$property.getExampleValue().get().getValue()
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
unitOfMeasure
-
- - -
-
-
-
-

Reference to Order Position

-
-
- Encapsulates the references to identify a position within an order. -
- -
-

Properties

-
-
- -
-
Supplier Order ID
-
- -This is the order number on the supplier side that is given by e.g., the supplier's enterprise resource planning system. - -
-
Name
-
supplierOrderId
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
$property.getExampleValue().get().getValue()
-
- -
-
Optional
-
- Yes
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
supplierOrderId
-
- - -
-
- -
-
Customer Order ID
-
- -This is the order number on the customer side that can be given by e.g., the customer's enterprise resource planning system. - -
-
Name
-
customerOrderId
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
$property.getExampleValue().get().getValue()
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
customerOrderId
-
- - -
-
- -
-
Customer Order Position ID
-
- -This is an identifier for the position of an order defined by the customer. It's not a technical identifier, such as an UUID. This identifier is used within the business context when talking about the position. - -
-
Name
-
customerOrderPositionId
-
- - - -
-
Characteristic
-
-
-
-
- Type http://www.w3.org/2001/XMLSchema#string - -
-
-
-
-
- -
-
Example
-
$property.getExampleValue().get().getValue()
-
- -
-
Optional
-
- No
-
- -
-
In payload
-
- Yes
-
- -
-
Payload key
-
customerOrderPositionId
-
- - -
-
-
- -
- Third party licenses - -
- -
- - -
- - - \ No newline at end of file diff --git a/io.catenax.planned_production/1.0.0/PlannedProduction.ttl b/io.catenax.planned_production/1.0.0/PlannedProduction.ttl deleted file mode 100644 index 33912d95b..000000000 --- a/io.catenax.planned_production/1.0.0/PlannedProduction.ttl +++ /dev/null @@ -1,189 +0,0 @@ -@prefix samm: . -@prefix samm-c: . -@prefix samm-e: . -@prefix unit: . -@prefix rdf: . -@prefix rdfs: . -@prefix xsd: . -@prefix : . -@prefix ext-demand: . - -:PlannedProduction a samm:Aspect ; - samm:preferredName "Stock of Products of a Supplier"@en ; - samm:description "This aspect represents the latest quantities of a supplier's products that are on stock. The stock represent the build-to-order (BTO) stocks already available for the customer."@en ; - samm:properties ( :positions :materialNumberCustomer [ samm:property :materialNumberCatenaX; samm:optional true ] [ samm:property :materialNumberSupplier; samm:optional true ] ) ; - samm:operations ( ) ; - samm:events ( ) . - -:positions a samm:Property ; - samm:preferredName "Positions"@en ; - samm:description "The positions refer to positions within an order that refer to the given product (see materialNumberSupplier, materialNumberCustomer and materialNumberDataSpace) for which the stocks are transferred. The positions are differentiated by the orderPositionReference."@en ; - samm:characteristic :PositionsCollection . - -:materialNumberCustomer a samm:Property ; - samm:preferredName "Customer Material Number"@en ; - samm:description "Material identifier as assigned by customer. This material number identifies the material (as planned) in customer's database. For standard parts (e.g. screws) for which a customer does not have an own number, the materialNumberSupplier should be set in this field, too."@en ; - samm:characteristic :MaterialNumber ; - samm:exampleValue "MNR-7307-AU340474.002" . - -:materialNumberCatenaX a samm:Property ; - samm:preferredName "Material UUID Used in Catena-X"@en ; - samm:description "Material identifier used uniquely within Catena-X to identify the Material (e.g. PartAsPlanned)."@en ; - samm:characteristic :CatenaXIdTraitCharacteristic ; - samm:exampleValue "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df" . - -:materialNumberSupplier a samm:Property ; - samm:preferredName "Supplier Material Number"@en ; - samm:description "Material identifier as assigned by supplier. This material number identifies the material (as planned) in supplier's database."@en ; - samm:characteristic :MaterialNumber ; - samm:exampleValue "MNR-8101-ID146955.001" . - -:PositionsCollection a samm-c:Collection ; - samm:preferredName "Positions Collection"@en ; - samm:description "If any stock is available, then there is at least one position. If the supplier does differentiate the stock according to the order positions (an OrderPositionReference is set), then multiple positions can be given. There could also be only one position without an OrderPositionReference indicating an anonymous stock which is allocated to the customer."@en ; - samm:dataType :Position . - -:MaterialNumber 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 . - -:CatenaXIdTraitCharacteristic a samm-c:Trait ; - samm:preferredName "Catena-X ID Trait"@en ; - samm:description "Trait to ensure UUID v4 data format"@en ; - samm-c:baseCharacteristic :Uuidv4Characteristic ; - samm-c:constraint :Uuidv4RegularExpression . - -:Position a samm:Entity ; - samm:preferredName "Position"@en ; - samm:description "The Position can be located at several stocks. A position may be anonymous or may reference an position within an order."@en ; - samm:properties ( [ samm:property :orderPositionReference; samm:optional true ] :lastUpdatedOnDateTime :allocatedProductionOutputs ) . - -:Uuidv4Characteristic a samm:Characteristic ; - samm:preferredName "UUID v4"@en ; - samm:description "A version 4 UUID is a universally unique identifier that is generated using random 32 hexadecimal characters."@en ; - samm:see ; - samm:dataType xsd:string . - -:Uuidv4RegularExpression a samm-c:RegularExpressionConstraint ; - samm:preferredName "Catena-X ID Regular Expression"@en ; - samm:description "The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by \"urn:uuid:\" to make it an IRI."@en ; - samm:see ; - samm:value "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)" . - -:orderPositionReference a samm:Property ; - samm:preferredName "Order Position Reference"@en ; - samm:description "The order position reference contains information to identify a position within an order."@en ; - samm:characteristic :OrderPositionReferenceCharacteristic . - -:lastUpdatedOnDateTime a samm:Property ; - samm:preferredName "Lasted Updated on Date"@en ; - samm:description "Date and time at which the position has been updated by the supplier's systems. Date and time are set according to a timezone."@en ; - samm:characteristic :DateTimeStamp ; - samm:exampleValue "2023-04-01T14:23:00+01:00"^^xsd:date . - -:allocatedProductionOutputs a samm:Property ; - samm:preferredName "Allocated Production Outpus"@en ; - samm:description "Planned Production already allocated to the customer."@en ; - samm:characteristic :AllocatedProductionOutputCollection . - -:OrderPositionReferenceCharacteristic a samm:Characteristic ; - samm:preferredName "Order Position Reference Characteristic"@en ; - samm:description "The order position reference includes reference numbers for the order and the ID. As these information are meant for the customer, the customer reference numbers are mandatory."@en ; - samm:dataType :OrderPositionReference . - -:DateTimeStamp a samm:Characteristic ; - samm:preferredName "Date Time Stamp Characteristic"@en ; - samm:description "The Date with the timezone of the involved site."@en ; - samm:see ; - samm:dataType xsd:date . - -:AllocatedProductionOutputCollection a samm-c:Collection ; - samm:preferredName "Allocated Production Output Collection"@en ; - samm:description "Collection of PlannedProductionOutputs that may relate to different production locations and estimated time of completions."@en ; - samm:dataType :PlannedProductionOutput . - -:OrderPositionReference a samm:Entity ; - samm:preferredName "Reference to Order Position"@en ; - samm:description "Encapsulates the references to identify a position within an order."@en ; - samm:properties ( [ samm:property :supplierOrderId; samm:optional true ] :customerOrderId :customerOrderPositionId ) . - -:PlannedProductionOutput a samm:Entity ; - samm:preferredName "Planned Production Output"@en ; - samm:description "Quantity, site of the supplier and date with time at which a production of a certain material for a certain customer is planned to be finished."@en ; - samm:properties ( :plannedProductionQuantity :productionSiteBpns :estimatedTimeOfCompletion ) . - -:supplierOrderId a samm:Property ; - samm:preferredName "Supplier Order ID"@en ; - samm:description "This is the order number on the supplier side that is given by e.g., the supplier's enterprise resource planning system."@en ; - samm:characteristic :OrderIdCharacteristic ; - samm:exampleValue "M-Nbr-4711" . - -:customerOrderId a samm:Property ; - samm:preferredName "Customer Order ID"@en ; - samm:description "This is the order number on the customer side that can be given by e.g., the customer's enterprise resource planning system."@en ; - samm:characteristic :OrderIdCharacteristic ; - samm:exampleValue "C-Nbr-4711" . - -:customerOrderPositionId a samm:Property ; - samm:preferredName "Customer Order Position ID"@en ; - samm:description "This is an identifier for the position of an order defined by the customer. It's not a technical identifier, such as an UUID. This identifier is used within the business context when talking about the position."@en ; - samm:characteristic :OrderPositionIdCharacteristic ; - samm:exampleValue "PositionId-01" . - -:plannedProductionQuantity a samm:Property ; - samm:preferredName "Planned Production Quantity"@en ; - samm:description """Quantity of a product that a supplier plans to produce on a certain date and time for a specific customer (that is: that will be allocated in a specific customer's \"allocated product stock\"). -Quantities already produced are put on stock or delivered. Therefore those quantities MUST NOT be considered in the allocated production output to build a consistent view on the supply situation. """@en ; - samm:characteristic :QuantityCharacteristic . - -:productionSiteBpns a samm:Property ; - samm:preferredName "BPNS of Supplier's Production Location"@en ; - samm:description "One PlannedProductionOutput has always one site. The location is identified using BPNS."@en ; - samm:see ; - samm:characteristic ext-demand:BPNSTrait ; - samm:exampleValue "BPNS0123456789ZZ" . - -:estimatedTimeOfCompletion a samm:Property ; - samm:preferredName "Estimated Time of Completion"@en ; - samm:description "Date and time on which the allocated production output is planned to be completed. Date and time are set according to a timezone of the supplier's production site."@en ; - samm:characteristic :DateTimeStamp ; - samm:exampleValue "2023-04-01T14:23:00+01:00"^^xsd:date . - -:OrderIdCharacteristic a samm:Characteristic ; - samm:preferredName "Order ID Characteristic"@en ; - samm:description "This is a proprietary order ID, generated by either the supplier side or customer side."@en ; - samm:dataType xsd:string . - -:OrderPositionIdCharacteristic a samm:Characteristic ; - samm:preferredName "Position ID within Order"@en ; - samm:description "The position ID is unique for an order and used within business context to refer to a position."@en ; - samm:dataType xsd:string . - -:QuantityCharacteristic a samm-c:Quantifiable ; - samm:preferredName "Quantity Characteristic"@en ; - samm:description "Describes the quantity in which the child part is assembled in the given parent object by providing a quantity value and the measurement unit in which the quantity is measured."@en ; - samm:dataType :Quantity . - -:Quantity a samm:Entity ; - samm:preferredName "Quantity"@en ; - samm:description "Comprises the number of objects and the unit of measurement for the respective child objects"@en ; - samm:properties ( :quantityNumber ext-demand:unitOfMeasure ) . - -:quantityNumber a samm:Property ; - samm:preferredName "Quantity Number"@en ; - samm:description "The number of objects related to the measurement unit"@en ; - samm:characteristic :NumberofObjects ; - samm:exampleValue "2.5"^^xsd:double . - -:NumberofObjects a samm:Characteristic ; - samm:preferredName "Number of Objects"@en ; - samm:description "Quantifiable number of objects in reference to the measurementUnit"@en ; - samm:dataType xsd:double . - -:BpnsCharacteristic a samm:Characteristic ; - samm:preferredName "BPNS Characteristic"@en ; - samm:description "TODO Tom"@en ; - samm:see ; - samm:dataType xsd:string . - diff --git a/io.catenax.planned_production/1.0.0/metadata.json b/io.catenax.planned_production/1.0.0/metadata.json deleted file mode 100644 index e2a5a0225..000000000 --- a/io.catenax.planned_production/1.0.0/metadata.json +++ /dev/null @@ -1 +0,0 @@ -{ "status" : "draft"} diff --git a/io.catenax.planned_production/RELEASE_NOTES.md b/io.catenax.planned_production/RELEASE_NOTES.md deleted file mode 100644 index 5b6b26a56..000000000 --- a/io.catenax.planned_production/RELEASE_NOTES.md +++ /dev/null @@ -1,7 +0,0 @@ -# Changelog -All notable changes to this model will be documented in this file. - -## [Unreleased] -### Added -- initial model - From 1dca1d698b64b4f992249a74cd33b702c44481d0 Mon Sep 17 00:00:00 2001 From: --show-origin Date: Wed, 6 Sep 2023 07:44:04 -0700 Subject: [PATCH 10/21] fix: resolved todo, fixed Catena-X typo and empty unit of measure --- .../1.0.0/PlannedProductionOutput.ttl | 27 ++++++++++--------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl index 0deb1fc90..f01e16122 100644 --- a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl +++ b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl @@ -9,7 +9,7 @@ :PlannedProductionOutput a samm:Aspect; samm:preferredName "Planned Production Output of a Supplier"@en; - samm:description "This aspect represents the remaining and planned production output of a supplier. A planned production output is described by a quantity, the site of the supplier and the date with time at which a production of a certain material for a certain customer is planned to be finished. TODO: check if positions need to be considered somehow?"@en; + samm:description "This aspect represents the remaining and planned production outputs of a supplier allocated to a customer. An allocated planned production output is described by a quantity, the site of the supplier and the date with time at which a production of a certain material for a certain customer is planned to be finished. The allocated planned production outputs may be linked to customer order position they have been scheduled for."@en; samm:properties (:positions :materialNumberCustomer [ samm:property :materialNumberCatenaX; samm:optional "true"^^xsd:boolean @@ -21,7 +21,7 @@ samm:events (). :positions a samm:Property; samm:preferredName "Positions"@en; - samm:description "The positions refer to positions within an order of the given product (see material number supplier, materialNumber customer and material number Catena-x) for which the production outputs are transferred. The positions can be differentiated by the order position reference. If no order position reference is given, then there is only one position containing all planned production outputs of the product."@en; + samm:description "The positions refer to positions within an order of the given product (see material number supplier, materialNumber customer and material number Catena-X) for which the production outputs are transferred. The positions can be differentiated by the order position reference. If no order position reference is given, then there is only one position containing all planned production outputs of the product."@en; samm:characteristic :PositionsCollection. :materialNumberCustomer a samm:Property; samm:preferredName "Customer Material Number"@en; @@ -147,10 +147,20 @@ samm:preferredName "Quantity Characteristic"@en; samm:description "Describes the quantity and the unit of measure with which the planned and allocated production output is measured."@en; samm:dataType :Quantity. +:BPNSTrait a samm-c:Trait; + samm:preferredName "BPNS Trait"@en; + samm:description "Trait to ensure data format for BPNS."@en; + samm-c:baseCharacteristic :BPNS; + samm-c:constraint :BPNSRegularExpression. :Quantity a samm:Entity; samm:preferredName "Quantity"@en; samm:description "Comprises the number of objects and the unit of measurement."@en; samm:properties (:quantityNumber :unitOfMeasure). +:quantityNumber a samm:Property; + samm:preferredName "Quantity Number"@en; + samm:description "The number of objects related to the unit of measure."@en; + samm:characteristic :NumberofObjects; + samm:exampleValue "2.5"^^xsd:double. :unitOfMeasure a samm:Property; samm:preferredName "Unit of Measure"@en; samm:description "Unit of measurement for demand quantities."@en; @@ -161,21 +171,11 @@ samm:description "The Enumeration lists a selection of allowed units of measure referenced by their official code according to Codes for Units of Measure Used in International Trade"@en; samm:dataType xsd:string; samm:see ; - samm-c:values ("GRM" "KGM" "TNE" "STN" "ONZ" "LBR" "CMT" "MTR" "KTM" "INH" "FOT" "YRD" "CMK" "MTK" "INK" "FTK" "YDK" "CMQ" "MTQ" "INQ" "FTQ" "YDQ" "MLT" "LTR" "HLT" "H87" "SET" "PR" "ZP" "KWH" ""). -:quantityNumber a samm:Property; - samm:preferredName "Quantity Number"@en; - samm:description "The number of objects related to the unit of measure."@en; - samm:characteristic :NumberofObjects; - samm:exampleValue "2.5"^^xsd:double. + samm-c:values ("GRM" "KGM" "TNE" "STN" "ONZ" "LBR" "CMT" "MTR" "KTM" "INH" "FOT" "YRD" "CMK" "MTK" "INK" "FTK" "YDK" "CMQ" "MTQ" "INQ" "FTQ" "YDQ" "MLT" "LTR" "HLT" "H87" "SET" "PR" "ZP" "KWH"). :NumberofObjects a samm:Characteristic; samm:preferredName "Number of Objects"@en; samm:description "Quantifiable number of objects in reference to the unit of measure."@en; samm:dataType xsd:double. -:BPNSTrait a samm-c:Trait; - samm:preferredName "BPNS Trait"@en; - samm:description "Trait to ensure data format for BPNS."@en; - samm-c:baseCharacteristic :BPNS; - samm-c:constraint :BPNSRegularExpression. :BPNS a samm:Characteristic; samm:preferredName "Business Partner Number Site"@en; samm:description "BPNS represents a site which can be a production plant inside one location."@en; @@ -184,3 +184,4 @@ samm:preferredName "BPNS Regular Expression"@en; samm:description "The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two uppercase letters."@en; samm:value "^BPNS[0-9]{8}[a-zA-Z0-9]{4}$". + From 1342b5c4c9ec71472f0b11f318f5db26839278b5 Mon Sep 17 00:00:00 2001 From: --show-origin Date: Mon, 11 Sep 2023 02:21:30 -0700 Subject: [PATCH 11/21] chore: added license header --- .../1.0.0/PlannedProductionOutput.ttl | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl index f01e16122..65243fbc0 100644 --- a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl +++ b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl @@ -1,3 +1,20 @@ +####################################################################### +# 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: . From 1e2af5d79163b7ebe49f65e4981c1aabdfe386e2 Mon Sep 17 00:00:00 2001 From: --show-origin Date: Mon, 11 Sep 2023 08:37:22 -0700 Subject: [PATCH 12/21] feat: used shared aspects for BPNS and UUID --- .../1.0.0/PlannedProductionOutput.ttl | 60 +++---------------- 1 file changed, 8 insertions(+), 52 deletions(-) diff --git a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl index 65243fbc0..0e04d0f32 100644 --- a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl +++ b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl @@ -1,20 +1,3 @@ -####################################################################### -# 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: . @@ -23,6 +6,8 @@ @prefix rdfs: . @prefix xsd: . @prefix : . +@prefix ext-uuid: . +@prefix ext-number: . :PlannedProductionOutput a samm:Aspect; samm:preferredName "Planned Production Output of a Supplier"@en; @@ -48,7 +33,7 @@ :materialNumberCatenaX a samm:Property; samm:preferredName "Material UUID Used in Catena-X"@en; samm:description "Material identifier used uniquely within Catena-X to identify the material (e.g. PartAsPlanned)."@en; - samm:characteristic :CatenaXIdTraitCharacteristic; + samm:characteristic ext-uuid:UuidV4Trait; samm:exampleValue "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df". :materialNumberSupplier a samm:Property; samm:preferredName "Supplier Material Number"@en; @@ -63,11 +48,6 @@ 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. -:CatenaXIdTraitCharacteristic a samm-c:Trait; - samm:preferredName "Catena-X ID Trait"@en; - samm:description "Trait to ensure UUID v4 data format."@en; - samm-c:baseCharacteristic :Uuidv4Characteristic; - samm-c:constraint :Uuidv4RegularExpression. :Position a samm:Entity; samm:preferredName "Position"@en; samm:description "The Position can be planned for production at several sites. A position may be anonymous or may reference an position within an order."@en; @@ -75,16 +55,6 @@ samm:property :orderPositionReference; samm:optional "true"^^xsd:boolean ] :lastUpdatedOnDateTime :allocatedPlannedProductionOutputs). -:Uuidv4Characteristic a samm:Characteristic; - samm:preferredName "UUID v4"@en; - samm:description "A version 4 UUID is a universally unique identifier that is generated using random 32 hexadecimal characters."@en; - samm:dataType xsd:string; - samm:see . -:Uuidv4RegularExpression a samm-c:RegularExpressionConstraint; - samm:preferredName "Catena-X ID Regular Expression"@en; - samm:description "The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by \"urn:uuid:\" to make it an IRI."@en; - samm:see ; - samm:value "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)". :orderPositionReference a samm:Property; samm:preferredName "Order Position Reference"@en; samm:description "The order position reference contains information to identify a position within an order."@en; @@ -144,7 +114,7 @@ :productionSiteBpns a samm:Property; samm:preferredName "BPNS of Supplier's Production Site"@en; samm:description "One planned and alllocated production output has always one site. The site is identified by the BPNS."@en; - samm:characteristic :BPNSTrait; + samm:characteristic ext-number:BpnsTrait; samm:exampleValue "BPNS0123456789ZZ"; samm:see . :estimatedTimeOfCompletion a samm:Property; @@ -164,11 +134,6 @@ samm:preferredName "Quantity Characteristic"@en; samm:description "Describes the quantity and the unit of measure with which the planned and allocated production output is measured."@en; samm:dataType :Quantity. -:BPNSTrait a samm-c:Trait; - samm:preferredName "BPNS Trait"@en; - samm:description "Trait to ensure data format for BPNS."@en; - samm-c:baseCharacteristic :BPNS; - samm-c:constraint :BPNSRegularExpression. :Quantity a samm:Entity; samm:preferredName "Quantity"@en; samm:description "Comprises the number of objects and the unit of measurement."@en; @@ -183,22 +148,13 @@ samm:description "Unit of measurement for demand quantities."@en; samm:characteristic :UnitOfMeasure; samm:exampleValue "KGM". +:NumberofObjects a samm:Characteristic; + samm:preferredName "Number of Objects"@en; + samm:description "Quantifiable number of objects in reference to the unit of measure."@en; + samm:dataType xsd:double. :UnitOfMeasure a samm-c:Enumeration; samm:preferredName "Unit of Measure"@en; samm:description "The Enumeration lists a selection of allowed units of measure referenced by their official code according to Codes for Units of Measure Used in International Trade"@en; samm:dataType xsd:string; samm:see ; samm-c:values ("GRM" "KGM" "TNE" "STN" "ONZ" "LBR" "CMT" "MTR" "KTM" "INH" "FOT" "YRD" "CMK" "MTK" "INK" "FTK" "YDK" "CMQ" "MTQ" "INQ" "FTQ" "YDQ" "MLT" "LTR" "HLT" "H87" "SET" "PR" "ZP" "KWH"). -:NumberofObjects a samm:Characteristic; - samm:preferredName "Number of Objects"@en; - samm:description "Quantifiable number of objects in reference to the unit of measure."@en; - samm:dataType xsd:double. -:BPNS a samm:Characteristic; - samm:preferredName "Business Partner Number Site"@en; - samm:description "BPNS represents a site which can be a production plant inside one location."@en; - samm:dataType xsd:string. -:BPNSRegularExpression a samm-c:RegularExpressionConstraint; - samm:preferredName "BPNS Regular Expression"@en; - samm:description "The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two uppercase letters."@en; - samm:value "^BPNS[0-9]{8}[a-zA-Z0-9]{4}$". - From 640209e5e4c5bc083ca1fad1ff2723af3e1d223e Mon Sep 17 00:00:00 2001 From: --show-origin Date: Thu, 28 Sep 2023 10:24:40 -0700 Subject: [PATCH 13/21] feat: added shared uom / quantity --- .../1.0.0/PlannedProductionOutput.ttl | 27 ++----------------- 1 file changed, 2 insertions(+), 25 deletions(-) diff --git a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl index 0e04d0f32..a3b09c39f 100644 --- a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl +++ b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl @@ -8,6 +8,7 @@ @prefix : . @prefix ext-uuid: . @prefix ext-number: . +@prefix ext-quantity: . :PlannedProductionOutput a samm:Aspect; samm:preferredName "Planned Production Output of a Supplier"@en; @@ -133,28 +134,4 @@ :QuantityCharacteristic a samm-c:Quantifiable; samm:preferredName "Quantity Characteristic"@en; samm:description "Describes the quantity and the unit of measure with which the planned and allocated production output is measured."@en; - samm:dataType :Quantity. -:Quantity a samm:Entity; - samm:preferredName "Quantity"@en; - samm:description "Comprises the number of objects and the unit of measurement."@en; - samm:properties (:quantityNumber :unitOfMeasure). -:quantityNumber a samm:Property; - samm:preferredName "Quantity Number"@en; - samm:description "The number of objects related to the unit of measure."@en; - samm:characteristic :NumberofObjects; - samm:exampleValue "2.5"^^xsd:double. -:unitOfMeasure a samm:Property; - samm:preferredName "Unit of Measure"@en; - samm:description "Unit of measurement for demand quantities."@en; - samm:characteristic :UnitOfMeasure; - samm:exampleValue "KGM". -:NumberofObjects a samm:Characteristic; - samm:preferredName "Number of Objects"@en; - samm:description "Quantifiable number of objects in reference to the unit of measure."@en; - samm:dataType xsd:double. -:UnitOfMeasure a samm-c:Enumeration; - samm:preferredName "Unit of Measure"@en; - samm:description "The Enumeration lists a selection of allowed units of measure referenced by their official code according to Codes for Units of Measure Used in International Trade"@en; - samm:dataType xsd:string; - samm:see ; - samm-c:values ("GRM" "KGM" "TNE" "STN" "ONZ" "LBR" "CMT" "MTR" "KTM" "INH" "FOT" "YRD" "CMK" "MTK" "INK" "FTK" "YDK" "CMQ" "MTQ" "INQ" "FTQ" "YDQ" "MLT" "LTR" "HLT" "H87" "SET" "PR" "ZP" "KWH"). + samm:dataType ext-quantity:ItemQuantityEntity. From 0f66c5bb603f202a69b71a65419dccec3578cc7f Mon Sep 17 00:00:00 2001 From: --show-origin Date: Thu, 28 Sep 2023 10:25:37 -0700 Subject: [PATCH 14/21] chore: updated release information --- io.catenax.planned_production_output/1.0.0/metadata.json | 2 +- io.catenax.planned_production_output/RELEASE_NOTES.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/io.catenax.planned_production_output/1.0.0/metadata.json b/io.catenax.planned_production_output/1.0.0/metadata.json index e2a5a0225..c22749aed 100644 --- a/io.catenax.planned_production_output/1.0.0/metadata.json +++ b/io.catenax.planned_production_output/1.0.0/metadata.json @@ -1 +1 @@ -{ "status" : "draft"} +{ "status" : "release"} diff --git a/io.catenax.planned_production_output/RELEASE_NOTES.md b/io.catenax.planned_production_output/RELEASE_NOTES.md index 5b6b26a56..b58b8affb 100644 --- a/io.catenax.planned_production_output/RELEASE_NOTES.md +++ b/io.catenax.planned_production_output/RELEASE_NOTES.md @@ -1,7 +1,7 @@ # Changelog All notable changes to this model will be documented in this file. -## [Unreleased] +## [1.0.0] - 2023-10-09 ### Added - initial model From 667baccab2109ac3555c3d5586b988686c6aa261 Mon Sep 17 00:00:00 2001 From: --show-origin Date: Thu, 28 Sep 2023 22:56:59 -0700 Subject: [PATCH 15/21] chore: added missing license header --- .../1.0.0/PlannedProductionOutput.ttl | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl index a3b09c39f..49f9be61f 100644 --- a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl +++ b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl @@ -1,3 +1,20 @@ +####################################################################### +# 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: . From a38cae84db18a426377cfb2d5e35b3534742ea23 Mon Sep 17 00:00:00 2001 From: --show-origin Date: Fri, 3 Nov 2023 06:51:04 -0700 Subject: [PATCH 16/21] fix: corrected typos --- .../1.0.0/PlannedProductionOutput.ttl | 41 ++++++------------- 1 file changed, 12 insertions(+), 29 deletions(-) diff --git a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl index 49f9be61f..f91953a27 100644 --- a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl +++ b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl @@ -1,20 +1,3 @@ -####################################################################### -# 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: . @@ -31,7 +14,7 @@ samm:preferredName "Planned Production Output of a Supplier"@en; samm:description "This aspect represents the remaining and planned production outputs of a supplier allocated to a customer. An allocated planned production output is described by a quantity, the site of the supplier and the date with time at which a production of a certain material for a certain customer is planned to be finished. The allocated planned production outputs may be linked to customer order position they have been scheduled for."@en; samm:properties (:positions :materialNumberCustomer [ - samm:property :materialNumberCatenaX; + samm:property :materialGlobalAssetId; samm:optional "true"^^xsd:boolean ] [ samm:property :materialNumberSupplier; @@ -41,34 +24,29 @@ samm:events (). :positions a samm:Property; samm:preferredName "Positions"@en; - samm:description "The positions refer to positions within an order of the given product (see material number supplier, materialNumber customer and material number Catena-X) for which the production outputs are transferred. The positions can be differentiated by the order position reference. If no order position reference is given, then there is only one position containing all planned production outputs of the product."@en; + samm:description "The positions refer to positions within an order of the given product (see material number supplier, materialNumber customer and material global Asset Id) for which the production outputs are transferred. The positions can be differentiated by the order position reference. If no order position reference is given, then there is only one position containing all planned production outputs of the product."@en; samm:characteristic :PositionsCollection. :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 planned) 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 :MaterialNumber; + samm:characteristic :MaterialNumberCharacteristic; samm:exampleValue "MNR-7307-AU340474.002". -:materialNumberCatenaX a samm:Property; - samm:preferredName "Material UUID Used in Catena-X"@en; - samm:description "Material identifier used uniquely within Catena-X to identify the material (e.g. PartAsPlanned)."@en; - samm:characteristic ext-uuid:UuidV4Trait; - samm:exampleValue "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df". :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 planned) in the supplier's database."@en; - samm:characteristic :MaterialNumber; + samm:characteristic :MaterialNumberCharacteristic; samm:exampleValue "MNR-8101-ID146955.001". :PositionsCollection a samm-c:Collection; samm:preferredName "Positions Collection"@en; samm:description "If any production for the customer is planned, then there is at least one position. If the supplier does differentiate the planned production according to the order positions (an OrderPositionReference is set), then multiple positions can be given. Among the positions, there could be only one position without an OrderPositionReference to either report the planned production independently of orders or to report internal stock orders planned for the customer."@en; samm:dataType :Position. -:MaterialNumber a samm:Characteristic; +: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. :Position a samm:Entity; samm:preferredName "Position"@en; - samm:description "The Position can be planned for production at several sites. A position may be anonymous or may reference an position within an order."@en; + samm:description "The Position can be planned for production at several sites. A position may be anonymous or may reference a position within an order."@en; samm:properties ([ samm:property :orderPositionReference; samm:optional "true"^^xsd:boolean @@ -83,7 +61,7 @@ samm:characteristic :DateTimeStamp; samm:exampleValue "2023-04-01T14:23:00+01:00"^^xsd:date. :allocatedPlannedProductionOutputs a samm:Property; - samm:preferredName "Planned and Allocated Production Outpus"@en; + samm:preferredName "Planned and Allocated Production Outputs"@en; samm:description "Planned Production Outputs already allocated to the customer."@en; samm:characteristic :AllocatedPlannedProductionOutputCollection. :OrderPositionReferenceCharacteristic a samm:Characteristic; @@ -152,3 +130,8 @@ samm:preferredName "Quantity Characteristic"@en; samm:description "Describes the quantity and the unit of measure with which the planned and allocated production output is measured."@en; samm:dataType ext-quantity:ItemQuantityEntity. +:materialGlobalAssetId a samm:Property; + samm:preferredName "Material Number UUID of the Customer's Twin"@en; + samm:description "Material identifier used uniquely to identify the Material (e.g. PartAsPlanned)."@en; + samm:characteristic ext-uuid:UuidV4Trait; + samm:exampleValue "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df". From a3b6e976a198bd46d0c5401d1301e88c14d0cf0d Mon Sep 17 00:00:00 2001 From: --show-origin Date: Fri, 3 Nov 2023 06:57:02 -0700 Subject: [PATCH 17/21] feat: updated semantic for planned production --- .../1.0.0/PlannedProductionOutput.ttl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl index f91953a27..8dd6d8578 100644 --- a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl +++ b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl @@ -105,7 +105,7 @@ samm:exampleValue "PositionId-01". :plannedProductionQuantity a samm:Property; samm:preferredName "Planned Production Quantity"@en; - samm:description "Quantity of a product that a supplier plans to produce on a certain date and time for a specific customer (that is: that will be allocated in a specific customer's \"allocated product stock\").\nQuantities that have already been produced are put on stock or delivered. Therefore those quantities MUST NOT be considered in the allocated production output to build a consistent view on the supply situation. "@en; + samm:description "Quantity of a product that a supplier plans to produce on a certain date and time for a specific customer (that means that it will be allocated to a specific customer's \"allocated item stock\").\nQuantities that have already been produced are put on stock or are considered for delivery. Therefore those quantities MUST NOT be considered in the allocated production output to build a consistent view on the supply situation. "@en; samm:characteristic :QuantityCharacteristic. :productionSiteBpns a samm:Property; samm:preferredName "BPNS of Supplier's Production Site"@en; From 541454431c67f06fa6c12205521d89b2be9991e9 Mon Sep 17 00:00:00 2001 From: --show-origin Date: Mon, 13 Nov 2023 05:15:16 -0800 Subject: [PATCH 18/21] chore: added missing license header and updated release notes --- .../1.0.0/PlannedProductionOutput.ttl | 17 +++++++++++++++++ .../RELEASE_NOTES.md | 2 +- 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl index 8dd6d8578..2ff095e98 100644 --- a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl +++ b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl @@ -1,3 +1,20 @@ +####################################################################### +# 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: . diff --git a/io.catenax.planned_production_output/RELEASE_NOTES.md b/io.catenax.planned_production_output/RELEASE_NOTES.md index b58b8affb..90eba1101 100644 --- a/io.catenax.planned_production_output/RELEASE_NOTES.md +++ b/io.catenax.planned_production_output/RELEASE_NOTES.md @@ -1,7 +1,7 @@ # Changelog All notable changes to this model will be documented in this file. -## [1.0.0] - 2023-10-09 +## [1.0.0] - 2023-11-13 ### Added - initial model From b056140d36647369a752f2fadfeb383caf1f2022 Mon Sep 17 00:00:00 2001 From: --show-origin Date: Wed, 15 Nov 2023 05:12:10 -0800 Subject: [PATCH 19/21] fix: incorporated review for MS2 --- .../1.0.0/PlannedProductionOutput.ttl | 162 +++--------------- .../RELEASE_NOTES.md | 2 +- 2 files changed, 26 insertions(+), 138 deletions(-) diff --git a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl index 2ff095e98..19cabacaa 100644 --- a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl +++ b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl @@ -15,140 +15,28 @@ # # 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-uuid: . -@prefix ext-number: . -@prefix ext-quantity: . - -:PlannedProductionOutput a samm:Aspect; - samm:preferredName "Planned Production Output of a Supplier"@en; - samm:description "This aspect represents the remaining and planned production outputs of a supplier allocated to a customer. An allocated planned production output is described by a quantity, the site of the supplier and the date with time at which a production of a certain material for a certain customer is planned to be finished. The allocated planned production outputs may be linked to customer order position they have been scheduled for."@en; - samm:properties (:positions :materialNumberCustomer [ - samm:property :materialGlobalAssetId; - samm:optional "true"^^xsd:boolean -] [ - samm:property :materialNumberSupplier; - samm:optional "true"^^xsd:boolean -]); - samm:operations (); - samm:events (). -:positions a samm:Property; - samm:preferredName "Positions"@en; - samm:description "The positions refer to positions within an order of the given product (see material number supplier, materialNumber customer and material global Asset Id) for which the production outputs are transferred. The positions can be differentiated by the order position reference. If no order position reference is given, then there is only one position containing all planned production outputs of the product."@en; - samm:characteristic :PositionsCollection. -: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 planned) 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". -: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 planned) in the supplier's database."@en; - samm:characteristic :MaterialNumberCharacteristic; - samm:exampleValue "MNR-8101-ID146955.001". -:PositionsCollection a samm-c:Collection; - samm:preferredName "Positions Collection"@en; - samm:description "If any production for the customer is planned, then there is at least one position. If the supplier does differentiate the planned production according to the order positions (an OrderPositionReference is set), then multiple positions can be given. Among the positions, there could be only one position without an OrderPositionReference to either report the planned production independently of orders or to report internal stock orders planned for the customer."@en; - samm:dataType :Position. -: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. -:Position a samm:Entity; - samm:preferredName "Position"@en; - samm:description "The Position can be planned for production at several sites. A position may be anonymous or may reference a position within an order."@en; - samm:properties ([ - samm:property :orderPositionReference; - samm:optional "true"^^xsd:boolean -] :lastUpdatedOnDateTime :allocatedPlannedProductionOutputs). -:orderPositionReference a samm:Property; - samm:preferredName "Order Position Reference"@en; - samm:description "The order position reference contains information to identify a position within an order."@en; - samm:characteristic :OrderPositionReferenceCharacteristic. -:lastUpdatedOnDateTime a samm:Property; - samm:preferredName "Lasted Updated on Date"@en; - samm:description "Date and time at which the position has been updated by the supplier's systems. Date and time are set according to the timezone."@en; - samm:characteristic :DateTimeStamp; - samm:exampleValue "2023-04-01T14:23:00+01:00"^^xsd:date. -:allocatedPlannedProductionOutputs a samm:Property; - samm:preferredName "Planned and Allocated Production Outputs"@en; - samm:description "Planned Production Outputs already allocated to the customer."@en; - samm:characteristic :AllocatedPlannedProductionOutputCollection. -:OrderPositionReferenceCharacteristic a samm:Characteristic; - samm:preferredName "Order Position Reference Characteristic"@en; - samm:description "The order position reference includes reference numbers for the order and the position. As these information are meant for the customer, the customer reference numbers are mandatory."@en; - samm:dataType :OrderPositionReference. -:DateTimeStamp a samm:Characteristic; - samm:preferredName "Date Time Stamp Characteristic"@en; - samm:description "The Date with the timezone."@en; - samm:dataType xsd:date; - samm:see . -:AllocatedPlannedProductionOutputCollection a samm-c:Collection; - samm:preferredName "Planned and Allocated Production Output Collection"@en; - samm:description "Collection of planned and allocated production outputs that may relate to different production locations and estimated time of completions."@en; - samm:dataType :AllocatedPlannedProductionOutput. -:OrderPositionReference a samm:Entity; - samm:preferredName "Reference to Order Position"@en; - samm:description "Encapsulates the references to identify a position within an order."@en; - samm:properties ([ - samm:property :supplierOrderId; - samm:optional "true"^^xsd:boolean -] :customerOrderId :customerOrderPositionId). -:AllocatedPlannedProductionOutput a samm:Entity; - samm:preferredName "Planned and Allocated Production Output"@en; - samm:description "Quantity, site of the supplier and date with time at which a production of a certain material for a certain customer is planned to be finished."@en; - samm:properties (:plannedProductionQuantity :productionSiteBpns :estimatedTimeOfCompletion). -:supplierOrderId a samm:Property; - samm:preferredName "Supplier Order ID"@en; - samm:description "This is the order number on the supplier side that is given by e.g., the supplier's enterprise resource planning system."@en; - samm:characteristic :OrderIdCharacteristic; - samm:exampleValue "M-Nbr-4711". -:customerOrderId a samm:Property; - samm:preferredName "Customer Order ID"@en; - samm:description "This is the order number on the customer side that can be given by e.g., the customer's enterprise resource planning system."@en; - samm:characteristic :OrderIdCharacteristic; - samm:exampleValue "C-Nbr-4711". -:customerOrderPositionId a samm:Property; - samm:preferredName "Customer Order Position ID"@en; - samm:description "This is an identifier for the position of an order defined by the customer. It's not a technical identifier, such as an UUID. This identifier is used within the business context when talking about the position."@en; - samm:characteristic :OrderPositionIdCharacteristic; - samm:exampleValue "PositionId-01". -:plannedProductionQuantity a samm:Property; - samm:preferredName "Planned Production Quantity"@en; - samm:description "Quantity of a product that a supplier plans to produce on a certain date and time for a specific customer (that means that it will be allocated to a specific customer's \"allocated item stock\").\nQuantities that have already been produced are put on stock or are considered for delivery. Therefore those quantities MUST NOT be considered in the allocated production output to build a consistent view on the supply situation. "@en; - samm:characteristic :QuantityCharacteristic. -:productionSiteBpns a samm:Property; - samm:preferredName "BPNS of Supplier's Production Site"@en; - samm:description "One planned and alllocated production output has always one site. The site is identified by the BPNS."@en; - samm:characteristic ext-number:BpnsTrait; - samm:exampleValue "BPNS0123456789ZZ"; - samm:see . -:estimatedTimeOfCompletion a samm:Property; - samm:preferredName "Estimated Time of Completion"@en; - samm:description "Date and time on which the planned and allocated production output is estimated to be completed. Date and time are set according to a timezone."@en; - samm:characteristic :DateTimeStamp; - samm:exampleValue "2023-04-01T14:23:00+01:00"^^xsd:date. -:OrderIdCharacteristic a samm:Characteristic; - samm:preferredName "Order ID Characteristic"@en; - samm:description "This is a proprietary order ID, generated by either the supplier side or customer side."@en; - samm:dataType xsd:string. -:OrderPositionIdCharacteristic a samm:Characteristic; - samm:preferredName "Position ID within Order"@en; - samm:description "The position ID is unique for an order and used within business context to refer to a position."@en; - samm:dataType xsd:string. -:QuantityCharacteristic a samm-c:Quantifiable; - samm:preferredName "Quantity Characteristic"@en; - samm:description "Describes the quantity and the unit of measure with which the planned and allocated production output is measured."@en; - samm:dataType ext-quantity:ItemQuantityEntity. -:materialGlobalAssetId a samm:Property; - samm:preferredName "Material Number UUID of the Customer's Twin"@en; - samm:description "Material identifier used uniquely to identify the Material (e.g. PartAsPlanned)."@en; - samm:characteristic ext-uuid:UuidV4Trait; - samm:exampleValue "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df". +{ + "positions": [ + { + "lastUpdatedOnDateTime": "2023-04-01T14:23:00+01:00", + "orderPositionReference": { + "supplierOrderId": "M-Nbr-4711", + "customerOrderId": "C-Nbr-4711", + "customerOrderPositionId": "PositionId-01" + }, + "allocatedPlannedProductionOutputs": [ + { + "plannedProductionQuantity": { + "value": 20.5, + "unit": "unit:piece" + }, + "productionSiteBpns": "BPNS0123456789ZZ", + "estimatedTimeOfCompletion": "2023-04-01T14:23:00+01:00" + } + ] + } + ], + "materialGlobalAssetId": "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df", + "materialNumberCustomer": "MNR-7307-AU340474.002", + "materialNumberSupplier": "MNR-8101-ID146955.001" +} diff --git a/io.catenax.planned_production_output/RELEASE_NOTES.md b/io.catenax.planned_production_output/RELEASE_NOTES.md index 90eba1101..30c46fcc7 100644 --- a/io.catenax.planned_production_output/RELEASE_NOTES.md +++ b/io.catenax.planned_production_output/RELEASE_NOTES.md @@ -1,7 +1,7 @@ # Changelog All notable changes to this model will be documented in this file. -## [1.0.0] - 2023-11-13 +## [1.0.0] - 2023-11-2 ### Added - initial model From e703d2741a2f8c531a62ac6735492d6431d5e8e1 Mon Sep 17 00:00:00 2001 From: --show-origin Date: Wed, 15 Nov 2023 05:25:39 -0800 Subject: [PATCH 20/21] fix: added correct ttl file --- .../1.0.0/PlannedProductionOutput.ttl | 179 +++++++++++++++--- 1 file changed, 154 insertions(+), 25 deletions(-) diff --git a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl index 19cabacaa..3aa5bae14 100644 --- a/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl +++ b/io.catenax.planned_production_output/1.0.0/PlannedProductionOutput.ttl @@ -15,28 +15,157 @@ # # SPDX-License-Identifier: CC-BY-4.0 ####################################################################### -{ - "positions": [ - { - "lastUpdatedOnDateTime": "2023-04-01T14:23:00+01:00", - "orderPositionReference": { - "supplierOrderId": "M-Nbr-4711", - "customerOrderId": "C-Nbr-4711", - "customerOrderPositionId": "PositionId-01" - }, - "allocatedPlannedProductionOutputs": [ - { - "plannedProductionQuantity": { - "value": 20.5, - "unit": "unit:piece" - }, - "productionSiteBpns": "BPNS0123456789ZZ", - "estimatedTimeOfCompletion": "2023-04-01T14:23:00+01:00" - } - ] - } - ], - "materialGlobalAssetId": "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df", - "materialNumberCustomer": "MNR-7307-AU340474.002", - "materialNumberSupplier": "MNR-8101-ID146955.001" -} +####################################################################### +# 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-number: . +@prefix ext-quantity: . +@prefix ext-uuid: . + +:PlannedProductionOutput a samm:Aspect; + samm:preferredName "Planned Production Output of a Supplier"@en; + samm:description "This aspect represents the remaining and planned production outputs of a supplier allocated to a customer. An allocated planned production output is described by a quantity, the site of the supplier and the date with time at which a production of a certain material for a certain customer is planned to be finished. The allocated planned production outputs may be linked to customer order position they have been scheduled for."@en; + samm:properties (:positions :materialNumberCustomer [ + samm:property :materialGlobalAssetId; + samm:optional "true"^^xsd:boolean +] [ + samm:property :materialNumberSupplier; + samm:optional "true"^^xsd:boolean +]); + samm:operations (); + samm:events (). +:positions a samm:Property; + samm:preferredName "Positions"@en; + samm:description "The positions refer to positions within an order of the given product (see material number supplier, materialNumber customer and material global Asset Id) for which the production outputs are transferred. The positions can be differentiated by the order position reference. If no order position reference is given, then there is only one position containing all planned production outputs of the product."@en; + samm:characteristic :PositionsCollection. +: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 planned) 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". +:materialGlobalAssetId a samm:Property; + samm:preferredName "Material Number UUID of the Customer's Twin"@en; + samm:description "Material identifier used uniquely to identify the Material (e.g. PartAsPlanned)."@en; + samm:characteristic ext-uuid:UuidV4Trait; + samm:exampleValue "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df". +: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 planned) in the supplier's database."@en; + samm:characteristic :MaterialNumberCharacteristic; + samm:exampleValue "MNR-8101-ID146955.001". +:PositionsCollection a samm-c:Collection; + samm:preferredName "Positions Collection"@en; + samm:description "If any production for the customer is planned, then there is at least one position. If the supplier does differentiate the planned production according to the order positions (an OrderPositionReference is set), then multiple positions can be given. Among the positions, there could be only one position without an OrderPositionReference to either report the planned production independently of orders or to report internal stock orders planned for the customer."@en; + samm:dataType :Position. +: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. +:Position a samm:Entity; + samm:preferredName "Position"@en; + samm:description "The Position can be planned for production at several sites. A position may be anonymous or may reference a position within an order."@en; + samm:properties ([ + samm:property :orderPositionReference; + samm:optional "true"^^xsd:boolean +] :lastUpdatedOnDateTime :allocatedPlannedProductionOutputs). +:orderPositionReference a samm:Property; + samm:preferredName "Order Position Reference"@en; + samm:description "The order position reference contains information to identify a position within an order."@en; + samm:characteristic :OrderPositionReferenceCharacteristic. +:lastUpdatedOnDateTime a samm:Property; + samm:preferredName "Lasted Updated on Date"@en; + samm:description "Date and time at which the position has been updated by the supplier's systems. Date and time are set according to the timezone."@en; + samm:characteristic :DateTimeStamp; + samm:exampleValue "2023-04-01T14:23:00+01:00"^^xsd:dateTime. +:allocatedPlannedProductionOutputs a samm:Property; + samm:preferredName "Planned and Allocated Production Outputs"@en; + samm:description "Planned Production Outputs already allocated to the customer."@en; + samm:characteristic :AllocatedPlannedProductionOutputCollection. +:OrderPositionReferenceCharacteristic a samm:Characteristic; + samm:preferredName "Order Position Reference Characteristic"@en; + samm:description "The order position reference includes reference numbers for the order and the position. As these information are meant for the customer, the customer reference numbers are mandatory."@en; + samm:dataType :OrderPositionReference. +: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 . +:AllocatedPlannedProductionOutputCollection a samm-c:Collection; + samm:preferredName "Planned and Allocated Production Output Collection"@en; + samm:description "Collection of planned and allocated production outputs that may relate to different production locations and estimated time of completions."@en; + samm:dataType :AllocatedPlannedProductionOutput. +:OrderPositionReference a samm:Entity; + samm:preferredName "Reference to Order Position"@en; + samm:description "Encapsulates the references to identify a position within an order."@en; + samm:properties ([ + samm:property :supplierOrderId; + samm:optional "true"^^xsd:boolean +] :customerOrderId :customerOrderPositionId). +:AllocatedPlannedProductionOutput a samm:Entity; + samm:preferredName "Planned and Allocated Production Output"@en; + samm:description "Quantity, site of the supplier and date with time at which a production of a certain material for a certain customer is planned to be finished."@en; + samm:properties (:plannedProductionQuantity :productionSiteBpns :estimatedTimeOfCompletion). +:supplierOrderId a samm:Property; + samm:preferredName "Supplier Order ID"@en; + samm:description "This is the order number on the supplier side that is given by e.g., the supplier's enterprise resource planning system."@en; + samm:characteristic :OrderIdCharacteristic; + samm:exampleValue "M-Nbr-4711". +:customerOrderId a samm:Property; + samm:preferredName "Customer Order ID"@en; + samm:description "This is the order number on the customer side that can be given by e.g., the customer's enterprise resource planning system."@en; + samm:characteristic :OrderIdCharacteristic; + samm:exampleValue "C-Nbr-4711". +:customerOrderPositionId a samm:Property; + samm:preferredName "Customer Order Position ID"@en; + samm:description "This is an identifier for the position of an order defined by the customer. It's not a technical identifier, such as an UUID. This identifier is used within the business context when talking about the position."@en; + samm:characteristic :OrderPositionIdCharacteristic; + samm:exampleValue "PositionId-01". +:plannedProductionQuantity a samm:Property; + samm:preferredName "Planned Production Quantity"@en; + samm:description "Quantity of a product that a supplier plans to produce on a certain date and time for a specific customer (that means that it will be allocated to a specific customer's \"allocated item stock\").\nQuantities that have already been produced are put on stock or are considered for delivery. Therefore those quantities MUST NOT be considered in the allocated production output to build a consistent view on the supply situation. "@en; + samm:characteristic :QuantityCharacteristic. +:productionSiteBpns a samm:Property; + samm:preferredName "BPNS of Supplier's Production Site"@en; + samm:description "One planned and allocated production output has always one site. The site is identified by the BPNS."@en; + samm:characteristic ext-number:BpnsTrait; + samm:exampleValue "BPNS0123456789ZZ"; + samm:see . +:estimatedTimeOfCompletion a samm:Property; + samm:preferredName "Estimated Time of Completion"@en; + samm:description "Date and time on which the planned and allocated production output is estimated to be completed. Date and time are set according to a timezone."@en; + samm:characteristic :DateTimeStamp; + samm:exampleValue "2023-04-01T14:23:00+01:00"^^xsd:dateTime. +:OrderIdCharacteristic a samm:Characteristic; + samm:preferredName "Order ID Characteristic"@en; + samm:description "This is a proprietary order ID, generated by either the supplier side or customer side."@en; + samm:dataType xsd:string. +:OrderPositionIdCharacteristic a samm:Characteristic; + samm:preferredName "Position ID within Order"@en; + samm:description "The position ID is unique for an order and used within business context to refer to a position."@en; + samm:dataType xsd:string. +:QuantityCharacteristic a samm-c:Quantifiable; + samm:preferredName "Quantity Characteristic"@en; + samm:description "Describes the quantity and the unit of measure with which the planned and allocated production output is measured."@en; + samm:dataType ext-quantity:ItemQuantityEntity. From d1fc6f12d15f825eeb08e1da3cb17bd4dadcc2fc Mon Sep 17 00:00:00 2001 From: --show-origin Date: Mon, 20 Nov 2023 03:56:40 -0800 Subject: [PATCH 21/21] fix: changed day of release date from 2 to 20 --- io.catenax.planned_production_output/RELEASE_NOTES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/io.catenax.planned_production_output/RELEASE_NOTES.md b/io.catenax.planned_production_output/RELEASE_NOTES.md index 30c46fcc7..0ce5d1359 100644 --- a/io.catenax.planned_production_output/RELEASE_NOTES.md +++ b/io.catenax.planned_production_output/RELEASE_NOTES.md @@ -1,7 +1,7 @@ # Changelog All notable changes to this model will be documented in this file. -## [1.0.0] - 2023-11-2 +## [1.0.0] - 2023-11-20 ### Added - initial model