You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _includes/docs/user-guide/ui/aliases.md
+31-9Lines changed: 31 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,12 @@ Let's take a look at each of them.
40
40
41
41
### Single entity
42
42
43
+
{% if docsPrefix == null %}
44
+
This alias allows choosing a single entity. It can be a device, asset, entity view, tenant, customer, user, dashboard, edge, current customer, current tenant, current user or current user owner.
45
+
{% endif %}
46
+
{% if (docsPrefix == "pe/") or (docsPrefix == "paas/") %}
43
47
This alias allows choosing a single entity. It can be a device, asset, entity view, tenant, customer, dashboard, user, data converter, integration, scheduler event, blob entity, role, edge, current customer, current tenant, current user or current user owner.
48
+
{% endif %}
44
49
45
50
Adding an alias: in the "Add alias" dialog, enter the alias name, and select the "Single entity" filter type. Then choose the entity type and specify the final entity.
46
51
@@ -72,8 +77,12 @@ The Entities table widget with the alias that displays all devices that belong t
72
77
73
78
### Entity list
74
79
75
-
This alias allows you to display multiple entities.
76
-
It can be devices, assets, entity views, tenants, customers, dashboards, users, data converters, integrations, scheduler events, blob entities, roles or edges.
80
+
{% if docsPrefix == null %}
81
+
This alias allows you to display multiple entities. It can be devices, assets, entity views, tenants, customers, dashboards, users or edges.
82
+
{% endif %}
83
+
{% if (docsPrefix == "pe/") or (docsPrefix == "paas/") %}
84
+
This alias allows you to display multiple entities. It can be devices, assets, entity views, tenants, customers, dashboards, users, data converters, integrations, scheduler events, blob entities, roles or edges.
85
+
{% endif %}
77
86
78
87
Adding an alias: in the "Add alias" dialog, enter the alias name, and select the "Entity list" filter type. Then choose the entities type and specify entities whose data you want to display on the widget.
79
88
@@ -100,8 +109,12 @@ The Entities table widget with the alias that displays a list of several devices
100
109
101
110
### Entity name
102
111
103
-
This alias allows you to display entities whose names start with the entered expression.
104
-
These objects can be devices, assets, entity views, tenants, customers, dashboards, users, data converters, integrations, scheduler events, blob entities, rales or edges.
112
+
{% if docsPrefix == null %}
113
+
This alias allows you to display entities whose names start with the entered expression. These objects can be devices, assets, entity views, tenants, customers, users, dashboards or edges.
114
+
{% endif %}
115
+
{% if (docsPrefix == "pe/") or (docsPrefix == "paas/") %}
116
+
This alias allows you to display entities whose names start with the entered expression. These objects can be devices, assets, entity views, tenants, customers, dashboards, users, data converters, integrations, scheduler events, blob entities, rales or edges.
117
+
{% endif %}
105
118
106
119
Adding an alias: in the "Add alias" dialog, enter the alias name, and select the "Entity name" filter type. Then choose the entities type and enter an expression that will filter the names of the displayed entities.
107
120
@@ -116,10 +129,14 @@ The Entities table widget with alias that filters devices, which names start wit
116
129
117
130
### Entity type
118
131
119
-
This alias allows you to display all your entities and your customers' entities of the specified type.
120
-
These objects can be devices, assets, entity views, tenants, customers, dashboards, users, data converters, integrations, scheduler events, blob entities, rales or edges.
132
+
{% if docsPrefix == null %}
133
+
This alias allows you to display all your entities and your customers' entities of the specified type. These objects can be devices, assets, entity views, tenants, customers, users, dashboards or edges.
134
+
{% endif %}
135
+
{% if (docsPrefix == "pe/") or (docsPrefix == "paas/") %}
136
+
This alias allows you to display all your entities and your customers' entities of the specified type. These objects can be devices, assets, entity views, tenants, customers, dashboards, users, data converters, integrations, scheduler events, blob entities, rales or edges.
137
+
{% endif %}
121
138
122
-
Adding an alias: in the "Add Alias" dialog, enter the alias name, select the filter as "Entity Type," and choose the entity type.
139
+
Adding an alias: in the "Add Alias" dialog, enter the alias name, select the filter as "Entity Type", and choose the entity type.
123
140
124
141
{% include images-gallery.html imageCollection="entity-type-1" %}
125
142
@@ -186,7 +203,12 @@ The Entities table widget that displays entities filtered by the exact full name
186
203
187
204
### Entity from dashboard state
188
205
206
+
{% if docsPrefix == null %}
207
+
This alias allows choosing one or more entities from the dashboard state. The entities can be a device, asset, entity view, tenant, customer, user, dashboard, edge, current customer, current tenant, current user, or current user owner.
208
+
{% endif %}
209
+
{% if (docsPrefix == "pe/") or (docsPrefix == "paas/") %}
189
210
This alias allows choosing one or more entities from the dashboard state. The entities can be a device, asset, entity view, tenant, customer, dashboard, user, data converter, integration, scheduler event, blob entity, role, edge, current customer, current tenant, current user, or current user owner.
211
+
{% endif %}
190
212
191
213
For example, if Entities table widget is created on a [root dashboard state](/docs/{{docsPrefix}}user-guide/dashboards/#states) with several entities displayed on it, and you'd like to create a dashboard state which will display a widget with the entity you clicked on, you need to use this alias.
192
214
@@ -279,15 +301,15 @@ Let’s use an added alias in a widget. In the "Tables" widgets bundle select th
279
301
280
302
{% include images-gallery.html imageCollection="device-type-2" %}
281
303
282
-
### Entity view type
304
+
### Entity View type
283
305
284
306
This alias allows you to filter devices by the specified entity view type(s) (and optionally by names starting with the entered query).
285
307
286
308
Adding an alias: in the “Add alias” dialog, enter the alias name, and select the "Entity view type" filter type. Then specify the entity view type(s) and enter an expression that will filter the names of the displayed entity views.
287
309
288
310
{% include images-gallery.html imageCollection="entity-view-type-1" %}
289
311
290
-
This alias filters entity Views of type ‘Compressors Entity View Type’ and with name starting with "Compressor".
312
+
This alias filters entity views of type "Compressors Entity View Type" and with name starting with "Compressor".
291
313
292
314
Let's see an example. Entity views named "Compressor BC-10 Entity View" and "Compressor QA-32 Entity View" have been created with the type "Compressors Entity View Type," providing access to the 'Power' timeseries from Compressor BC-10 and Compressor QA-32.
Copy file name to clipboardExpand all lines: docs/paas/user-guide/ui/aliases.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ use-alias-in-widget:
28
28
title: 'Click the "Add widget" button at the top of the screen or click the large "Add new widget" icon in the center of the screen (if this is your first widget on this dashboard);'
title: 'In the "Add alias" dialog box, enter the alias name, and select the "Group entities" filter type. Then choose the entities type and select the entity group.'
76
+
title: 'In the "Add alias" dialog, enter the alias name, and select the "Entity list" filter type. Then choose the entities type and specify entities whose data you want to display on the widget.'
Copy file name to clipboardExpand all lines: docs/pe/user-guide/ui/aliases.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ use-alias-in-widget:
28
28
title: 'Click the "Add widget" button at the top of the screen or click the large "Add new widget" icon in the center of the screen (if this is your first widget on this dashboard);'
title: 'In the "Add alias" dialog box, enter the alias name, and select the "Group entities" filter type. Then choose the entities type and select the entity group.'
76
+
title: 'In the "Add alias" dialog, enter the alias name, and select the "Entity list" filter type. Then choose the entities type and specify entities whose data you want to display on the widget.'
Copy file name to clipboardExpand all lines: docs/user-guide/ui/aliases.md
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ use-alias-in-widget:
28
28
title: 'Click the "Add widget" button at the top of the screen or click the large "Add new widget" icon in the center of the screen (if this is your first widget on this dashboard);'
title: 'In the "Add alias" dialog box, enter the alias name, and select the "Group entities" filter type. Then choose the entities type and select the entity group.'
62
+
title: 'In the "Add alias" dialog box, enter the alias name, and select the "Entity list" filter type. Then choose the entities type and select the entity group.'
title: 'In the "Tables" widgets bundle select the "Entities table" widget. Navigate to the "Entity alias" tab. Specify the "Entity list" alias in the "Entity alias" field and "temperature" data key in the "Columns" section. Click "Add";'
title: 'The Entities table widget with the alias that displays a list of several devices, which in this case are Compressor BC-10, Compressor QA-32, and Thermometer A1 has been added.'
70
+
title: 'The Entities table widget with the alias that displays a list of several devices, which in this case are Thermometer A1, Thermometer A2, and Thermometer A3 has been added.'
title: 'In the "Add alias" dialog box, enter the alias name, and select the "Group entities" filter type. Then choose the entities type and select the entity group;'
109
+
title: 'In the "Add alias" dialog box, enter the alias name, select the "Entity type" filter type and choose the entity type;'
title: 'Click the layers icon in the top left corner of the dashboard to create a new state. In the opened dialog window, click a "+" icon to add a new state;'
title: 'Enter state's name. For the state to be named after the entity, use ${entityName} as the name of the state. Thus, during the action, you will be transitioned to a state named after the entity that took part in the action. Click "Add";'
123
+
title: 'Enter state's name. For the state to be named after the entity, use <b>${entityName}</b> as the name of the state. Thus, during the action, you will be transitioned to a state named after the entity that took part in the action. Click "Add";'
title: 'Now you see a list with two states: the root one, and the one that has just been created. Click "Save" in the lower right corner of the dialog.'
0 commit comments