Skip to content

Commit 8a4ab07

Browse files
committed
updated text
1 parent 7c6bd61 commit 8a4ab07

File tree

4 files changed

+41
-19
lines changed

4 files changed

+41
-19
lines changed

_includes/docs/user-guide/ui/aliases.md

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,12 @@ Let's take a look at each of them.
4040

4141
### Single entity
4242

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/") %}
4347
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 %}
4449

4550
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.
4651

@@ -72,8 +77,12 @@ The Entities table widget with the alias that displays all devices that belong t
7277

7378
### Entity list
7479

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 %}
7786

7887
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.
7988

@@ -100,8 +109,12 @@ The Entities table widget with the alias that displays a list of several devices
100109

101110
### Entity name
102111

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 %}
105118

106119
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.
107120

@@ -116,10 +129,14 @@ The Entities table widget with alias that filters devices, which names start wit
116129

117130
### Entity type
118131

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 %}
121138

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.
123140

124141
{% include images-gallery.html imageCollection="entity-type-1" %}
125142

@@ -186,7 +203,12 @@ The Entities table widget that displays entities filtered by the exact full name
186203

187204
### Entity from dashboard state
188205

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/") %}
189210
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 %}
190212

191213
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.
192214

@@ -279,15 +301,15 @@ Let’s use an added alias in a widget. In the "Tables" widgets bundle select th
279301

280302
{% include images-gallery.html imageCollection="device-type-2" %}
281303

282-
### Entity view type
304+
### Entity View type
283305

284306
This alias allows you to filter devices by the specified entity view type(s) (and optionally by names starting with the entered query).
285307

286308
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.
287309

288310
{% include images-gallery.html imageCollection="entity-view-type-1" %}
289311

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".
291313

292314
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.
293315

docs/paas/user-guide/ui/aliases.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ use-alias-in-widget:
2828
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);'
2929
1:
3030
image: /images/user-guide/ui/alias/create-alias-7-pe.png
31-
title: 'Select the widget bundle. For example select "Indoor Environment" widgets bundle;'
31+
title: 'Select the widget bundle. For example, select "Indoor Environment" widgets bundle;'
3232
2:
3333
image: /images/user-guide/ui/alias/create-alias-8-pe.png
3434
title: 'Now, select the "Indoor temperature card with background" widget;'
@@ -73,7 +73,7 @@ group-entities-2:
7373
entity-list-1:
7474
0:
7575
image: /images/user-guide/ui/alias/entity-list-1-pe.png
76-
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.'
7777

7878
entity-list-2:
7979
0:

docs/pe/user-guide/ui/aliases.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ use-alias-in-widget:
2828
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);'
2929
1:
3030
image: /images/user-guide/ui/alias/create-alias-7-pe.png
31-
title: 'Select the widget bundle. For example select "Indoor Environment" widgets bundle;'
31+
title: 'Select the widget bundle. For example, select "Indoor Environment" widgets bundle;'
3232
2:
3333
image: /images/user-guide/ui/alias/create-alias-8-pe.png
3434
title: 'Now, select the "Indoor temperature card with background" widget;'
@@ -73,7 +73,7 @@ group-entities-2:
7373
entity-list-1:
7474
0:
7575
image: /images/user-guide/ui/alias/entity-list-1-pe.png
76-
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.'
7777

7878
entity-list-2:
7979
0:

docs/user-guide/ui/aliases.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ use-alias-in-widget:
2828
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);'
2929
1:
3030
image: /images/user-guide/ui/alias/create-alias-7-ce.png
31-
title: 'Select the widget bundle. For example select "Indoor Environment" widgets bundle;'
31+
title: 'Select the widget bundle. For example, select "Indoor Environment" widgets bundle;'
3232
2:
3333
image: /images/user-guide/ui/alias/create-alias-8-ce.png
3434
title: 'Now, select the "Indoor temperature card with background" widget;'
@@ -59,15 +59,15 @@ single-alias-2:
5959
entity-list-1:
6060
0:
6161
image: /images/user-guide/ui/alias/entity-list-1-ce.png
62-
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.'
6363

6464
entity-list-2:
6565
0:
6666
image: /images/user-guide/ui/alias/entity-list-2-ce.png
6767
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";'
6868
1:
6969
image: /images/user-guide/ui/alias/entity-list-3-ce.png
70-
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.'
7171

7272

7373
entity-name-1:
@@ -106,10 +106,10 @@ entity-from-dashboard-state-1:
106106
entity-from-dashboard-state-2:
107107
0:
108108
image: /images/user-guide/ui/alias/entity-from-dashboard-state-3-ce.png
109-
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;'
110110
1:
111111
image: /images/user-guide/ui/alias/entity-from-dashboard-state-4-ce.png
112-
title: 'Add an Entity table widget that will display a list of entities. Use the "Group entities" alias as a data source;'
112+
title: 'Add an Entity table widget that will display a list of entities. Use the "Entity type" alias as a data source;'
113113
2:
114114
image: /images/user-guide/ui/alias/entity-from-dashboard-state-5-ce.png
115115
title: 'The Entity table widget that will display a list of devices has been added.'
@@ -120,7 +120,7 @@ entity-from-dashboard-state-3:
120120
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;'
121121
1:
122122
image: /images/user-guide/ui/alias/entity-from-dashboard-state-7-ce.png
123-
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&#39;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";'
124124
2:
125125
image: /images/user-guide/ui/alias/entity-from-dashboard-state-8-ce.png
126126
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

Comments
 (0)