diff --git a/io.catenax.item_stock/1.0.0/ItemStock.ttl b/io.catenax.item_stock/1.0.0/ItemStock.ttl index a4917cc6..903be0b9 100644 --- a/io.catenax.item_stock/1.0.0/ItemStock.ttl +++ b/io.catenax.item_stock/1.0.0/ItemStock.ttl @@ -23,223 +23,169 @@ samm:preferredName "Positions"@en; samm:description "In case of a supplier's stocks for a customer, these stocks may reference the order position for that they have been produced. \nIn case of a customer's stock delivered by a supplier, there is exactly one position.\n\nIn case there is no item on stock, positions MUST be empty."@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. - -In case of a supplier's stock for a customer, the supplier can differentiate the stock according to the order positions of his customer. In this case 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. - -In case of a customer's stock delivered by a supplier, there is exactly one position without order position references."""@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. -In case of a supplier's stock for a customer, a position may be either anonymous or reference a position within a customer order. -In case of a customer's stock for a supplier, the order position reference MUST NOT be set."""@en ; - samm:properties ( [ samm:property :orderPositionReference; samm:optional true ] :lastUpdatedOnDateTime :allocatedStocks ) . - -: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 . - -:allocatedStocks a samm:Property ; - samm:preferredName "Allocated Stocks"@en ; - samm:description "Stocks that have been already allocated to the customer or delivered by a specific supplier. An allocated stock always refers to a stock location."@en ; - samm:characteristic :AllocatedStockCollection . - -: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 . - -:AllocatedStockCollection a samm-c:Collection ; - samm:preferredName "Allocated Stock Collection"@en ; - samm:description "Collection of allocated stocks that may relate to different stock locations."@en ; - samm:dataType :AllocatedStock . - -: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 ) . - -:AllocatedStock a samm:Entity ; - samm:preferredName "Stock Allocated to a Partner"@en ; - samm:description """This is the quantity of items on stock at a location. A stock can either be -- from a certain supplier and ready to be consumed by a customer or -- from a supplier and ready to be shipped to a certain customer. - -In case of stocks \"from a supplier ready to be shipped to a certain customer\", the stock may refer to an order position of a customer. This stock consists only of the good-finished items."""@en ; - samm:properties ( :quantityOnAllocatedStock :supplierStockLocationId ) . - -: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" . - -:quantityOnAllocatedStock a samm:Property ; - samm:preferredName "Quantity on Allocated Stock"@en ; - samm:description "This is the quantity of the material within the position that is already ready to be delivered."@en ; - samm:characteristic :QuantityCharacteristic . - -:supplierStockLocationId a samm:Property ; - samm:preferredName "Location ID of Supplier's Stock"@en ; - samm:description "One stock has always one location. The location is identified using BPNs. The location can be identified differently depending on the partner."@en ; - samm:see ; - samm:characteristic :SupplierStockLocationIDCharacteristic . - -: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 . - -:SupplierStockLocationIDCharacteristic a samm:Characteristic ; - samm:preferredName "Location ID Characteristic of Supplier's Stock"@en ; - samm:description "This is the location where the stock is located."@en ; - samm:dataType :LocationId . - -: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 ) . - -:LocationId a samm:Entity ; - samm:preferredName "Location ID"@en ; - samm: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 ; - samm:properties ( :locationIdType :locationId ) . - -: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 . - -:locationIdType a samm:Property ; - samm:preferredName "Type of Location ID"@en ; - samm:description "Type of the location's ID."@en ; - samm:characteristic :LocationIdTypeEnum ; - samm:exampleValue "BPNS" . - -:locationId a samm:Property ; - samm:preferredName "Location ID"@en ; - samm:description "The actual ID reflecting the type (locationIdType) of the location."@en ; - samm:characteristic :LocationIdCharacteristic ; - samm:exampleValue "BPNS0123456789ZZ" . - -: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 . - -:LocationIdTypeEnum a samm-c:Enumeration ; - samm:preferredName "Location ID Type Enum"@en ; - samm:description "Enumeration specifying types of keys for locations within Catena-X."@en ; - samm:see ; - samm:dataType xsd:string ; - samm:see ; - samm-c:values ("BPNS" "BPNA"). -:LocationIdCharacteristic a samm:Characteristic; - samm:preferredName "Location ID Characteristic"@en; - samm:description "The actual key based on the type."@en; +: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. \n\nIn case of a supplier's stock for a customer, the supplier can differentiate the stock according to the order positions of his customer. In this case 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.\n\nIn case of a customer's stock delivered by a supplier, there is exactly one position without order position references."@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:properties ([ + samm:property :orderPositionReference; + samm:optional "true"^^xsd:boolean +] :lastUpdatedOnDateTime :allocatedStocks); + samm:preferredName "Position"@en; + samm:description "The Position can be located at several stocks. \nIn case of a supplier's stock for a customer, a position may be either anonymous or reference a position within a customer order. \nIn case of a customer's stock for a supplier, the order position reference MUST NOT be set."@en. +: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 . + 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"^^xsd:date. +:allocatedStocks a samm:Property; + samm:preferredName "Allocated Stocks"@en; + samm:description "Stocks that have been already allocated to the customer or delivered by a specific supplier. An allocated stock always refers to a stock location."@en; + samm:characteristic :AllocatedStockCollection. +: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:dataType xsd:date; + samm:see . +:AllocatedStockCollection a samm-c:Collection; + samm:preferredName "Allocated Stock Collection"@en; + samm:description "Collection of allocated stocks that may relate to different stock locations."@en; + samm:dataType :AllocatedStock. +:OrderPositionReference a samm:Entity; + samm:properties ([ + samm:property :supplierOrderId; + samm:optional "true"^^xsd:boolean +] :customerOrderId :customerOrderPositionId); + samm:preferredName "Reference to Order Position"@en; + samm:description "Encapsulates the references to identify a position within an order."@en. +:AllocatedStock a samm:Entity; + samm:properties (:quantityOnAllocatedStock :stockLocationId); + samm:preferredName "Stock Allocated to a Partner"@en; + samm:description "This is the quantity of items on stock at a location. A stock can either be\n- from a certain supplier and ready to be consumed by a customer or\n- from a supplier and ready to be shipped to a certain customer. \n\nIn case of stocks \"from a supplier ready to be shipped to a certain customer\", the stock may refer to an order position of a customer. This stock consists only of the good-finished items."@en. +: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". +:quantityOnAllocatedStock a samm:Property; + samm:preferredName "Quantity on Allocated Stock"@en; + samm:description "This is the quantity of the material on stock. In case of stocks \"from a supplier ready to be shipped to a certain customer\", the stock may refer to an order position of a customer."@en; + samm:characteristic :QuantityCharacteristic. +: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 on stock of the item defined by a quantity value and the measurement unit in which the quantity is measured."@en; + samm:dataType :Quantity. +:Quantity a samm:Entity; + samm:properties (:quantityNumber :measurementUnit); + samm:preferredName "Quantity"@en; + samm:description "Comprises the number of objects and the unit of measurement for the item."@en. +:LocationId a samm:Entity; + samm:properties (:locationIdType :locationId); + samm:preferredName "Location ID"@en; + samm: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. :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: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.\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; + samm:description "TODO: 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\". TODO"@en; samm:characteristic samm-c:UnitReference; samm:exampleValue "unit:litre"^^samm:curie; samm:see . -:NumberofObjects a samm:Characteristic; +:locationIdType a samm:Property; + samm:preferredName "Type of Location ID"@en; + samm:description "Type of the location's ID."@en; + samm:characteristic :LocationIdTypeEnum; + samm:exampleValue "BPNS". +:locationId a samm:Property; + samm:preferredName "Location ID"@en; + samm:description "The actual ID reflecting the type (locationIdType) of the location."@en; + samm:characteristic :LocationIdCharacteristic; + samm:exampleValue "BPNS0123456789ZZ". +:LocationIdTypeEnum a samm-c:Enumeration; + samm:preferredName "Location ID Type Enum"@en; + samm:description "Enumeration specifying types of keys for locations within Catena-X."@en; + samm:dataType xsd:string; + samm:see ; + samm-c:values ("BPNS" "BPNA"). +:LocationIdCharacteristic a samm:Characteristic; + samm:preferredName "Location ID Characteristic"@en; + samm:description "The actual key based on the type."@en; + samm:dataType xsd:string; + samm:see . +:stockLocationId a samm:Property; + samm:preferredName "Location ID of Stock"@en; + samm:description "One stock has always one location. The location is identified using BPNs. The location can be identified differently depending on the partner."@en; + samm:characteristic :StockLocationIDCharacteristic; + samm:see . +:StockLocationIDCharacteristic a samm:Characteristic; + samm:preferredName "Location ID Characteristic of Stock"@en; + samm:description "This is the location where the stock is located."@en; + samm:dataType :LocationId. +: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 measurement unit."@en; samm:dataType xsd:double.