Add aspect model for CapacityGroup

io.catenax.capacity_group/1.0.0/CapacityGroup.ttl

@@ -0,0 +1,265 @@
+#######################################################################
+# 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.capacity_group:1.0.0#>.
+
+:CapacityGroup a bamm:Aspect;
+    bamm:preferredName "Capacity Group"@en;
+    bamm:description "An entity made up of the weekly actual and maximum capacities for a specific customer in a given time period. A capacity group is used to compare demand and capacity data for one or several similar bundled materials in a defined unit of measure."@en;
+    bamm:properties (:capacityGroupId :name [
+  bamm:property :supplierLocations;
+  bamm:optional "true"^^xsd:boolean
+] :customer :supplier :unitOfMeasure :linkedDemandSeries :capacities :changedAt);
+    bamm:operations ();
+    bamm:events ().
+:capacityGroupId a bamm:Property;
+    bamm:preferredName "Capacity Group ID"@en;
+    bamm:description "The Capacity Group ID identifies the capacity group on a global level."@en;
+    bamm:characteristic :UUIDv4;
+    bamm:exampleValue "0157ba42-d2a8-4e28-8565-7b07830c1110".
+:name a bamm:Property;
+    bamm:preferredName "Capacity Group Name"@en;
+    bamm:description "Name of the capacity group."@en;
+    bamm:characteristic :CapacityGroupName;
+    bamm:exampleValue "Spark Plugs on drilling machine for car model XYZ".
+:supplierLocations a bamm:Property;
+    bamm:preferredName "Supplier Locations"@en;
+    bamm:description "The set of locations of the capacity group at the supplier."@en;
+    bamm:characteristic :BPNSSet;
+    bamm:exampleValue "Plant Hamburg".
+:customer a bamm:Property;
+    bamm:preferredName "Customer"@en;
+    bamm:description "A party that requests goods from a supplier."@en;
+    bamm:characteristic :BPNL;
+    bamm:exampleValue "BPNL8888888888XX".
+:supplier a bamm:Property;
+    bamm:preferredName "Supplier"@en;
+    bamm:description "A party that provides goods to a customer."@en;
+    bamm:characteristic :BPNL;
+    bamm:exampleValue "BPNL6666666666YY".
+:unitOfMeasure a bamm:Property;
+    bamm:preferredName "Unit of Measure"@en;
+    bamm:description "Unit of measurement for capacity quantities."@en;
+    bamm:characteristic :UnitOfMeasure;
+    bamm:exampleValue "KGM".
+:linkedDemandSeries a bamm:Property;
+    bamm:preferredName "Linked Demand Series"@en;
+    bamm:description "Set of demand series assigned to this capacity group."@en;
+    bamm:characteristic :LinkedDemandSeriesSet.
+:capacities a bamm:Property;
+    bamm:preferredName "Capacities"@en;
+    bamm:description "A time series with week-based granularity along a given time period containing the capacity values."@en;
+    bamm:characteristic :CapacityTimeSeries.
+:changedAt a bamm:Property;
+    bamm:preferredName "Changed At"@en;
+    bamm:description "Point in time when the capacity group was last updated at the supplier, either by a human user or an automated process."@en;
+    bamm:characteristic :Timestamp.
+: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:see <http://handle.itu.int/11.1002/1000/11746>;
+    bamm:dataType xsd:string.
+:CapacityGroupName a bamm:Characteristic;
+    bamm:preferredName "Capacity Group Name"@en;
+    bamm:description "The name of a capacity group, used to distinguish it from other capacity groups."@en;
+    bamm:dataType xsd:string.
+:BPNSSet a bamm-c:Set;
+    bamm:preferredName "Business Partner Number Site Set"@en;
+    bamm:description "Contains a set of BPNS. Each BPNS represents a site which can be a production plant inside one location."@en;
+    bamm:dataType xsd:string.
+: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:see <https://tfig.unece.org/contents/recommendation-20.htm>;
+    bamm:dataType xsd:string;
+    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").
+:LinkedDemandSeriesSet a bamm-c:Set;
+    bamm:preferredName "Linked Demand Series Set"@en;
+    bamm:description "A set of demand series assigned to a certain capacity group."@en;
+    bamm:dataType :LinkedDemandSeries.
+:CapacityTimeSeries a bamm-c:SortedSet;
+    bamm:preferredName "Capacity Time Series"@en;
+    bamm:description "The weekly actual and maximum capacities in a given time period."@en;
+    bamm:dataType :Capacity.
+:LinkedDemandSeries a bamm:Entity;
+    bamm:preferredName "Linked Demand Series"@en;
+    bamm:description "Encapsulates information used to reference a specific demand series."@en;
+    bamm:properties (:materialNumberCustomer [
+  bamm:property :materialNumberSupplier;
+  bamm:optional "true"^^xsd:boolean
+] :customerLocation :demandCategory).
+:Capacity a bamm:Entity;
+    bamm:preferredName "Capacity"@en;
+    bamm:description "A supplier's realistically planned output per calendar week and material for a specific customer in a specific unit of measure, considering all positive or negative impacts on this capacity."@en;
+    bamm:properties (:calendarWeek :actualCapacity :maximumCapacity).
+: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 the customer's database."@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 the supplier's database."@en;
+    bamm:characteristic :MaterialNumber;
+    bamm:exampleValue "MNR-8101-ID146955.001".
+:customerLocation a bamm:Property;
+    bamm:preferredName "Customer Location"@en;
+    bamm:description "Location of the referenced demand series."@en;
+    bamm:characteristic :BPNS;
+    bamm:exampleValue "Plant Bremen".
+:demandCategory a bamm:Property;
+    bamm:preferredName "Demand Category"@en;
+    bamm:description "Type of demand of the referenced demand series."@en;
+    bamm:characteristic :DemandCategory.
+: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.
+:actualCapacity a bamm:Property;
+    bamm:preferredName "Actual Capacity"@en;
+    bamm:description "The actual capacity is the realistically planned output per calendar week and material for a specific customer in a specific unit of measure, considering all positive or negative impacts on this capacity."@en;
+    bamm:characteristic :Quantity;
+    bamm:exampleValue "1"^^xsd:decimal.
+:maximumCapacity a bamm:Property;
+    bamm:preferredName "Maximum Capacity"@en;
+    bamm:description "The supplier maximum capacity is the maximal available output per calendar week and material for a specific customer in a specific unit of measure. The maximum capacity thereby restricts the flexible capacity, as the flexible capacity is obtained from the difference of a suppliers maximum capacity minus actual capacity."@en;
+    bamm:characteristic :Quantity;
+    bamm:exampleValue "2"^^xsd:decimal.
+: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.
+: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.
+: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 :DemandCategoryIncrementalDemand :DemandCategoryPhaseOutPeriod).
+:CalendarWeek a bamm:Characteristic;
+    bamm:preferredName "Calendar Week"@en;
+    bamm:description "An ISO calendar week in which a given capacity will be provided. Must be given as date of the Monday in the week."@en;
+    bamm:see <https://www.iso.org/standard/70907.html>;
+    bamm:dataType xsd:date.
+:Quantity a bamm:Characteristic;
+    bamm:preferredName "Quantity"@en;
+    bamm:description "Quantity of weekly actual or maximum capacity."@en;
+    bamm:dataType xsd:decimal.
+: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.
+:DemandCategoryIncrementalDemand a :DemandCategoryType;
+    :demandCategoryCode "ID01";
+    :demandCategoryName "Incremental Demand"^^rdf:langString.
+:DemandCategoryPhaseOutPeriod a :DemandCategoryType;
+    :demandCategoryCode "PO01";
+    :demandCategoryName "Phase-Out Period"^^rdf:langString.
+:demandCategoryCode a bamm:Property;
+    bamm:description "The code identifiying a demand category."@en;
+    bamm:characteristic :DemandCategoryCode.
+:demandCategoryName a bamm:Property;
+    bamm:description "The name describing a demand category."@en;
+    bamm:characteristic bamm-c:MultiLanguageText.
+:DemandCategoryCode a bamm-c:Code;
+    bamm:preferredName "Demand Category Code"@en;
+    bamm:description "The code identifiying a demand category."@en;
+    bamm:dataType xsd:string.
+: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.
+: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}$".
+: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.
+: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}$".
+: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.
+:BPNSSetTrait a bamm-c:Trait;
+    bamm:preferredName "BPNS Set Trait"@en;
+    bamm:description "Trait to ensure data format for BPNS set."@en;
+    bamm-c:baseCharacteristic :BPNSSet;
+    bamm-c:constraint :BPNSRegularExpression.
+:QuantityTrait a bamm-c:Trait;
+    bamm-c:baseCharacteristic :Quantity;
+    bamm-c:constraint :QuantityRange, :QuantityFixedPoint.
+:Timestamp a bamm:Characteristic;
+    bamm:preferredName "Timestamp"@en;
+    bamm:description "Point in time."@en;
+    bamm:dataType xsd:dateTimeStamp.

io.catenax.capacity_group/1.0.0/metadata.json

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

io.catenax.capacity_group/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 capacity group model