Aliases

An alias references one or more entities and serves as a widget data source.

Aliases are static (pre-selected entities) or dynamic (resolved at runtime by entity type, relations, or dashboard state).

Create an alias from the dashboard toolbar or while configuring a widget.

From the dashboard toolbar:

1. Open the dashboard and switch to Edit mode.
2. Click the Entity aliases icon in the toolbar.
3. In the Entity aliases dialog, click Add alias.
4. Enter an Alias name, select a Filter type, fill in its fields, and click Add.
5. Click Save.

While configuring a widget:

1. Click the pencil icon on the widget to open its settings.
2. In the Datasource section, switch to Entity alias.
3. Type the new alias name and click Create a new one!.
4. Configure the alias and click Add.
5. Click Apply and save the dashboard. The alias is created and assigned in one step.

Open the widget settings, switch Datasource to Entity alias, and select an alias. Add the data keys and click Apply.

1. Open the dashboard, switch to Edit mode, and click the Entity aliases icon in the toolbar.
2. Click the pencil icon next to the alias you want to edit.
3. Update the configuration and click Save.
4. Click Save in the Entity aliases dialog.

1. Open the dashboard, switch to Edit mode, and click the Entity aliases icon in the toolbar.
2. Click the X icon next to the alias you want to delete.
3. Click Save in the Entity aliases dialog.

The following alias types are available for dashboard widgets.

The Resolve as multiple entities toggle in the alias dialog controls whether the alias can return more than one entity. It is enabled by default for multi-entity types, such as Entity list and Entity type, and disabled for single-entity types. Single-value widgets, such as value cards, use single-entity aliases; tables and charts typically use multi-entity aliases.

Resolves to one entity, chosen by type and name. Example: set Type to Device and the entity to “Thermometer A1” — the widget shows only that device’s data.

Resolves to every entity in the selected entity group. Example: set Type to Device and the entity group to “Thermostats” — the widget shows every device in that group (Thermometer A1, A2, A3).

Resolves to a fixed list of individually selected entities. Example: list Thermometer A1, Compressor BC-10, and Compressor QA-32 — the widget shows data for those three devices only.

Resolves to every entity of a chosen type whose name starts with the entered text. Example: set Type to Device and the name filter to “Compressor” — the widget shows every device whose name starts with “Compressor” (Compressor BC-10, Compressor QA-32).

Resolves to every entity of a chosen type in the tenant, including customer-owned entities. Example: set Type to Device — the widget shows every device.

Resolves to selected entity groups of a chosen type. Example: set Type to Device and list the groups Compressors and Thermostats — the widget shows those two group names.

Resolves to every entity group whose name starts with the entered text. Example: set Type to Device and the name filter to “Compressor” — the widget shows every device group whose name starts with “Compressor” (Compressors).

Resolves to every entity in the group with an exact name match. Example: set Type to Device and the group name to “Compressors” — the widget shows every device in that group (Compressor BC-10, Compressor QA-32).

Resolves to the entity passed in through a dashboard state parameter — the basis of drill-down dashboards. A widget action, such as a click on a table row, passes the selected entity to the target state, and widgets in that state use this alias to show its data.

Example: clicking a device row opens a detail state with that device’s data.

1. Add a dashboard state for the detail view (for example, named ${entityName}).
2. In the settings of the widget that lists your entities, such as an Entities table, add an action with the type Navigate to new dashboard state, select the new state as the target, and enable Set entity from widget.
3. In the detail state, add a widget that uses an Entity from dashboard state alias. Keep the state entity parameter as By default unless the action uses a custom parameter name.
4. Save the dashboard. Clicking a row in the table now opens the detail state for the selected entity.

Resolves to the owner of the entity from the current dashboard state — the tenant or customer it belongs to. Use it in customer-hierarchy dashboards to show the owner of a selected device without extra navigation.

Example: a device list with a second widget that shows the owner of the clicked device.

1. Create an alias with filter type Owner of entity from dashboard state.
2. Add a widget that uses this alias to display the owner.
3. In the Entities table widget settings, add an action with the source On row click and the type Update current dashboard state, and enable Set entity from widget.
4. Save the dashboard. Clicking a device row now shows that device’s owner in the second widget.

Resolves to assets of a chosen asset profile, optionally filtered by name prefix. Example: set the asset profile to “buildings” and the name filter to “Build” — the widget shows Building A and Building B.

Resolves to devices of a chosen device profile, optionally filtered by name prefix. Example: set the device profile to “thermometers” and the name filter to “Therm” — the widget shows Thermometer A1, A2, and A3.

Resolves to entity views of a chosen type, optionally filtered by name prefix. Example: set the entity view type to “Compressors Entity View Type” — the widget shows Compressor BC-10 Entity View and Compressor QA-32 Entity View.

Resolves to edges of a chosen type, optionally filtered by name prefix. Example: set the edge type to “edge instances” and the name filter to “Edge” — the widget shows Edge instance 1 and Edge instance 2.

Resolves to the tenant’s API usage statistics entity; no filters are required. Widgets can display its fields, such as emailApiState.

Resolves to the entities connected to a root entity by relations, traversed in a chosen direction up to a chosen depth. Example: set the root entity to asset “District A”, direction to “From”, and the max relation level to 3 — the widget shows every entity related to “District A” up to 3 levels deep.

Like Relations query, but returns only the assets of the chosen profiles. Example: set the root entity to device “Compressor QA-32”, direction to “To”, and the asset types to “district” and “buildings”.

Like Relations query, but returns only the devices of the chosen profiles. Example: set the root entity to asset “Building A”, direction to “From”, and the device type to “compressors”.

Like Relations query, but returns only the entity views of the chosen types. Example: set the root entity to asset “Building A”, direction to “From”, and the entity view type to “Compressors Entity View Type”.

Like Relations query, but returns only the edges of the chosen types. Example: set the root entity to asset “Building A”, direction to “From”, and the edge type to “edge instances”.

Resolves to the scheduler events of a chosen originator entity, optionally filtered by event type. Example: set the originator to device “Compressor BC-10” and leave the event type empty to match any type — the widget shows every scheduler event of that device.

Subreport templates support all aliases listed above, plus two aliases that resolve to the entity passed from the master report:

Alias	Resolves to
Entity from master report	The entity passed from the master report. If the master report’s datasource returns several entities, one subreport instance is generated per entity.
Owner of entity from master report	The customer or tenant that owns that entity.

Report templates support all aliases listed above. Notification-triggered reports add two aliases that resolve to the entity that initiated the report:

Alias	Resolves to
Originator entity	The entity that triggered the notification, for example, the device that raised an alarm.
Owner of originator entity	The customer or tenant that owns the originator entity.