Skip to content

Commit

Permalink
Added Operations event model
Browse files Browse the repository at this point in the history
  • Loading branch information
@JMayrbaeurl
JMayrbaeurl committed Jan 5, 2023
1 parent 97e537b commit 6a91009
Show file tree
Hide file tree
Showing 11 changed files with 1,127 additions and 0 deletions.
7 changes: 7 additions & 0 deletions .vscode/settings.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"cSpell.words": [
"digitaltwins",
"dtdl",
"dtmi"
]
}
325 changes: 325 additions & 0 deletions Ontology/CommonObjectModels/OperationsEvent/OperationsEvent.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,325 @@
{
"@context": "dtmi:dtdl:context;2",
"@id": "dtmi:digitaltwins:isa95:OperationsEvent;1",
"@type": "Interface",
"displayName": "Operations event",
"description": "Large numbers of real-world events occur in any given manufacturing system. Only some real-world events are associated with manufacturing operations management activities and functions. The subset of those real-world events that require notification of process context specific information exchanges of this standard shall be defined as operations events. Operations events may be generated by any Level 4 or Level 3 function or activity",
"comment": "According to ANSI/ISA-95.00.02-2018 Enterprise-Control System Integration − Part 2: Objects and Attributes for - Approved 24 May 2018",
"extends": [
"dtmi:digitaltwins:isa95:BaseModel;1"
],
"contents": [
{
"@type": "Relationship",
"name": "isACollectionOf",
"displayName": "Is a collection of",
"description": "The operations event records related to this operations event",
"target": "dtmi:digitaltwins:isa95:OperationsEventRecord;1"
},
{
"@type": "Relationship",
"name": "hasValuesOf",
"displayName": "Has values of",
"description": "The operations event property values of this operations event",
"target": "dtmi:digitaltwins:isa95:OperationsEventProperty;1"
},
{
"@type": "Relationship",
"name": "definedBy",
"displayName": "Defined by",
"description": "The operations event definition that defines the structure and generic context of the operation event message",
"target": "dtmi:digitaltwins:isa95:OperationsEventDefinition;1",
"comment": "Mandatory - Cardinality 1",
"maxMultiplicity": 1
},
{
"@type": "Relationship",
"name": "isMadeOf",
"displayName": "Is made up of",
"description": "This operations event is part of the related object as the whole. The associated events related to this operations event message. The reference is an ID with any additional attributes required",
"target": "dtmi:digitaltwins:isa95:OperationsEvent;1"
},
{
"@type": "Component",
"name": "description",
"displayName": "Description",
"description": "Contains additional information and descriptions of the operations event",
"schema": "dtmi:digitaltwins:isa95:LangStringSet;1"
},
{
"@type": "Property",
"name": "effectiveTimestamp",
"displayName": "Effective timestamp",
"description": "The date and time the real-world event occurred",
"schema": "dateTime",
"writable": true
},
{
"@type": "Property",
"name": "recordTimestamp",
"displayName": "Record timestamp",
"description": "The time the operations event was recorded / transacted by the publisher",
"schema": "dateTime",
"writable": true
},
{
"@type": "Property",
"name": "hierarchyScope",
"displayName": "Hierarchy scope",
"description": "Identifies where the exchanged information fits within the role based equipment hierarchy. Optionally, hierarchy scope defines the scope of the equipment class, such as the site or area where it is defined.",
"schema": "string"
},
{
"@type": "Relationship",
"name": "hierarchyScopeRel",
"displayName": "fits hierarchy scope",
"description": "Optional relationship to hierarchy.",
"comment": "Not part of the Standard Specs.",
"target": "dtmi:digitaltwins:isa95:HierarchyScope;1",
"maxMultiplicity": 1
},
{
"@type": "Property",
"name": "Priority",
"displayName": "Priority",
"description": "Priority of the operations event that Is a guide to the relative level of importance of an operations event",
"schema": "string",
"writable": true
},
{
"@type": "Property",
"name": "operationsEventType",
"displayName": "Operations event type",
"description": "The type of Level 3 operations event",
"schema": {
"@type": "Enum",
"valueSchema": "string",
"enumValues": [
{
"name": "event",
"enumValue": "Event",
"displayName": "Event"
},
{
"name": "alert",
"enumValue": "Alert",
"displayName": "Alert"
},
{
"name": "alarm",
"enumValue": "Alarm",
"displayName": "Alarm"
}
]
}
},
{
"@type": "Property",
"name": "operationsEventLevel",
"displayName": "Operations event level",
"description": "Defines the domain level of the operations event publisher",
"schema": {
"@type": "Enum",
"valueSchema": "integer",
"enumValues": [
{
"name": "level3",
"enumValue": 3,
"displayName": "Level 3"
},
{
"name": "level4",
"enumValue": 4,
"displayName": "Level 4"
}
]
}
},
{
"@type": "Property",
"name": "operationsType",
"displayName": "Operations type",
"description": "Describes the category of operation",
"comment": "Required attribute",
"schema": {
"@type": "Enum",
"valueSchema": "string",
"enumValues": [
{
"name": "production",
"displayName": "Production",
"enumValue": "Production"
},
{
"name": "inventory",
"displayName": "Inventory",
"enumValue": "Inventory"
},
{
"name": "quality",
"displayName": "Quality",
"enumValue": "Quality"
},
{
"name": "maintenance",
"displayName": "Maintenance",
"enumValue": "Maintenance"
},
{
"name": "mixed",
"displayName": "Mixed",
"enumValue": "Mixed",
"comment": "Mixed can be used when the operations event does not refer to a specific operations activity or refers to several operation activities"
}
]
}
},
{
"@type": "Property",
"name": "momFunction",
"displayName": "MOM function",
"description": "Defines the MOM function of the operations event publisher",
"comment": "Defined values from Part 3 MOM Activity Model are",
"schema": {
"@type": "Enum",
"valueSchema": "string",
"enumValues": [
{
"name": "resourceManagement",
"enumValue": "Resource management",
"displayName": "Resource management"
},
{
"name": "definitionManagement",
"enumValue": "Definition management",
"displayName": "Definition management"
},
{
"name": "detailedScheduling",
"enumValue": "Detailed scheduling",
"displayName": "Detailed scheduling"
},
{
"name": "dispatching",
"enumValue": "Dispatching",
"displayName": "Dispatching"
},
{
"name": "executionManagement",
"enumValue": "Execution management",
"displayName": "Execution management"
},
{
"name": "dataCollection",
"enumValue": "Data collection",
"displayName": "Data collection"
},
{
"name": "performanceAnalysis",
"enumValue": "Performance analysis",
"displayName": "Performance analysis"
},
{
"name": "tracking",
"enumValue": "Tracking",
"displayName": "Tracking"
}
]
}
},
{
"@type": "Property",
"name": "enterpriseFunction",
"displayName": "Enterprise function",
"description": "Defines the enterprise function of the operations event publisher",
"comment": "Defined values from Part 1 Functional Model are",
"schema": {
"@type": "Enum",
"valueSchema": "string",
"enumValues": [
{
"name": "orderProcessing",
"enumValue": "Order processing",
"displayName": "Order processing"
},
{
"name": "operationsScheduling",
"enumValue": "Operations scheduling",
"displayName": "Operations scheduling"
},
{
"name": "productionControl",
"enumValue": "Production control",
"displayName": "Production control"
},
{
"name": "materialAndEnergyControl",
"enumValue": "Material and energy control",
"displayName": "Material and energy control"
},
{
"name": "procurement",
"enumValue": "Procurement",
"displayName": "Procurement"
},
{
"name": "qualityAssurance",
"enumValue": "Quality assurance",
"displayName": "Quality assurance"
},
{
"name": "productInventoryControl",
"enumValue": "Product inventory control",
"displayName": "Product inventory control"
},
{
"name": "productCostAccounting",
"enumValue": "Product cost accounting",
"displayName": "Product cost accounting"
},
{
"name": "productShippingAdministration",
"enumValue": "Product shipping administration",
"displayName": "Product shipping administration"
},
{
"name": "maintenanceManagement",
"enumValue": "Maintenance management",
"displayName": "Maintenance management"
},
{
"name": "marketingAndSales",
"enumValue": "Marketing and sales",
"displayName": "Marketing and sales"
},
{
"name": "rAndD",
"enumValue": "R&D",
"displayName": "R&D"
},
{
"name": "engineering",
"enumValue": "Engineering",
"displayName": "Engineering"
}
]
}
},
{
"@type": "Property",
"name": "category",
"displayName": "Category",
"description": "General grouping associated with an operations event definition",
"schema": "string",
"writable": true
},
{
"@type": "Property",
"name": "source",
"displayName": "Source",
"description": "The activity, function, task or phase that generated the operations event",
"schema": "string",
"writable": true
}
]
}
57 changes: 57 additions & 0 deletions Ontology/CommonObjectModels/OperationsEvent/OperationsEventClass.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
{
"@context": "dtmi:dtdl:context;2",
"@id": "dtmi:digitaltwins:isa95:OperationsEventClass;1",
"@type": "Interface",
"displayName": "Operations event class",
"description": "An operations event class is a representation of groupings of operations event definitions",
"comment": "According to ANSI/ISA-95.00.02-2018 Enterprise-Control System Integration − Part 2: Objects and Attributes for - Approved 24 May 2018",
"extends": [
"dtmi:digitaltwins:isa95:BaseModel;1"
],
"contents": [
{
"@type": "Relationship",
"name": "isAssembledFrom",
"displayName": "Is assembled from",
"description": "The nested operations event class(s) makes up part of this operations event class as the whole",
"target": "dtmi:digitaltwins:isa95:OperationsEventClass;1"
},
{
"@type": "Relationship",
"name": "includesPropertiesOf",
"displayName": "Includes properties of",
"description": "This operations event class(s) include properties of the operations event class",
"target": "dtmi:digitaltwins:isa95:OperationsEventClass;1",
"maxMultiplicity": 1
},
{
"@type": "Relationship",
"name": "hasPropertiesOf",
"displayName": "Has properties of",
"description": "The operations event class property(s) of this operations event class",
"target": "dtmi:digitaltwins:isa95:OperationsEventClassProperty;1"
},
{
"@type": "Relationship",
"name": "hasRecordSpecificationOf",
"displayName": "Has record specification of",
"description": "The operations event class record specification(s) related to this operations event class",
"target": "dtmi:digitaltwins:isa95:OperationsEventClassRecordSpecification;1"
},
{
"@type": "Component",
"name": "description",
"displayName": "Description",
"description": "Additional information and description about the operations event class",
"schema": "dtmi:digitaltwins:isa95:LangStringSet;1"
},
{
"@type": "Property",
"name": "extension",
"displayName": "Extension",
"description": "Defines constraints on the inclusion of the respective operations event class in a hierarchy",
"schema": "string",
"comment": "Defined value are - sealed: no entry can use this entry as its parent; - (No entry): no entry allows any entry to represent this entry as its parent /ancestor. NOTE 1 Extension can contain a set of entries of other operations event classes who represent this entry in their parent"
}
]
}
Loading

0 comments on commit 6a91009

Please sign in to comment.