产品定价 立即试用
社区版
文档 > 仪表盘 > 别名
入门
指南 安装 架构 API 常见问题
目录

实体别名

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

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

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

image

前置条件

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

创建别名

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

然后按以下步骤操作:

  • 打开仪表板并切换到编辑模式。
  • 点击窗口右上角的"实体别名"图标。
  • 在打开的"实体别名"窗口中,点击对话框左侧的"添加别名"按钮。
  • 在打开的"添加别名"对话框中输入别名名称并选择过滤类型。然后填写所有必填项并点击右下角的"添加"按钮。
  • 此时可以看到已添加新别名。在此窗口中可查看、编辑和删除别名。点击对话框右下角的"保存"。

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

  • 点击屏幕上方的"添加部件"按钮,或点击屏幕中央的"添加新部件"大图标(若为仪表板上的第一个部件)。
  • 选择部件包,例如选择"室内环境"部件包。
  • 选择"带背景的室内温度卡片"部件。
  • 将显示"添加部件"窗口。切换到"实体别名"选项卡,在"实体别名"字段中指定先前创建的别名。
  • 在"Data key"字段中指定数据键,本例为"temperature"。然后点击"添加"。
  • 已添加使用先前配置的别名作为数据源的部件。

别名类型

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

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

下面逐一介绍。

单个实体

此别名允许选择单个实体。可以是设备、资产、实体视图、租户、客户、用户、仪表板、Edge、当前客户、当前租户、当前用户或当前用户所有者。

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

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

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

实体列表

此别名允许显示多个实体。可以是设备、资产、实体视图、租户、客户、仪表板、用户或Edge。

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

此别名筛选指定设备列表:Thermometer A1、Thermometer A2和Thermometer A3。

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

已添加显示多个设备列表的Entities table部件,本例为Thermometer A1、Thermometer A2和Thermometer A3。

实体名称

此别名允许显示名称以输入表达式开头的实体。可以是设备、资产、实体视图、租户、客户、用户、仪表板或Edge。

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

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

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

实体类型

此别名允许显示您及客户指定类型的所有实体。可以是设备、资产、实体视图、租户、客户、用户、仪表板或Edge。

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

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

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

来自仪表板状态的实体

此别名允许从仪表板状态中选择一个或多个实体。可以是设备、资产、实体视图、租户、客户、用户、仪表板、Edge、当前客户、当前租户、当前用户或当前用户所有者。

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

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

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

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

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

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

  • 点击仪表板左上角的层图标以创建新状态。在打开的对话框窗口中,点击"+"图标添加新状态。
  • 输入状态名称。若要使状态以实体名称命名,请使用${entityName}作为状态名称。这样,在执行操作时,您将跳转到以参与操作的实体命名的状态。点击"添加"。
  • 此时可以看到包含两个状态的列表:根状态和刚刚创建的状态。点击对话框右下角的"保存"。

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

  • 在根仪表板状态中,点击右上角的"铅笔"图标进入部件编辑模式。
  • 向下滚动找到"操作"区域。点击"添加操作"按钮。
  • 将打开"实体table:操作"窗口。点击右上角的"添加操作"按钮。
  • 在"添加操作"对话框中输入操作名称,并选择分别负责每个实体的操作来源(操作单元格按钮、行点击等)。然后选择操作类型"导航到新仪表板状态"并指定要跳转的新仪表板状态。完成后点击"添加"。
  • 成功添加操作后,点击"保存"按钮。然后点击"应用"按钮。
  • 现在,通过左上角层图标打开的下拉菜单选择创建的状态进入该状态。
  • 点击屏幕中央的"添加新部件"图标。
  • 在打开的部件包选择中,选择"室内环境"。
  • 选择"带背景的室内温度卡片"部件。
  • 在添加部件窗口中切换到"实体别名"选项卡。在"实体别名"字段中指定"仪表板状态中的实体"别名,在"列"区域指定"temperature"数据键。点击右下角的"添加"按钮。
  • 添加部件后保存所有已应用的更改。

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

资产类型

此别名允许按指定的资产配置(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)。

此别名显示设备配置为“thermometers”且与资产“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部件。