System-defined types
- Last UpdatedOct 13, 2026
- 2 minute read
Type Management has a set of predefined types that are a part of every data store. These are called system-defined types and are employed to ensure consistency across the platform.
Common aspects of system-defined types
-
There is a field called IsSystemDefined that is true if and only if the type as defined by the system and loaded from its internal data.
-
CreateDate and UpdateDate are manually curated to reflect the actual date that changes occurred as accurately as possible.
-
Root-level system-defined types are prefixed with "Base" and their entity name should match their corresponding Root Class.
Root-level system-defined types
One of the main reasons for adding a system-defined type is to serve as a base type for downstream services. At the time of writing, we define 11 such types:
|
Root-Level Type |
Class ID |
Downstream Service |
|---|---|---|
|
BaseStream |
1 |
SDS โ planned for future integration |
|
BaseAsset |
2 |
Entity Management |
|
BaseEvent |
3 |
Event Management |
|
BaseDocument |
4 |
Entity Management |
|
BaseVisualization |
5 |
CVS |
|
BaseConnectionHealth |
6 |
OMF Ingress |
|
BaseFile |
7 |
Entity Management |
|
BaseForm |
8 |
CVS |
|
BaseMapLayer |
9 |
CVS |
|
BaseVisualElement |
10 |
CVS |
|
BaseInvestigation |
11 |
|
|
BaseExtendedAttributes |
None |
Entity Management |
Other system-defined types
BaseExtendedAttributes
The BaseExtendedAttributes type is a special base type with no associated root class. this allows an entity to define a component without contributing additional class information.
Global visualization types
There are four additional types for visualizations that are system-defined but they derive from BaseVisualization and BaseVisualElement.
-
CanvasVisualization
-
ExperienceVisualization
-
GridVisualization
-
IndustrialGraphic
System-defined types related to events
-
EventState: This is a global enumeration that defines whether an event is ongoing (open) or completed (closed).
-
BaseKpiEvent: The base type for KPI calculation output events, This type derives from BaseEvent and so has ClassId 3.
System-defined types related to investigations
Investigation.Definition: The defining (identity) component for every Investigation. It derives from BaseInvestigation and so has ClassId 11. It is not inheritable, and belongs to the _investigation subgraph.
It carries the intrinsic identity, lifecycle, and resolution fields โ Description, State, Priority, Category, PeriodStart, PeriodEnd, AssignedTo, RootCause, ResolutionSummary, OutcomeCategory, ClosedBy, and ClosedOn โ along with the core graph relationships Investigates, DocumentedBy, VisualizedBy, and RelatedTo.