Types
Branding
Inheritance: System-2.5.0/Entity-1 ➔ System.UI-2.10.0/UIElement-1 ➔ System.UI-2.10.0/Branding-1
Per-tenant UI branding and theming for a frontend app (app names, logos, favicon, light/dark palettes, gradients). Singleton per tenant via rtWellKnownName = 'Branding'. Derives from UIElement (same as Dashboard, ProcessDiagram, SymbolDefinition, SymbolLibrary) — consistent with SystemUiCkModel convention.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System-2/Name | True | ||
| System-2/Description | True | ||
| System.UI-2/Branding.AppName | True | ||
| System.UI-2/Branding.AppTitle | True | ||
| System.UI-2/Branding.HeaderLogo | True | ||
| System.UI-2/Branding.FooterLogo | True | ||
| System.UI-2/Branding.Favicon | True | ||
| System.UI-2/Branding.LightTheme | True | ||
| System.UI-2/Branding.DarkTheme | True |
Dashboard
Inheritance: System-2.5.0/Entity-1 ➔ System.UI-2.10.0/UIElement-1 ➔ System.UI-2.10.0/Dashboard-1
A configurable dashboard containing multiple widgets arranged in a grid layout.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System-2/Name | False | ||
| System-2/Description | False | ||
| System.UI-2/Dashboard.Columns | False | ||
| System.UI-2/Dashboard.RowHeight | False | ||
| System.UI-2/Dashboard.Gap | False |
DashboardWidget
Inheritance: System-2.5.0/Entity-1 ➔ System.UI-2.10.0/UIElement-1 ➔ System.UI-2.10.0/DashboardWidget-1
A widget within a dashboard that displays data in a specific visualization format.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System-2/Name | False | ||
| System.UI-2/DashboardWidget.Type | False | ||
| System.UI-2/DashboardWidget.Col | False | ||
| System.UI-2/DashboardWidget.Row | False | ||
| System.UI-2/DashboardWidget.ColSpan | False | ||
| System.UI-2/DashboardWidget.RowSpan | False | ||
| System.UI-2/DashboardWidget.DataSourceType | False | ||
| System.UI-2/DashboardWidget.DataSourceCkTypeId | True | ||
| System.UI-2/DashboardWidget.DataSourceRtId | True | ||
| System.UI-2/DashboardWidget.Config | False |
Outbound Associations
| Outbound Name | Outbound Multiplicity | CkRoleId | TargetCKTypeId | Target Attributes |
|---|---|---|---|---|
| Parent | One | System-2/ParentChild | System.UI-2/Dashboard |
EntityForm
Inheritance: System-2.5.0/Entity-1 ➔ System.UI-2.10.0/UIElement-1 ➔ System.UI-2.10.0/EntityForm-1
Describes how the Refinery Studio lists, creates and edits entities of TargetCkTypeId (and, with IncludeDerivedTypes, its subtypes). Resolution: exact type first (tenant forms win over seeded ones, then Priority), then the nearest base type with IncludeDerivedTypes. The seeded form 'form-default' on System/Entity ends the chain, so every type has a form. Attributes a form does not mention are generated from CK metadata unless GenerateRemainingFields = false. Derives from UIElement (same as Branding, TreeNavigationConfiguration) — consistent with SystemUiCkModel convention.
Folder
Inheritance: System-2.5.0/Entity-1 ➔ System.UI-2.10.0/UIElement-1 ➔ System.UI-2.10.0/Folder-1
A folder of the Studio's library. Folders nest through FolderParent (top-level folders have no parent) and hold items (e.g. persistent queries) through FolderItem. Deleting a folder does not cascade - clients must move its subfolders and items up to the parent first.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System-2/Name | False | ||
| System-2/Description | True | ||
| System.UI-2/Folder.Scope | False | ||
| System.UI-2/Folder.SortOrder | True |
Outbound Associations
| Outbound Name | Outbound Multiplicity | CkRoleId | TargetCKTypeId | Target Attributes |
|---|---|---|---|---|
| Parent | ZeroOrOne | System.UI-2/FolderParent | System.UI-2/Folder |
Inbound Associations
| Inbound Name | Inbound Multiplicity | CkRoleId | TargetCKTypeId | Target Attributes |
|---|---|---|---|---|
| Children | N | System.UI-2/FolderParent | System.UI-2/Folder |
MappingCoverageConfiguration
Inheritance: System-2.5.0/Entity-1 ➔ System.UI-2.10.0/UIElement-1 ➔ System.UI-2.10.0/MappingCoverageConfiguration-1
Per-tenant configuration for the Mapping Coverage page (communication data-mappings). Stores which CK types act as mapping-source catalogues in the Orphan Sources tab (e.g. Loxone/Control, MQTT/Topic, OpcUa/Node) so the selection is shared by all operators of the tenant instead of living in browser localStorage. Singleton per tenant via rtWellKnownName = 'MappingCoverage'. Optional: when absent the Orphan Sources tab starts empty. Derives from UIElement (same as Branding, Dashboard, TreeNavigationConfiguration) — consistent with SystemUiCkModel convention.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System-2/Name | True | ||
| System-2/Description | True | ||
| System.UI-2/MappingCoverageConfiguration.SourceCandidateCkTypeIds | True |
ProcessDiagram
Inheritance: System-2.5.0/Entity-1 ➔ System.UI-2.10.0/UIElement-1 ➔ System.UI-2.10.0/ProcessDiagram-1
HMI-style process diagram with tanks, pipes, valves, pumps, and other industrial elements.
SymbolDefinition
Inheritance: System-2.5.0/Entity-1 ➔ System.UI-2.10.0/UIElement-1 ➔ System.UI-2.10.0/SymbolDefinition-1
A reusable symbol definition composed of primitives, belonging to a symbol library.
Outbound Associations
| Outbound Name | Outbound Multiplicity | CkRoleId | TargetCKTypeId | Target Attributes |
|---|---|---|---|---|
| Parent | One | System-2/ParentChild | System.UI-2/SymbolLibrary |
SymbolLibrary
Inheritance: System-2.5.0/Entity-1 ➔ System.UI-2.10.0/UIElement-1 ➔ System.UI-2.10.0/SymbolLibrary-1
A library containing reusable symbol definitions composed of primitives for process diagrams.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System-2/Name | False | ||
| System-2/Description | True | ||
| System.UI-2/SymbolLibrary.Version | False | ||
| System.UI-2/SymbolLibrary.Author | True | ||
| System.UI-2/SymbolLibrary.IsBuiltIn | True | ||
| System.UI-2/SymbolLibrary.IsReadOnly | True |
TreeNavigationConfiguration
Inheritance: System-2.5.0/Entity-1 ➔ System.UI-2.10.0/UIElement-1 ➔ System.UI-2.10.0/TreeNavigationConfiguration-1
Per-tenant configuration for the entity trees (repository browser + communication data-mappings). Overrides which auto-discovered association roles are shown, their label, order, grouping and icon (Roles), and defines additional switchable tree perspectives with their own root (Perspectives). Singleton per tenant via rtWellKnownName = 'TreeNavigation'. Optional: when absent the trees fall back to pure auto-discovery and the spatial perspective only. Derives from UIElement (same as Branding, Dashboard) — consistent with SystemUiCkModel convention.
| ID | Auto Complete Values | Auto Increment Reference | Is Optional |
|---|---|---|---|
| System-2/Name | True | ||
| System-2/Description | True | ||
| System.UI-2/TreeNavigationConfiguration.Roles | True | ||
| System.UI-2/TreeNavigationConfiguration.Perspectives | True |
UIElement
Inheritance: System-2.5.0/Entity-1 ➔ System.UI-2.10.0/UIElement-1 No description available currently.