[New Model] Week-Based Material Demand (Demand and Capacity Management)

io.catenax.week_based_material_demand/1.0.0/WeekBasedMaterialDemand.ttl

@@ -0,0 +1,256 @@
+#######################################################################
+# Copyright (c) 2022 SAP SE
+# Copyright (c) 2022 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: <urn:bamm:io.openmanufacturing:meta-model:2.0.0#>.
+@prefix bamm-c: <urn:bamm:io.openmanufacturing:characteristic:2.0.0#>.
+@prefix bamm-e: <urn:bamm:io.openmanufacturing:entity:2.0.0#>.
+@prefix unit: <urn:bamm:io.openmanufacturing:unit:2.0.0#>.
+@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>.
+@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>.
+@prefix xsd: <http://www.w3.org/2001/XMLSchema#>.
+@prefix : <urn:bamm:io.catenax.week_based_material_demand:1.0.0#>.
+
+:WeekBasedMaterialDemand a bamm:Aspect;
+    bamm:preferredName "Week-Based Material Demand"@en;
+    bamm:description "The requirements of a customer towards a specific supplier for a specific material. Each material demand is unique by its Customer, Supplier and Material Number."@en;
+    bamm:properties (:materialDemandId :demandSeries :customer :supplier :unitOfMeasure :materialNumberCustomer [
+  bamm:property :materialNumberSupplier;
+  bamm:optional "true"^^xsd:boolean
+] :materialDescriptionCustomer :changedAt);
+    bamm:operations ();
+    bamm:events ().
+:materialDemandId a bamm:Property;
+    bamm:preferredName "Material Demand ID"@en;
+    bamm:description "The Material Demand ID uniquely identifies the material demand within the business relationship between a customer and its supplier."@en;
+    bamm:characteristic :UUIDv4IdTrait;
+    bamm:exampleValue "0157ba42-d2a8-4e28-8565-7b07830c1110".
+:demandSeries a bamm:Property;
+    bamm:preferredName "Demand Series"@en;
+    bamm:description "The weekly demands for a dedicated material in a given time period, distinguished by their demand location and demand category."@en;
+    bamm:characteristic :DemandSeriesSet.
+:customer a bamm:Property;
+    bamm:preferredName "Customer"@en;
+    bamm:description "The Business Partner Number (BPNL) of the party requesting materials from a supplier."@en;
+    bamm:characteristic :BPNLTrait;
+    bamm:exampleValue "BPNL8888888888XX".
+:supplier a bamm:Property;
+    bamm:preferredName "Supplier"@en;
+    bamm:description "The Business Partner Number (BPNL) of the party providing materials to a customer."@en;
+    bamm:characteristic :BPNLTrait;
+    bamm:exampleValue "BPNL6666666666YY".
+:unitOfMeasure a bamm:Property;
+    bamm:preferredName "Unit of Measure"@en;
+    bamm:description "Unit of measurement for demand quantities."@en;
+    bamm:characteristic :UnitOfMeasure;
+    bamm:exampleValue "KGM".
+: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. Must be unique for each Material Demand in the customer-supplier relationship."@en;
+    bamm:characteristic :MaterialNumber;
+    bamm:exampleValue "MNR-7307-AU340474.002".
+: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".
+:materialDescriptionCustomer a bamm:Property;
+    bamm:preferredName "Customer Material Description"@en;
+    bamm:description "Description of the material."@en;
+    bamm:characteristic :MaterialDescription;
+    bamm:exampleValue "Spark Plug".
+:changedAt a bamm:Property;
+    bamm:preferredName "Changed At"@en;
+    bamm:description "Point in time when the material demand was last updated at the customer, either by a human user or an automated process."@en;
+    bamm:characteristic :Timestamp;
+    bamm:exampleValue "2023-03-10T12:27:11.320Z"^^xsd:dateTimeStamp.
+:UUIDv4 a bamm:Characteristic;
+    bamm:preferredName "UUIDv4"@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 <http://handle.itu.int/11.1002/1000/11746>.
+:DemandSeriesSet a bamm-c:Set;
+    bamm:preferredName "Demand Series Set"@en;
+    bamm:description "A set of demand series belonging to a certain material demand. Each demand series in the set must have a unique combination of customer location and demand category."@en;
+    bamm:dataType :DemandSeries.
+:BPNL a bamm:Characteristic;
+    bamm:preferredName "Business Partner Number Legal Entity"@en;
+    bamm:description "BPNL represents the legal entity of an organization participating in Catena-X."@en;
+    bamm:dataType xsd:string.
+:UnitOfMeasure a bamm-c:Enumeration;
+    bamm:preferredName "Unit of Measure"@en;
+    bamm: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;
+    bamm:dataType xsd:string;
+    bamm:see <https://tfig.unece.org/contents/recommendation-20.htm>;
+    bamm-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" "").
+: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.
+:MaterialDescription a bamm:Characteristic;
+    bamm:preferredName "Material Description"@en;
+    bamm:description "Description of a material demand."@en;
+    bamm:dataType xsd:string.
+:Timestamp a bamm:Characteristic;
+    bamm:preferredName "Timestamp"@en;
+    bamm:description "Point in time."@en;
+    bamm:dataType xsd:dateTimeStamp.
+:DemandSeries a bamm:Entity;
+    bamm:preferredName "Demand Series"@en;
+    bamm:description "Encapsulates the demand series related information."@en;
+    bamm:properties (:customerLocation :demandCategory :demands [
+  bamm:property :expectedSupplierLocation;
+  bamm:optional "true"^^xsd:boolean
+]).
+:expectedSupplierLocation a bamm:Property;
+    bamm:preferredName "Expected Supplier Location"@en;
+    bamm:description "The BPNS number of the site from where the customer expects the supplier to fulfill the demands of the demand series. The value is used for informational purposes only and is therefore not binding for the supplier."@en;
+    bamm:characteristic :BPNSTrait;
+    bamm:exampleValue "BPNS8888888888XX".
+:BPNS a bamm:Characteristic;
+    bamm:preferredName "Business Partner Number Site"@en;
+    bamm:description "BPNS represents a site which can be a production plant inside one location."@en;
+    bamm:dataType xsd:string.
+:customerLocation a bamm:Property;
+    bamm:preferredName "Customer Location"@en;
+    bamm:description "The BPNS number of the site at which the customer needs the specified material for this demand series."@en;
+    bamm:characteristic :BPNSTrait;
+    bamm:exampleValue "BPNS8888888888XX".
+:demandCategory a bamm:Property;
+    bamm:preferredName "Demand Category"@en;
+    bamm:description "Type of demand for this demand series."@en;
+    bamm:characteristic :DemandCategory.
+:demands a bamm:Property;
+    bamm:preferredName "Demands"@en;
+    bamm:description "A time series with week-based granularity along a given time period to describe the demand values for this demand series."@en;
+    bamm:characteristic :DemandTimeSeries.
+:UUIDv4RegularExpression a bamm-c:RegularExpressionConstraint;
+    bamm:preferredName "UUIDv4 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)."@en;
+    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}$".
+:UUIDv4IdTrait a bamm-c:Trait;
+    bamm:preferredName "UUIDv4 Trait"@en;
+    bamm:description "Trait to ensure data format for UUIDv4."@en;
+    bamm-c:baseCharacteristic :UUIDv4;
+    bamm-c:constraint :UUIDv4RegularExpression.
+:DemandCategory a bamm-c:Enumeration;
+    bamm:preferredName "Demand Category"@en;
+    bamm:description "The classification of demands used to prioritize or allocate capacities."@en;
+    bamm:dataType :DemandCategoryType;
+    bamm-c:values (:DemandCategoryDefault :DemandCategoryAfterSales :DemandCategorySeries :DemandCategoryPhaseInPeriod :DemandCategorySingleOrder :DemandCategorySmallSeries :DemandCategoryExtraordinaryDemand :DemandCategoryPhaseOutPeriod).
+:DemandTimeSeries a bamm-c:SortedSet;
+    bamm:preferredName "Demand Time Series"@en;
+    bamm:description "The weekly demands in a given time period."@en;
+    bamm:dataType :Demand.
+:DemandCategoryType a bamm:Entity;
+    bamm:preferredName "Demand Category Type"@en;
+    bamm:description "Describes the type of a demand category."@en;
+    bamm:properties (:demandCategoryCode [
+  bamm:property :demandCategoryName;
+  bamm:notInPayload "true"^^xsd:boolean
+]).
+:DemandCategoryDefault a :DemandCategoryType;
+    :demandCategoryCode "0001";
+    :demandCategoryName "Default"^^rdf:langString.
+:DemandCategoryAfterSales a :DemandCategoryType;
+    :demandCategoryCode "A1S1";
+    :demandCategoryName "After-Sales"^^rdf:langString.
+:DemandCategorySeries a :DemandCategoryType;
+    :demandCategoryCode "SR99";
+    :demandCategoryName "Series"^^rdf:langString.
+:DemandCategoryPhaseInPeriod a :DemandCategoryType;
+    :demandCategoryCode "PI01";
+    :demandCategoryName "Phase-In Period"^^rdf:langString.
+:DemandCategorySingleOrder a :DemandCategoryType;
+    :demandCategoryCode "OS01";
+    :demandCategoryName "Single Order"^^rdf:langString.
+:DemandCategorySmallSeries a :DemandCategoryType;
+    :demandCategoryCode "OI01";
+    :demandCategoryName "Small Series"^^rdf:langString.
+:DemandCategoryExtraordinaryDemand a :DemandCategoryType;
+    :demandCategoryCode "ED01";
+    :demandCategoryName "Extraordinary Demand"^^rdf:langString.
+:DemandCategoryPhaseOutPeriod a :DemandCategoryType;
+    :demandCategoryCode "PO01";
+    :demandCategoryName "Phase-Out Period"^^rdf:langString.
+:Demand a bamm:Entity;
+    bamm:preferredName "Demand"@en;
+    bamm:description "A single demand for a given calendar week."@en;
+    bamm:properties (:calendarWeek :demand).
+:demandCategoryCode a bamm:Property;
+    bamm:preferredName "Demand Category Code"@en;
+    bamm:description "The code identifying a demand category."@en;
+    bamm:characteristic :DemandCategoryCode;
+    bamm:exampleValue "0001".
+:demandCategoryName a bamm:Property;
+    bamm:preferredName "Demand Category Name"@en;
+    bamm:description "The name describing a demand category."@en;
+    bamm:characteristic bamm-c:MultiLanguageText;
+    bamm:exampleValue "Default"^^rdf:langString.
+:calendarWeek a bamm:Property;
+    bamm:preferredName "Calendar Week"@en;
+    bamm:description "ISO Calendar Week of the given time series entry. Must be given as date of the Monday in the week."@en;
+    bamm:characteristic :CalendarWeek;
+    bamm:exampleValue "2022-08-01"^^xsd:date.
+:demand a bamm:Property;
+    bamm:preferredName "Demand"@en;
+    bamm:description "Quantity of materials required in the specified calendar week."@en;
+    bamm:characteristic :QuantityTrait;
+    bamm:exampleValue "1"^^xsd:decimal.
+:DemandCategoryCode a bamm-c:Code;
+    bamm:preferredName "Demand Category Code"@en;
+    bamm:description "The code identifying a demand category."@en;
+    bamm:dataType xsd:string.
+:CalendarWeek a bamm:Characteristic;
+    bamm:preferredName "Calendar Week"@en;
+    bamm:description "An ISO calendar week in which a given demand is needed. Must be given as date of the Monday in the week."@en;
+    bamm:dataType xsd:date;
+    bamm:see <https://www.iso.org/standard/70907.html>.
+:Quantity a bamm:Characteristic;
+    bamm:preferredName "Quantity"@en;
+    bamm:description "Quantities of weekly demands."@en;
+    bamm:dataType xsd:decimal.
+:BPNSTrait a bamm-c:Trait;
+    bamm:preferredName "BPNS Trait"@en;
+    bamm:description "Trait to ensure data format for BPNS."@en;
+    bamm-c:baseCharacteristic :BPNS;
+    bamm-c:constraint :BPNSRegularExpression.
+:BPNSRegularExpression a bamm-c:RegularExpressionConstraint;
+    bamm:preferredName "BPNS Regular Expression"@en;
+    bamm:description "The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two uppercase letters."@en;
+    bamm:value "^BPNS[0-9]{8}[a-zA-Z0-9]{4}$".
+:BPNLTrait a bamm-c:Trait;
+    bamm:preferredName "BPNL Trait"@en;
+    bamm:description "Trait to ensure data format for BPNL."@en;
+    bamm-c:baseCharacteristic :BPNL;
+    bamm-c:constraint :BPNLRegularExpression.
+:BPNLRegularExpression a bamm-c:RegularExpressionConstraint;
+    bamm:preferredName "BPNL Regular Expression"@en;
+    bamm:description "The provided regular expression ensures that the BPNL is composed of prefix 'BPNL', 10 digits and two uppercase letters."@en;
+    bamm:value "^BPNL[0-9]{8}[a-zA-Z0-9]{4}$".
+:QuantityRange a bamm-c:RangeConstraint;
+    bamm:preferredName "Quantity Range"@en;
+    bamm:description "Constraint to ensure a non-negative value for quantities."@en;
+    bamm-c:minValue "0"^^xsd:decimal;
+    bamm-c:maxValue "999999999999999999.999"^^xsd:decimal;
+    bamm-c:lowerBoundDefinition bamm-c:AT_LEAST;
+    bamm-c:upperBoundDefinition bamm-c:AT_MOST.
+:QuantityTrait a bamm-c:Trait;
+    bamm-c:baseCharacteristic :Quantity;
+    bamm-c:constraint :QuantityRange, :QuantityFixedPoint.
+:QuantityFixedPoint a bamm-c:FixedPointConstraint;
+    bamm:preferredName "Quantity Fixed Point"@en;
+    bamm:description "Constraint to ensure size of quantities: 12 digits plus 3 decimal places."@en;
+    bamm-c:integer "15"^^xsd:positiveInteger;
+    bamm-c:scale "1000"^^xsd:positiveInteger.

io.catenax.week_based_material_demand/1.0.0/metadata.json

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

io.catenax.week_based_material_demand/RELEASE_NOTES.md

@@ -0,0 +1,5 @@
+# Changelog
+All notable changes to this model will be documented in this file.
+
+## [1.0.0]
+- initial version of the aspect model for week-based material demands