产品定价 立即试用
云平台
欧洲地区
文档 > 仪表盘 > 别名
入门
指南 API 常见问题
目录

别名

别名是指向单个实体或实体组的引用,用于部件中。别名可以是静态的或动态的。

可简单引用单个设备,也可进行针对列表中特定资产的复杂搜索查询。

本教程中,别名将按下图所示方案在系统中使用。所有设备均传输遥测值——“temperature”。

image

前置条件

在继续本指南之前,建议先阅读入门指南,以熟悉ThingsBoard设备、仪表盘和部件。这将有助于您理解本文所述概念。

创建别名

要创建别名,需要定义从中提取数据的实体。

然后按以下步骤操作:

  • Open your dashboard and switch to Edit mode;
  • Click the "Entity aliases" icon in the upper right corner of the window;
  • In the opened "Entity aliases" window click the “Add alias” button on the left side of the dialog box;
  • In the opened "Add alias" dialog, enter a name for the alias and select a filter type. Then, fill in all required fields and click the "Add" button in the lower right corner;
  • We can now see that a new alias has been added. In this window you can view, edit and delete your aliases. Click "Save" in the lower right corner of the dialog box.

现在,让我们在部件中使用已添加的别名:

  • 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);
  • Select the widget bundle. For example, select "Indoor Environment" widgets bundle;
  • Now, select the "Indoor temperature card with background" widget;
  • The "Add Widget" window will appear. Navigate to the "Entity alias" tab. Specify the previously created "A new entity alias" in the "Entity alias" field.
  • Specify the data key(s) in the "Data key" field. In our example, it's the "temperature" data key. Then, click "Add";
  • You have added a widget that uses the previously configured alias as a data source.

别名类型

ThingsBoard中有多种别名类型,各有不同配置能力:单个实体实体组实体列表实体名称实体类型实体组列表按组名的实体来自仪表板状态的实体来自仪表板状态实体的所有者资产类型设备类型实体视图类型Edge 类型API 使用状态关系查询资产搜索查询设备搜索查询实体视图搜索查询Edge 搜索查询调度器事件

它们为在ThingsBoard中高效组织和可视化各类数据源提供灵活且强大的仪表盘配置能力。

下面逐一介绍。

单个实体

此别名允许选择单个实体。可以是设备、资产、实体视图、租户、客户、仪表板、用户、数据转换器、集成、调度器事件、blob实体、角色、Edge、当前客户、当前租户、当前用户或当前用户所有者。

添加别名:在“添加别名”对话框中输入别名名称,选择“单个实体”筛选类型。然后选择实体类型并指定具体实体。

本例中,已创建一个筛选单个设备Thermometer A1的别名。

让我们在部件中使用该别名。在“Tables”部件捆绑包中选择“Entities table”部件。进入“Entity alias”选项卡。在“Entity alias”字段指定“单个实体”别名,在“Columns”部分指定“temperature”数据键。点击“Add”并应用更改。 已添加显示单个设备Thermometer A1的Entities table部件。

实体组

此别名允许选择一个实体组作为数据源。可以是设备组、资产组、实体视图组、客户组、仪表板组、用户组或Edge组。

添加别名:在“添加别名”对话框中输入别名名称,选择“实体组”筛选类型。然后选择实体类型并选择实体组。

本例中,已创建一个显示属于“Thermostats”设备组的所有设备的别名。

让我们在部件中使用该别名。在“Tables”部件捆绑包中选择“Entities table”部件。进入“Entity alias”选项卡。在“Entity alias”字段指定“实体组”别名,在“Columns”部分指定“temperature”数据键。点击“Add”并应用更改。 已添加显示属于“Thermostats”设备组的所有设备的Entities table部件。

实体列表

此别名允许显示多个实体。可以是设备、资产、实体视图、租户、客户、仪表板、用户、数据转换器、集成、调度器事件、blob实体、角色或Edge。

添加别名:在“添加别名”对话框中输入别名名称,选择“实体列表”筛选类型。然后选择实体类型并指定要在部件上显示其数据的实体。

此别名筛选指定设备列表:Thermometer A1、Compressor BC-10和Compressor QA-32。

让我们在部件中使用该别名。在“Tables”部件捆绑包中选择“Entities table”部件。进入“Entity alias”选项卡。在“Entity alias”字段指定“实体列表”别名,在“Columns”部分指定“temperature”数据键。点击“Add”并应用更改。

已添加显示多个设备列表的Entities table部件,本例为Compressor BC-10、Compressor QA-32和Thermometer A1。

实体名称

此别名允许显示名称以输入表达式开头的实体。可以是设备、资产、实体视图、租户、客户、仪表板、用户、数据转换器、集成、调度器事件、blob实体、角色或Edge。

添加别名:在“添加别名”对话框中输入别名名称,选择“实体名称”筛选类型。然后选择实体类型并输入用于筛选显示实体名称的表达式。

此别名筛选名称以“Compressor”开头的设备。

让我们在部件中使用该别名。在“Tables”部件捆绑包中选择“Entities table”部件。进入“Entity alias”选项卡。在“Entity alias”字段指定“实体名称”别名,在“Columns”部分指定“temperature”数据键。点击“Add”并应用更改。 已添加按名称以“Compressor”开头的设备筛选的Entities table部件。

实体类型

此别名允许显示您及客户指定类型的所有实体。可以是设备、资产、实体视图、租户、客户、仪表板、用户、数据转换器、集成、调度器事件、blob实体、角色或Edge。

添加别名:在“添加别名”对话框中输入别名名称,选择“实体类型”筛选,并选择实体类型。

此别名显示您及客户的所有设备。

让我们在部件中使用该别名。在“Tables”部件捆绑包中选择“Entities table”部件。进入“Entity alias”选项卡。在“Entity alias”字段指定“实体类型”别名,在“Columns”部分指定“temperature”数据键。点击“Add”并应用更改。 已添加显示您及客户所有设备的Entities table部件。

实体组列表

此别名允许显示实体组列表,可包含设备组、资产组、实体视图组、客户组、仪表板组、用户组或Edge组。

添加别名:在“添加别名”对话框中输入别名名称,选择“实体组列表”筛选。然后选择实体类型并指定要在部件上显示的实体组。

此别名显示设备组列表,本例为“Compressors”和“Thermostats”。

让我们在部件中使用该别名。在“Tables”部件捆绑包中选择“Entities table”部件。进入“Entity alias”选项卡。在“Entity alias”字段指定“实体组列表”别名。点击“Add”并应用更改。 已添加显示设备组列表的Entities table部件。

实体组名称

此别名允许显示以输入查询开头的多个实体组名称。可包含设备组、资产组、实体视图组、客户组、仪表板组、用户组或Edge组。

添加别名:在“添加别名”对话框中输入别名名称,选择“实体组名称”筛选类型。然后选择实体类型并输入用于筛选显示实体组名称的表达式。

此别名显示名称以“Compressor”开头的设备组。

让我们在部件中使用该别名。在“Tables”部件捆绑包中选择“Entities table”部件。进入“Entity alias”选项卡。在“Entity alias”字段指定“实体组名称”别名。点击“Add”并应用更改。 已添加显示名称以输入查询开头的设备组的Entities table部件。

按组名的实体

此别名允许通过输入要显示实体的组的完整名称来筛选实体。可包含设备组、资产组、实体视图组、客户组、仪表板组、用户组或Edge组。

“按组名的实体”别名与“实体组”别名的区别在于:前者通过指定名称解析组,后者使用硬编码的组ID。更重要的是,在查找实体时,此别名将使用当前用户信息。因此,若将仪表板分享给多个客户,且希望每位客户仅看到属于自己的设备,应使用此别名而非“实体组”。

添加别名:在“添加别名”对话框中输入别名名称,选择“按组名的实体”筛选类型。然后选择实体类型并输入要显示其实体的组的完整名称。

此别名按名称筛选设备组——“Compressors”。

让我们在部件中使用该别名。在“Tables”部件捆绑包中选择“Entities table”部件。 进入“Entity alias”选项卡。在“Entity alias”字段指定“按组名的实体”别名,在“Columns”部分指定“temperature”数据键。点击“Add”并应用更改。 已添加显示按输入的实体组完整名称筛选实体的Entities table部件。

来自仪表板状态的实体

此别名允许从仪表板状态中选择一个或多个实体。可以是设备、资产、实体视图、租户、客户、仪表板、用户、数据转换器、集成、调度器事件、blob实体、角色、Edge、当前客户、当前租户、当前用户或当前用户所有者。

例如,若在根仪表板状态上创建了显示多个实体的Entities table部件,且希望创建一个显示点击实体详情部件的新仪表板状态,则需使用此别名。

添加别名:在“添加别名”对话框中输入别名名称,选择“来自仪表板状态的实体”筛选类型。然后点击“Add”。

此别名用于为其他仪表板状态筛选数据。

下一个示例需要两个别名:前述“实体组”别名和“来自仪表板状态的实体”别名。开始如下:

首先创建一个显示实体列表的Entity table部件:添加一个显示实体列表的Entities table部件。使用“实体组”别名作为数据源。

添加Entities table部件后,添加新的状态

  • 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;
  • 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";
  • 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.

接下来为根仪表板部件添加操作,并在所创建状态的部件上使用来自仪表板状态的实体别名执行:

  • In the root dashboard state, enter widget Edit mode by clicking the “pencil” icon in the upper right corner;
  • Scroll down to find "Actions" section. Click "Add action" button;
  • The "Entities table: Actions" window will be opened. Click the "Add action" button in the top right corner;
  • In the "Add action" dialog, enter the action name, and select an action source responsible for each entity separately (action cell button, on row click etc.). Then, choose the action type "Navigate to new dashboard state" and specify the new dashboard state to which the transition will be made. After, click "Add";
  • After successfully adding the action, click the "Save" button. Then, click the "Apply" button;
  • Now, go to the created state by selecting it from the drop-down menu accessed through the layers icon in the upper left corner;
  • Click the “Add new widget” icon in the center of the screen;
  • In the opened widget bundles selection, select "Indoor Environment";
  • Select the "Indoor temperature card with background" widget;
  • In the add widget window, navigate to the "Entity alias" tab. Specify the "Entity from dashboard state" alias in the "Entity alias" field and "temperature" data key in the “Columns” section. Click the "Add" button in the lower right corner;
  • After adding the widget save all applied changes;

现在,点击任意实体旁的操作按钮。将跳转到内部状态,其中包含选中实体详情的部件。

来自仪表板状态实体的所有者

此别名用于显示设备、资产、实体等的所有者。通常用于存在客户层次结构时,了解设备归属。

添加别名:在“添加别名”对话框中输入别名名称,选择“来自仪表板状态实体的所有者”筛选类型。然后点击“Add”。

学习如何在部件中使用“来自仪表板状态实体的所有者”别名显示设备所有者。

下一个示例需要两个别名:前述“实体类型”别名和“来自仪表板状态实体的所有者”别名。

首先添加一个显示所有设备列表的Entity table部件。使用“实体类型”别名作为数据源。

再添加一个显示选中设备所有者的Entities table部件。在“Entity alias”字段指定“来自仪表板状态实体的所有者”别名。点击右下角“Add”按钮;

现在需要添加用于更新仪表板当前状态的操作

  • In the root dashboard state, enter widget Edit mode by clicking the “pencil” icon in the upper right corner of it;
  • Scroll down to find "Actions" section. Click "Add action" button;
  • The "Entities table: Actions" window will be opened. Click the "Add action" button in the top right corner;
  • In the "Add action" dialog, enter the action name, select an action source - "on row click", and choose the action type "Update current dashboard state". After, click "Add";
  • After successfully adding the action, click the "Save" button. Then, click the "Apply" button;
  • Save the dashboard;

点击“Entities”部件中设备名称所在行。将执行操作,选中设备的所有者将显示在“Device Owner”部件中。

资产类型

此别名允许按指定的资产配置(asset profile)筛选资产(可选:按名称以输入查询开头的筛选)。

添加别名:在“添加别名”对话框中输入别名名称,选择“资产类型”筛选类型。然后指定资产配置(asset profile)并输入用于筛选显示资产名称的表达式。

此别名筛选资产配置为“buildings”且名称以“Build”开头的资产。

让我们在部件中使用该别名。在“Tables”部件捆绑包中选择“Entities table”部件。进入“Entity alias”选项卡。在“Entity alias”字段指定“资产类型”别名。点击“Add”并应用更改。已添加显示资产配置为“buildings”且名称以“Build”开头的资产的Entities table部件。

设备类型

此别名允许按指定的设备配置(device profile)筛选设备(可选:按名称以输入查询开头的筛选)。

添加别名:在“添加别名”对话框中输入别名名称,选择“设备类型”筛选类型。然后指定设备配置(device profile)并输入用于筛选显示设备名称的表达式。

此别名筛选设备配置为“thermometers”且名称以“Therm”开头的设备。

让我们在部件中使用该别名。在“Tables”部件捆绑包中选择“Entities table”部件。进入“Entity alias”选项卡。在“Entity alias”字段指定“设备类型”别名。点击“Add”并应用更改。已添加显示设备配置为“thermometers”且名称以“Therm”开头的设备的Entities table部件。

实体视图类型

此别名允许按指定的实体视图类型筛选设备(可选:按名称以输入查询开头的筛选)。

添加别名:在“添加别名”对话框中输入别名名称,选择“实体视图类型”筛选类型。然后指定实体视图类型并输入用于筛选显示实体视图名称的表达式。

此别名筛选类型为“Compressors Entity View Type”且名称以“Compressor”开头的实体视图。

示例:已创建名为“Compressor BC-10 Entity View”和“Compressor QA-32 Entity View”的实体视图,类型为“Compressors Entity View Type”,可访问Compressor BC-10和Compressor QA-32的“Power”时序。

让我们在部件中使用该别名。在“Tables”部件捆绑包中选择“Entities table”部件。进入“Entity alias”选项卡。在“Entity alias”字段指定“实体视图类型”别名。点击“Add”并应用更改。已添加显示实体视图类型为“Compressors Entity View Type”且名称以“Compressor”开头的Entities table部件。

Edge类型

此别名允许按指定的Edge类型筛选设备(可选:按名称以输入查询开头的筛选)。

添加别名:在“添加别名”对话框中输入别名名称,选择“实体视图类型”筛选类型。然后指定实体视图类型并输入用于筛选显示实体视图名称的表达式。

此别名筛选Edge类型为“edge instance”且名称以“Edge”开头的Edge。

让我们在部件中使用该别名。在“Tables”部件捆绑包中选择“Entities table”部件。进入“Entity alias”选项卡。在“Entity alias”字段指定“Edge类型”别名。点击“Add”并应用更改。已添加显示Edge类型为“edge instance”且名称以“Edge”开头的Entities table部件。

API使用状态

TB平台主菜单中有API Usage布局。API Usage显示平台完整统计。API使用状态别名允许仅从用户仪表板统计中获取所需数据。

学习如何在部件中使用“API使用状态”别名。在“Tables”部件捆绑包中选择“Entities table”部件。进入“Entity alias”选项卡。在“Entity alias”字段指定“API使用状态”别名,并在“Columns”部分添加从API使用中获取统计的数据键。点击“Add”并应用更改。已添加显示API使用统计的Entities table部件。

关系查询

此别名允许显示与指定发起方在指定级别和方向上相关的实体。

添加别名:在“添加别名”对话框中输入别名名称,指定“关系查询”筛选类型。然后选择实体类型和要显示关系的实体。将方向设为“From”或“To”并设置最大关系级别。

本例中别名显示与资产“District A”在关系级别3内有任意关系的实体。

学习如何在部件中使用“关系查询”别名。在“Tables”部件捆绑包中选择“Entities table”部件。进入“Entity alias”选项卡。在“Entity alias”字段指定“关系查询”别名,在“Columns”部分添加“entityType”数据键。点击“Add”并应用更改。已添加显示与资产“District A”在关系级别3内有任意关系的实体及其类型的Entities table部件。

资产搜索查询

此别名允许显示指定资产配置(asset profile)中与指定实体在指定级别和方向上相关的资产。

添加别名:在“添加别名”对话框中输入别名名称,选择“资产搜索查询”筛选类型,选择实体类型及要显示关系的实体。将方向设为“From”或“To”,设置最大关系级别,并指定用于筛选资产的资产配置(asset profile)。

此别名显示资产配置为“buildings”和“district”且与设备“Compressor QA-32”在方向“From”和关系级别2上有任意关系的资产。

学习如何在部件中使用“资产搜索查询”别名。在“Tables”部件捆绑包中选择“Entities table”部件。进入“Entity alias”选项卡。在“Entity alias”字段指定“资产搜索查询”别名,在“Columns”部分添加“name”和“type”数据键。点击“Add”并应用更改。已添加显示与设备“Compressor QA-32”在关系级别2上有任意关系的资产的Entities table部件。

设备搜索查询

此别名允许显示指定设备配置(device profile)中与指定发起方在指定级别和方向上相关的设备。

添加别名:在“添加别名”对话框中输入别名名称,选择“设备搜索查询”筛选类型,选择实体类型及要显示关系的实体。将方向设为“From”或“To”,设置最大关系级别,并指定用于筛选设备的设备配置(device profile)。

此别名显示设备配置为“compressors”且与资产“Building A”在方向“From”和关系级别1上有任意关系的设备。

学习如何在部件中使用“设备搜索查询”别名。在“Tables”部件捆绑包中选择“Entities table”部件。进入“Entity alias”选项卡。在“Entity alias”字段指定“设备搜索查询”别名,在“Columns”部分添加“name”、“type”和“temperature”数据键。点击“Add”并应用更改。已添加显示与资产“Building A”在关系级别1内有任意关系的设备的Entities table部件。

实体视图搜索查询

此别名允许显示指定类型中与指定发起方在指定级别和方向上相关的实体视图。

已创建与设备“Compressor BC-10”存在关系的“Compressor BC-10 Entity View”实体视图,类型为“compressors entity view type”,可访问Compressor BC-10的“temperature”时序。

添加别名:在“添加别名”对话框中输入别名名称,选择“实体视图搜索查询”筛选类型,选择实体类型及要显示关系的实体。将方向设为“From”或“To”,设置最大关系级别,并指定用于筛选实体视图的实体视图类型。

此别名筛选类型为“Compressors Entity View Type”且与资产“Building A”在方向“From”和关系级别1上有任意关系的实体视图。

学习如何在部件中使用“实体视图搜索查询”别名。在“Tables”部件捆绑包中选择“Entities table”部件。进入“Entity alias”选项卡。在“Entity alias”字段指定“实体视图搜索查询”别名,在“Columns”部分添加“name”、“type”和“temperature”数据键。点击“Add”并应用更改。已添加显示与资产“Building A”在关系级别1内有任意关系的实体视图的Entities table部件。

Edge搜索查询

此别名允许显示指定类型中与指定发起方在指定级别和方向上相关的Edge。

添加别名:在“添加别名”对话框中输入别名名称,选择“Edge搜索查询”筛选类型,选择实体类型及要显示关系的实体。将方向设为“From”或“To”,设置最大关系级别,并指定用于筛选Edge的Edge类型。

此别名筛选类型为“edge instance”且与资产“Building A”在方向“From”和关系级别1上有任意关系的Edge。

学习如何在部件中使用“Edge搜索查询”别名。在“Tables”部件捆绑包中选择“Entities table”部件。进入“Entity alias”选项卡。在“Entity alias”字段指定“Edge搜索查询”别名,在“Columns”部分添加“name”和“type”数据键。点击“Add”并应用更改。已添加显示与资产“Building A”在关系级别1内有任意关系的Edge的Entities table部件。

调度器事件

此别名允许显示与指定实体关联的调度器事件。

添加别名:在“添加别名”对话框中输入别名名称,选择“调度器事件”筛选类型,并选择要显示调度器事件的实体。

此别名显示设备“Compressor BC-10”的调度器事件。

学习如何在部件中使用“调度器事件”别名。在“Tables”部件捆绑包中选择“Entities table”部件。进入“Entity alias”选项卡。在“Entity alias”字段指定“调度器事件”别名,在“Columns”部分添加“name”、“type”和“schedule”数据键。点击“Add”并应用更改。已添加显示设备“Compressor BC-10”调度器事件的Entities table部件。