Aliases

• Alias types
  • Single entity
  • Entity list
  • Entity name
  • Asset type
  • Device types
  • Relations query
  • Asset search query
  • Device search query
  • Entity view search query

In order to create a dashboard, aliases have to be created first in order to define data from which entities will be used. Aliases can be as easy as referring to a single device or as complicated as creating a complex search query for specific assets from a list.

In this guide aliases will be used on a system with a following scheme:

and all devices have “water_level” generated values coming to them.

Alias types

Single entity

This alias allows choosing a single entity. It can be a device, asset, entity view, tenant, customer, dashboard, data converter, scheduler event, blob entity, or current customer. In the example, an alias was created that filters one device, which in this case is Device A.

Let’s learn how to add a Single entity alias:

• Enter dashboard editing mode.
• In the upper right corner of the window, click the “Entity alias” icon.
• In the opened Entity aliases window, click the “Add alias” button on the left side of - the dialog box.
• In the opened dialog Add alias, enter a name for the alias, select a Single entity filter type. From the Type drop-down menu, Select the Device and enter the name of the needed device (start typing it and it will be found automatically).
• After configuring the alias, click the “Add” button in the lower right corner.
• We can now see that a new alias has been added. Click “Save” in the lower right corner of the dialog box.

Let’s use an added alias in a widget:

• Click the “Add new widget” icon in the center of the screen.
• In the opened widget bundles selection, click “Cards system”. There select the Entity table widget.
• Input data source: Entity type, select alias name from the list, and add telemetry.
• Click the “Add” button in the lower right corner of the dialog box.
• Widget with alias that filters one device has been added.
• Don’t forget to save all the changes by clicking on the big orange checkmark in the lower right corner of the screen.

Now let’s use the added alias in a widget:

• Click the “Add new widget” icon in the center of the screen.
• In the opened widget bundles selection, click “Cards system”. There select the Entity table widget.
• Input data source: Entity type, select the name of the created alias from the list, and add telemetry.
• Click the “Add” button in the lower right corner of the dialog box.
• Widget with alias that filters a group of devices, which in this case is Irrigation systems, has been added.
• Don’t forget to save all the changes by clicking on the big orange checkmark in the lower right corner of the screen.

Entity list

This alias allows choosing several entities manually without entering a query, which can be devices, assets, entity views, tenants, customers, dashboards, data converters, scheduler events, blob entities, or customers. In this example, an alias was created that filters a list of multiple devices, which in this case are Device D and Device E.

Let’s learn how to add an Entity list alias:

• Enter dashboard editing mode.
• In the upper right corner of the window, click the “Entity alias” icon.
• In the opened Entity aliases window, click the “Add alias” button on the left side of the dialog box.
• In the opened dialog Add alias, enter a name for the alias, select an Entity list filter type. From the Type drop-down menu, Select the Device and input names of the individual devices (start typing it and it will be found automatically).
• After configuring the alias, click the “Add” button in the lower right corner.
• We can now see that a new alias has been added. Click “Save” in the lower right corner of the dialog box

Now let’s use the added alias in a widget:

• Click the “Add new widget” icon in the center of the screen.
• In the opened widget bundles selection, click “Cards system”. There select the Entity table widget.
• Input data source: Entity type, select the name of the created alias from the list, and add telemetry.
• Click the “Add” button in the lower right corner of the dialog box.
• Widget with alias that filters a list of several devices, which in this case are Device D and Device E, has been added.
• Don’t forget to save all the changes by clicking on the big orange checkmark in the lower right corner of the screen.

Entity name

This alias allows choosing one or more entity names that begin with an entered query, which can be devices, assets, entity views, tenants, customers, dashboards, data converters, scheduler events, blob entities, or customers. In this example, an alias was created to filter devices that start with “Device”.

Let’s learn how to add an Entity name alias:

• Enter dashboard editing mode.
• In the upper right corner of the window, click the “Entity alias” icon.
• In the opened Entity aliases window, click the “Add alias” button on the left side of the dialog box.
• In the opened dialog Add alias, enter a name for the alias, select the filter type Entity name. From the Type drop-down menu, Select the Device and enter a name, or just the beginning of the name, by which devices will be filtered.
• After configuring the alias, click the “Add” button in the lower right corner.
• We can now see that a new alias has been added. Click “Save” in the lower right corner of the dialog box..

Now let’s use the added alias in a widget:

• Click the “Add new widget” icon in the center of the screen.
• In the opened widget bundles selection, click “Cards system”. There select the Entity table widget.
• Input data source: Entity type, select the name of the created alias from the list, and add telemetry.
• Click the “Add” button in the lower right corner of the dialog box.
• Widget with alias that filters devices, which names start with ‘Device’, has been added.
• Don’t forget to save all the changes by clicking on the big orange checkmark in the lower right corner of the screen.

Now let’s use the added alias in a widget:

• Click the “Add new widget” icon in the center of the screen.
• In the opened widget bundles selection, click “Cards system”. There select the Entity table widget.
• Input data source: Entity type and Entity group list alias. Click “Add” in the lower right corner to add a widget.
• After adding the widget, click the “pencil” icon in the upper right corner to enter the widget editing mode.
• Move to the Action cell and click a “+” icon to add a new action.
• In the Add widget dialog, select an action source which is responsible for each entity separately (action cell button, on row click etc.)
• Enter the name of the action ${entityName} which takes the name of the clicked entity and uses it during the action.
• If necessary, select the icon representing the button to perform the action.
• Select the Update current dashboard state action type and click “Add” to add a new action to the widget.
• After successfully adding the action, click the large orange checkmark in the upper right of the screen to apply the changes.
• Now, add a widget on which action will be performed by clicking the orange “+” icon in the lower right corner of the screen and choosing a “Paper” icon (“Create new widget”).
• In the opened widget bundles selection, click “Cards system”. There select the Entity table widget.
• Input data source: Entity type and group entities alias and add telemetry. Click “Add” in the lower right corner.
• After adding both widgets, click the checkmark in the lower right corner of the screen.
• To execute an action and filter aliases by device groups, click the action cell button.

Now let’s use the added alias in a widget:

• Click the “Add new widget” icon in the center of the screen.
• In the opened widget bundles selection, click “Cards system”. There select the Entity table widget.
• Input data source: Entity type and Entity group name alias. Click “Add” in the lower right corner to add a widget.
• After adding the widget, click the “pencil” icon in the upper right corner to enter the widget editing mode.
• Move to the Action cell and click a “+” icon to add a new action.
• In the Add widget dialog, select an action source which is responsible for each entity separately (action cell button, on row click etc.)
• Enter the name of the action ${entityName} which takes the clicked on entity’s name and uses it during the action.
• If necessary, select the icon representing the button to perform the action.
• Select the Update current dashboard state action type and click “Add” to add a new action to the widget.
• After successfully adding the action, click big orange tick mark in the upper right of the screen to apply the changes.
• Now, add a widget on which action will be performed by clicking the orange “+” icon in the lower right corner of the screen and choosing a “Paper” icon (“Create new widget”).
• In the opened widget bundles selection, click “Cards system”. There select the Entity table widget.
• Input data source: Entity type and group entities alias and add telemetry. Click “Add” in the lower right corner. -After adding both widgets, click the checkmark in the lower right corner of the screen.

Asset type

This alias allows choosing assets of entered type (and, if needed) names of which begin with an entered query. This alias filters assets of type ‘field’ and with name starting with ‘House’.

Let’s learn how to add an Asset type alias and use it in a widget:

• Enter dashboard editing mode.
• In the upper right corner of the window, click the “Entity alias” icon.
• In the opened Entity aliases window, click the “Add alias” button on the left side of the dialog box.
• In the opened dialog Add alias, enter a name for the alias, select a Asset type filter type.
• Select asset type from the drop-down menu and enter the beginning of the asset name. Click “Add” in the lower right corner of the dialog box.
• After the alias has been added, click “Save” in the lower right corner of the dialog box.
• Click the “Add new widget” icon in the center of the screen.
• In the opened widget bundles selection, click “Cards system”. There select the Entity table widget.
• Input data source: Entity type, Asset type alias and click “Add” in the lower right corner to add a widget.
• After adding the widget, click a big tick icon in the lower right corner of the screen to save all applied changes.

Device types

This alias allows choosing devices of entered type (and, if needed) names of which begin with an entered query. This alias filters devices of type ‘Temperature Sensor’.

Let’s learn how to add a Device types alias and use it in a widget:

• Enter dashboard editing mode.
• In the upper right corner of the window, click the “Entity alias” icon.
• In the opened Entity aliases window, click the “Add alias” button on the left side of the dialog box.
• In the opened dialog Add alias, enter a name for the alias, select a Device types filter type.
• Choose previously created device type from the drop-down menu and click “Add” in the lower right corner of the dialog box.
• After the alias has been added, click “Save” in the lower right corner of the dialog box.
• Click the “Add new widget” icon in the center of the screen.
• In the opened widget bundles selection, click “Cards system”. There select the Entity table widget.
• Input data source: Entity type, Device types alias and add telemetry. Click “Add” in the lower right corner to add a widget.
• After adding the widget, click a big tick icon in the lower right corner of the screen to save all applied changes.

Relations query

This alias allows choosing entities which are related to specified originator up to specified level and in specified direction.

In the example alias filters entities that have any relation from Asset ‘Street A’ up to relation level 2.

Let’s learn how to add a Relations query alias and use it in a widget:

• Enter dashboard editing mode.
• In the upper right corner of the window, click the “Entity alias” icon.
• In the opened Entity aliases window, click the “Add alias” button on the left side of the dialog box.
• In the opened dialog Add alias, enter a name for the alias, select a Relations query filter type.
• Select the Asset type and choose an asset. Set direction to “From” and max relation level 2.
• Click “Add” in the lower right corner of the dialog box.
• After the alias has been added, click “Save” in the lower right corner of the dialog box.
• Click the “Add new widget” icon in the center of the screen.
• In the opened widget bundles selection, click “Cards system”. There select the Entity table widget.
• Input data source: Entity type, Relations query alias and add telemetry. Click “Add” in the lower right corner to add a widget.
• After adding the widget, click a big tick icon in the lower right corner of the screen to save all applied changes.
• This alias allows to choose entities which are related to specified originator up to specified level and in specified
• direction.

This alias filters entities that have any relation from Asset ‘Street A’ up to relation level 2.

Asset search query

This alias allows choosing assets of specified type which are related to specified originator up to specified level and in specified direction. This alias filters assets with types ‘field’ that have any relation to Device ‘Device D’ with relation level 1.

Let’s learn how to add an Asset search query alias and use it in a widget:

• Enter dashboard editing mode.
• In the upper right corner of the window, click the “Entity alias” icon.
• In the opened Entity aliases window, click the “Add alias” button on the left side of the dialog box.
• In the opened dialog Add alias, enter a name for the alias, select a Asset search query filter type.
• Select the Device type and choose a device. Set direction to “To” and max relation level 2. Input asset type.
• Click “Add” in the lower right corner of the dialog box.
• After the alias has been added, click “Save” in the lower right corner of the dialog box.
• Click the “Add new widget” icon in the center of the screen.
• In the opened widget bundles selection, click “Cards system”. There select the Entity table widget.
• Input data source: Entity type, Asset search query alias and add telemetry. Click “Add” in the lower right corner to add a widget.
• After adding the widget, click a big tick icon in the lower right corner of the screen to save all applied changes.

Device search query

Device search query This alias allows choosing devices of specified type which are related to specified originator up to specified level and in specified direction. This alias filters devices with types ‘Device’ that have any relation from Asset ‘House C’ up to relation level 1.

Let’s learn how to add a Device search query alias and use it in a widget:

• Enter dashboard editing mode.
• In the upper right corner of the window, click the “Entity alias” icon.
• In the opened Entity aliases window, click the “Add alias” button on the left side of the dialog box.
• In the opened dialog Add alias, enter a name for the alias, select a Device search query filter type.
• Select the Asset type and choose an asset. Set direction to “From” and max relation level 1. Input device type.
• Click “Add” in the lower right corner of the dialog box.
• After the alias has been added, click “Save” in the lower right corner of the dialog box.
• Click the “Add new widget” icon in the center of the screen.
• In the opened widget bundles selection, click “Cards system”. There select the Entity table widget.

This alias filters devices with types ‘Device’ that have any relation from Asset ‘House C’ up to relation level 1.

Entity view search query

Entity view search query This alias allows choosing entity views of specified type which are related to specified originator up to specified level and in specified direction. An entity view called ‘Device-D-entity-view’ which has ‘contains’ relation to it from Device D was created with a type ‘example-type’ which provides access to ‘water_level’ timeseries from Device D. This alias filters entity views with types ‘example-type’ that have any relation from device ‘Device D’ up to relation level 1.

Let’s learn how to add a Device search query alias and use it in a widget:

• Enter dashboard editing mode.
• In the upper right corner of the window, click the “Entity alias” icon.
• In the opened Entity aliases window, click the “Add alias” button on the left side of the dialog box.
• In the opened dialog Add alias, enter a name for the alias, select an Entity view search query filter type.
• Select the Device type and choose an asset. Set direction to “From” and max relation level 1. Input entity view type.
• Click “Add” in the lower right corner of the dialog box.
• After the alias has been added, click “Save” in the lower right corner of the dialog box.
• Click the “Add new widget” icon in the center of the screen.
• From the drop-down Select widget menu, select a Cards bundle. In the cell “Timeseries”, pick a Timeseries Table widget.
• Set a time window, Select the Entity view search query alias and add telemetry. Click “Add” in the lower right of the dialog.
• After adding the widget, click a big tick icon in the lower right corner of the screen to save all applied changes.

This alias filters entity views with types ‘example-type’ that have any relation from device ‘Device D’ up to relation level 1.