Skip to main content

Attributes

Version: 2.10.0

Branding.AppName​

Full display name of the application (e.g. 'Maco Application').

Data Type​

STRING

Branding.AppTitle​

Text rendered into the browser tab (document.title).

Data Type​

STRING

Branding.DarkTheme​

Color palette applied when the user/system selects the dark theme. Leave unset for single-theme apps.

Data Type​

RECORD: System.UI-2/ThemePalette

Branding.Favicon​

Browser favicon.

Data Type​

BINARY

Logo displayed in the page footer.

Data Type​

BINARY

Logo displayed in the page header/topbar.

Data Type​

BINARY

Branding.LightTheme​

Color palette applied when the user/system selects the light theme.

Data Type​

RECORD: System.UI-2/ThemePalette

Dashboard.Columns​

Number of columns in the dashboard grid layout.

Data Type​

INT

Dashboard.Gap​

Gap between widgets in pixels.

Data Type​

INT

Dashboard.RowHeight​

Height of each row in pixels.

Data Type​

INT

DashboardWidget.Col​

Column position in the grid (1-based).

Data Type​

INT

DashboardWidget.ColSpan​

Number of columns the widget spans.

Data Type​

INT

DashboardWidget.Config​

JSON configuration for widget-specific settings.

Data Type​

STRING

DashboardWidget.DataSourceCkTypeId​

Construction kit type ID for the data source.

Data Type​

STRING

DashboardWidget.DataSourceRtId​

Runtime entity ID for the data source (optional).

Data Type​

STRING

DashboardWidget.DataSourceType​

Type of data source (runtimeEntity, systemQuery, static).

Data Type​

STRING

DashboardWidget.Row​

Row position in the grid (1-based).

Data Type​

INT

DashboardWidget.RowSpan​

Number of rows the widget spans.

Data Type​

INT

DashboardWidget.Type​

Widget type identifier (entityCard, kpi, entityWithAssociations, table).

Data Type​

STRING

EntityForm.CanCreate​

Whether the list view offers creating new entities of this type. Absent = true.

Data Type​

BOOLEAN

EntityForm.CanDelete​

Whether the list view offers deleting entities of this type. Absent = true.

Data Type​

BOOLEAN

EntityForm.CanDuplicate​

Whether the list view offers duplicating an entity (opens the create form prefilled with its values). Absent = false.

Data Type​

BOOLEAN

EntityForm.CanEdit​

Whether existing entities of this type can be edited; false renders the form read-only. Absent = true.

Data Type​

BOOLEAN

EntityForm.CanExport​

Whether the list view offers exporting entities of this type. Absent = false.

Data Type​

BOOLEAN

EntityForm.Category​

Free-text grouping label for the type in the Studio's entity navigation (e.g. 'Energy', 'Configuration'). Absent = the type is listed under its CK model.

Data Type​

STRING

EntityForm.CustomComponent​

Key of a dedicated frontend component that replaces the generated form for this type (e.g. for editors the generic form cannot express). Unknown keys fall back to the generated form. Absent = generated form.

Data Type​

STRING

EntityForm.Fields​

Per-attribute presentation and validation overrides. Absent / empty = every attribute is generated from CK metadata (when GenerateRemainingFields is not false).

Data Type​

Array of RECORD_ARRAY: System.UI-2/EntityFormField

EntityForm.GenerateRemainingFields​

Whether attributes of the target type that no EntityFormField mentions are generated from CK metadata and appended in an extra section titled GeneratedSectionTitle. false = only the listed Fields are shown. Absent = true.

Data Type​

BOOLEAN

EntityForm.GeneratedSectionTitle​

Title of the section holding the generated remaining fields (see GenerateRemainingFields). Absent = 'Further attributes'.

Data Type​

STRING

EntityForm.Icon​

Optional icon name for the type's list and form header, resolved by the frontend against its known icon set. Absent = default entity icon.

Data Type​

STRING

EntityForm.IncludeDerivedTypes​

Whether the form also applies to subtypes of TargetCkTypeId that have no form of their own (the nearest base type wins). Absent = false: the form applies to TargetCkTypeId only.

Data Type​

BOOLEAN

EntityForm.ListColumns​

Columns of the entity list view, in definition order. Absent / empty = columns are derived from CK metadata.

Data Type​

Array of RECORD_ARRAY: System.UI-2/EntityFormColumn

EntityForm.Priority​

Tie-breaker when several forms target the same type at the same source level (tenant forms always win over seeded ones first); the highest Priority wins. Absent = 0.

Data Type​

INT

EntityForm.Sections​

Sections (group boxes) the form is divided into; fields are assigned via EntityFormField.SectionKey. Absent / empty = a single generated section.

Data Type​

Array of RECORD_ARRAY: System.UI-2/EntityFormSection

EntityForm.Singleton​

Whether the type is a per-tenant singleton: the Studio skips the list and opens the one entity (identified by SingletonWellKnownName) directly, creating it on first save. Absent = false.

Data Type​

BOOLEAN

EntityForm.SingletonWellKnownName​

rtWellKnownName of the singleton entity when Singleton = true (e.g. 'TreeNavigation', 'MappingCoverage'). Ignored when Singleton is absent or false. Absent with Singleton = true = the first entity of the type is used.

Data Type​

STRING

EntityForm.TargetCkTypeId​

Runtime CK type id this form describes (e.g. 'EnergyIQ/Space', 'System/Entity'). Required. Resolution prefers a form whose TargetCkTypeId equals the entity's type; otherwise the nearest base type whose form sets IncludeDerivedTypes = true.

Data Type​

STRING

EntityFormColumn.AttributePath​

Attribute of the target type shown in this list column, by attribute name (e.g. 'Name', 'Address.City'). Required. Paths that match no attribute of the type are ignored.

Data Type​

STRING

EntityFormColumn.Display​

How the cell value is rendered. Allowed values: 'text', 'chip', 'date', 'mono'. Absent = 'text'; unknown values behave as 'text'.

Data Type​

STRING

EntityFormColumn.Label​

Column header. Absent = the attribute name, humanized.

Data Type​

STRING

EntityFormColumn.Width​

Column width in pixels. Absent = auto.

Data Type​

INT

EntityFormField.AssociationRoleId​

For Editor 'reference': association role id the selection is stored in (e.g. 'System/ParentChild') instead of an attribute. Absent = the selection is stored in the attribute at AttributePath.

Data Type​

STRING

EntityFormField.AttributePath​

Attribute of the target type this field configures, by attribute name (e.g. 'Name', 'Address.City' for a nested record attribute). Required. Paths that match no attribute of the type are ignored.

Data Type​

STRING

EntityFormField.Default​

Initial value prefilled when creating a new entity, as a string parsed according to the attribute value type. Absent = the CK attribute default, if any, otherwise empty.

Data Type​

STRING

EntityFormField.Editor​

Editor widget for the field. Allowed values: 'auto', 'text', 'multiline', 'password', 'number', 'toggle', 'enum', 'datetime', 'url', 'email', 'json', 'yaml', 'cron', 'reference', 'records'. Absent = 'auto' (derived from the attribute value type); unknown values behave as 'auto'.

Data Type​

STRING

EntityFormField.Help​

Help text shown with the field. Absent = the CK attribute description, if any.

Data Type​

STRING

EntityFormField.Hidden​

Whether the field is omitted from the form (the attribute is neither shown nor generated). Absent = false.

Data Type​

BOOLEAN

EntityFormField.Label​

Label shown for the field. Absent = the attribute name, humanized.

Data Type​

STRING

EntityFormField.Max​

Maximum allowed value for numeric attributes (inclusive). Ignored for non-numeric attributes. Absent = no upper bound.

Data Type​

DOUBLE

EntityFormField.Min​

Minimum allowed value for numeric attributes (inclusive). Ignored for non-numeric attributes. Absent = no lower bound.

Data Type​

DOUBLE

EntityFormField.Order​

Ordering hint among the fields of its section (ascending). Absent = definition order, after fields with an explicit Order.

Data Type​

INT

EntityFormField.Pattern​

Regular expression the string value must match. Absent = no pattern check.

Data Type​

STRING

EntityFormField.Placeholder​

Placeholder text shown in an empty input. Absent = no placeholder.

Data Type​

STRING

EntityFormField.ReadOnly​

When the field is read-only. Allowed values: 'never' (editable), 'always', 'afterCreate' (editable only while creating, read-only when editing an existing entity). Absent = 'never'; unknown values behave as 'never'.

Data Type​

STRING

EntityFormField.RecordColumns​

For Editor 'records' (RecordArray attributes): the record attributes shown as grid columns, each entry 'Path:Label' (Label optional, e.g. 'Key:Key', 'DisplayName:Name'). Absent / empty = columns derived from the record's CK metadata.

Data Type​

STRING_ARRAY

EntityFormField.ReferenceCkTypeId​

For Editor 'reference': runtime CK type id whose entities are offered for selection (e.g. 'EnergyIQ/Space'). Absent = derived from the attribute or association metadata.

Data Type​

STRING

EntityFormField.ReferenceDisplayAttributes​

For Editor 'reference': comma-separated attributes of the referenced entities shown next to their name in the picker and for the current value, by attribute name in camelCase (e.g. 'repositoryUrl,channel'; a String, not a StringArray, because record values in blueprint seeds must be scalars); the picker reads exactly these attributes. List only non-secret attributes (a Secret attribute's value is never returned, so it would show nothing). Absent / empty = the name only.

Data Type​

STRING

EntityFormField.Required​

Whether a value is mandatory. Absent = taken from the model (the attribute's isOptional). true makes an optional attribute mandatory in the form; false cannot loosen an attribute the model declares mandatory.

Data Type​

BOOLEAN

EntityFormField.Secret​

Whether the value is masked in the form and list (shown as dots, revealed on demand). Absent = false.

Data Type​

BOOLEAN

EntityFormField.SectionKey​

Key of the EntityFormSection this field belongs to. Absent or unknown key = the field goes into the first section (or the single generated section when no Sections are defined).

Data Type​

STRING

EntityFormField.VisibleWhen​

Condition on another attribute that controls visibility, as 'AttributePath=value' (visible when that attribute equals value) or 'AttributePath=*' (visible when that attribute has any value). Absent = always visible.

Data Type​

STRING

EntityFormField.Width​

Horizontal size of the field in a two-column section. Allowed values: 'full', 'half'. Absent = 'full'; unknown values behave as 'full'.

Data Type​

STRING

EntityFormSection.Collapsed​

Whether the section starts collapsed. Absent = false (expanded).

Data Type​

BOOLEAN

EntityFormSection.Columns​

Number of field columns in the section layout: 1 or 2. Absent = 1. Other values behave as 1.

Data Type​

INT

EntityFormSection.Description​

Optional explanatory text shown below the section heading. Absent = no text.

Data Type​

STRING

EntityFormSection.Key​

Stable identifier of the section, unique within the form; referenced by EntityFormField.SectionKey. Required.

Data Type​

STRING

EntityFormSection.Order​

Ordering hint among sections (ascending). Absent = definition order, after sections with an explicit Order.

Data Type​

INT

EntityFormSection.Title​

Heading shown for the section. Absent = Key is shown.

Data Type​

STRING

Folder.Scope​

Library section the folder belongs to (e.g. "Queries"). Folders of different scopes form separate trees.

Data Type​

STRING

Folder.SortOrder​

Optional position of the folder among its siblings (ascending); folders without a value sort by name.

Data Type​

INT

MappingCoverageConfiguration.SourceCandidateCkTypeIds​

Runtime CK type ids whose entities act as mapping-source candidates in the Mapping Coverage page's Orphan Sources tab (e.g. 'Loxone/Control', 'MQTT/Topic', 'OpcUa/Node'). Absent / empty = the tab starts without a source catalogue and hides itself until a type is configured.

Data Type​

STRING_ARRAY

ProcessDiagram.Animations​

JSON array of animation definitions (rotation, blink, pulse, motion path) for diagram elements.

Data Type​

STRING

ProcessDiagram.CanvasBackgroundColor​

Background color (CSS color or 'transparent').

Data Type​

STRING

ProcessDiagram.CanvasHeight​

Canvas height in pixels.

Data Type​

INT

ProcessDiagram.CanvasWidth​

Canvas width in pixels.

Data Type​

INT

ProcessDiagram.Connections​

JSON array of connection configurations between elements.

Data Type​

STRING

ProcessDiagram.Elements​

JSON array of process element configurations (tanks, valves, pumps, etc.).

Data Type​

STRING

ProcessDiagram.Primitives​

JSON array of primitive shape configurations (rectangles, ellipses, lines, polygons, paths, text, images).

Data Type​

STRING

ProcessDiagram.PropertyBindings​

JSON array of property bindings connecting transform properties to element/primitive attributes with expressions.

Data Type​

STRING

ProcessDiagram.RefreshInterval​

Global refresh interval in milliseconds (0 = no auto-refresh).

Data Type​

INT

ProcessDiagram.SymbolInstances​

JSON array of symbol instance configurations (references to symbols from libraries with position, scale, rotation).

Data Type​

STRING

ProcessDiagram.TransformProperties​

JSON array of exposed transform properties (id, name, type, defaultValue, min, max) that can be bound to runtime data.

Data Type​

STRING

ProcessDiagram.Variables​

JSON array of variable definitions for parameterization.

Data Type​

STRING

ProcessDiagram.Version​

Schema version for migrations (e.g., "1.0.0").

Data Type​

STRING

SymbolDefinition.BoundsHeight​

Default height of the symbol in pixels.

Data Type​

INT

SymbolDefinition.BoundsWidth​

Default width of the symbol in pixels.

Data Type​

INT

SymbolDefinition.CanvasSizeHeight​

Preferred canvas height for the symbol editor.

Data Type​

INT

SymbolDefinition.CanvasSizeWidth​

Preferred canvas width for the symbol editor.

Data Type​

INT

SymbolDefinition.Category​

Category for grouping symbols (e.g., "Tanks", "Valves", "Sensors").

Data Type​

STRING

SymbolDefinition.ConnectionPoints​

JSON array of connection point definitions for wiring symbols together.

Data Type​

STRING

SymbolDefinition.GridSize​

Grid size for the symbol editor (default 10).

Data Type​

INT

SymbolDefinition.Parameters​

JSON array of customizable parameter definitions.

Data Type​

STRING

SymbolDefinition.PreviewImage​

Preview image as data URL or external URL.

Data Type​

STRING

SymbolDefinition.Primitives​

JSON array of primitive configurations that make up this symbol (positions relative to 0,0).

Data Type​

STRING

SymbolDefinition.SymbolInstances​

JSON array of nested symbol instances within this symbol.

Data Type​

STRING

SymbolDefinition.Tags​

Comma-separated tags for filtering and searching.

Data Type​

STRING

SymbolDefinition.Version​

Symbol version for tracking changes (e.g., "1.0.0").

Data Type​

STRING

SymbolLibrary.Author​

Author name or identifier.

Data Type​

STRING

SymbolLibrary.IsBuiltIn​

Whether this is a system-provided built-in library.

Data Type​

BOOLEAN

SymbolLibrary.IsReadOnly​

Whether this library is read-only (cannot be modified by users).

Data Type​

BOOLEAN

SymbolLibrary.Version​

Library version for tracking changes (e.g., "1.0.0").

Data Type​

STRING

ThemeGradient.EndColor​

Gradient end color (hex).

Data Type​

STRING

ThemeGradient.StartColor​

Gradient start color (hex).

Data Type​

STRING

ThemePalette.BackgroundColor​

Page/surface background color (not derived from any palette base).

Data Type​

STRING

ThemePalette.FooterGradient​

Gradient applied to the footer. Rendered as linear-gradient(90deg, start, end).

Data Type​

RECORD: System.UI-2/ThemeGradient

ThemePalette.HeaderGradient​

Gradient applied to the header/topbar. Rendered as linear-gradient(90deg, start, end).

Data Type​

RECORD: System.UI-2/ThemeGradient

ThemePalette.NeutralColor​

Base for the neutral family (base/border/subtle).

Data Type​

STRING

ThemePalette.PrimaryColor​

Base for the primary Kendo color family; full palette generated via HSL math.

Data Type​

STRING

ThemePalette.SecondaryColor​

Base for the secondary Kendo color family.

Data Type​

STRING

ThemePalette.TertiaryColor​

Base for the tertiary Kendo color family.

Data Type​

STRING

TreeNavigationConfiguration.Perspectives​

Additional switchable tree perspectives (each with its own root + navigation whitelist) offered next to the built-in spatial perspective. Absent / empty = only the spatial perspective (today's behaviour); the perspective switcher is hidden.

Data Type​

Array of RECORD_ARRAY: System.UI-2/TreePerspectiveConfig

TreeNavigationConfiguration.Roles​

Per-association overrides applied on top of the auto-discovered association roles in the entity trees (repository browser + data-mappings). Absent / empty = pure auto-discovery.

Data Type​

Array of RECORD_ARRAY: System.UI-2/TreeNavigationRoleConfig

TreeNavigationRoleConfig.DisplayName​

Overrides the group node label. Absent = the association's navigation property name.

Data Type​

STRING

TreeNavigationRoleConfig.Grouped​

Whether the role renders as an expandable group node (true) or its targets are flattened directly under the entity (false). Absent = flat for System/ParentChild, grouped for every other role.

Data Type​

BOOLEAN

TreeNavigationRoleConfig.Icon​

Optional icon name for the group node, resolved by the frontend against its known icon set. Absent = default folder icon.

Data Type​

STRING

TreeNavigationRoleConfig.RoleId​

Runtime association role id this rule applies to (e.g. 'EnergyIQ/SpaceSensors', 'System/ParentChild').

Data Type​

STRING

TreeNavigationRoleConfig.SortIndex​

Ordering hint among group nodes (ascending). Absent = default discovery order after the flattened ParentChild children.

Data Type​

INT

TreeNavigationRoleConfig.SourceCkTypeId​

Runtime CK type id of the entity being expanded that this rule applies to (e.g. 'EnergyIQ/Space'), or '*' to match every type.

Data Type​

STRING

TreeNavigationRoleConfig.Visible​

Whether the role is shown in the tree. Absent = visible.

Data Type​

BOOLEAN

TreePerspectiveConfig.DisplayName​

Label shown for this perspective in the tree toolbar switcher.

Data Type​

STRING

TreePerspectiveConfig.Icon​

Optional icon name for the switcher entry, resolved by the frontend against its known icon set. Absent = default perspective icon.

Data Type​

STRING

TreePerspectiveConfig.Key​

Stable identifier of the perspective, unique within the tenant (e.g. 'Spatial', 'Systems'). Used to persist the user's active-perspective choice.

Data Type​

STRING

TreePerspectiveConfig.PrimaryDirection​

Direction the primary role is navigated from the root node: 'Inbound' or 'Outbound'. Absent = the containment ('N') side, matching auto-discovery.

Data Type​

STRING

TreePerspectiveConfig.PrimaryRoleId​

Association role navigated as the primary axis directly under each root node; its targets are flattened at the top (like System/ParentChild in the spatial view). E.g. 'EnergyIQ/SystemMembers'. Absent = no primary flattening.

Data Type​

STRING

TreePerspectiveConfig.RootCkTypeId​

Runtime CK type id whose instances form the root nodes when RootMode = 'Type' (e.g. 'EnergyIQ/DistributionSystem'). Ignored for RootMode = 'Spatial'.

Data Type​

STRING

TreePerspectiveConfig.RootMode​

How the perspective determines its root nodes: 'Spatial' = all Basic/Tree entities (the built-in ParentChild default), 'Type' = all runtime instances of RootCkTypeId.

Data Type​

STRING

TreePerspectiveConfig.SecondaryRoleIds​

Additional association roles shown as group nodes directly under each root node. Together with PrimaryRoleId these form the root-level whitelist; deeper nodes fall back to full auto-discovery. Absent / empty = only the primary role at the root.

Data Type​

STRING_ARRAY

TreePerspectiveConfig.SortIndex​

Ordering hint among perspectives in the switcher (ascending). Absent = definition order.

Data Type​

INT