基础

访问控制

组织管理

按组织架构可以对用户进行分级管理；可以创建下级组织，指定的组织层级的用户，只允许访问该组织及以下级别的数据。

角色管理

创建角色，可以设置每个角色的操作权限，用户拥有其所属角色的所有权限。角色管理中分别可以从权限和角色两个视角去管理和授权权限，权限视角将列出所有的权限，从权限的角度去决定哪些角色拥有权限；而角色视角，可以根据角色去分配权限。

单击新建角色，开始添加一个角色：

用户管理

用于对登录平台的账号进行管理。多租户模式下，项目级用户只允许访问当前项目。

创建角色

新增账号可以设置用户、姓名、邮箱、手机号码以及该账号所属组织和角色，不同的角色决定了该用户可以使用的功能点。

编辑角色

打开角色编辑窗口，可以修改角色的名称和对这个角色权限进行重新分配，生效以后，角色下辖的账号会自动获得对应的权限。

删除角色

在角色列表中，可以单击角色的删除按钮清理不需要的角色。

操作日志

点击【基础】【操作日志】菜单，进入操作日志管理，可查看用户操作记录。支持以下检索条件：

• 按操作日期进行检索；
• 按操作对象进行检索；
• 按操作类型类型进行检索；
• 按操作人姓名进行检索；
• 按操作人用户名进行检索；

外部数据源

外部数据源用于读取第三方数据库或应用中的数据，并在组态画面和报表中进行使用。

数据源分为HTTP类型和数据库类型，数据源下可以创建多个数据集。

数据库数据源

点击左侧【数据源管理】中“+”按键，在【创建数据源】弹窗中输入“数据源名称”、“数据源类型”与“描述”，点击【确定】按钮完成数据源创建操作。

字段说明：

• 数据源名称：必填项。
• 数据源类型：必选项。在数据源创建后无法修改。
• 描述：选填项。根据需求填写数据库的描述文字。

刚创建的数据源只包含“数据源名称”等基础信息，需要选中数据源进行设置连接参数。

设置连接参数

点击左侧【数据源管理】列表中选中相应的数据源。在右侧的数据源详情页面进行设置。

字段说明：

• 数据库类型：必填项。
• 数据库名称：必填项。数据库的实际名称。
• 主机地址/IP：必填项。数据库的主机地址/IP。
• 端口：必填项。数据库的主机地址/IP端口。
• schema：选填项。当数据库为PostgreSQL时可以填写PostgreSQL 模式（schema）。
• 用户名：选填项。若数据库设有密码，则需要在此处填写登录用户名。
• 密码：选填项。若数据库设有密码，则需要在此处填写登录密码。

测试连接

点击数据库数据源详情页的【测试连接】按钮，测试已配置好的数据库数据源是否能正常。连接失败时消息提示会包含错误信息，方便查找连接失败原因。

删除数据源

点击左侧【数据源管理】列表中需要删除的数据源的“操作”按键。在操作弹窗中点击“删除”按钮。在【删除确认】弹窗中点击“确定”完成删除操作。

创建数据集

一个数据集对应一条 SQL 语句的查询结果。

点击左侧【数据源管理】列表中数据源的“操作”按键，在操作弹窗中点击“创建”按钮。

字段说明：

• 数据集名称：必填项。
• 数据集标识：选填项。作为操作数据集的唯一标识，不填则会由系统自动生成。
• 描述：选填项。根据需求填写数据集的描述文字。

刚创建的数据集只包含“数据集名称”等基础信息，需要编辑数据集进行其它内容的设置。

编辑数据集

点击左侧【数据源管理】列表中需要编辑的数据集，在右侧的数据集详情页面进行编辑，点击【保存】按钮对修改的内容进行保存。

变量

定义变量参数，可在数据库数据集中的"查询语句"和“总数查询语句”中使用。

点击【添加变量】可以添加新的变量，变量支持字符串、数值、布尔型类型，且可以设置不传参时的默认值。offset与limit为默认变量不可删除，可在开启分页时使用。

字段

用于定义查询后返回的结果集中每条数据的字段，至少需要设置一个字段。

字段类型

支持以下几种类型：字符串、布尔型、整数型、浮点型、日期、日期时间、时间。

• 字符串与整数型可以添加枚举项，枚举值为对应返回值，枚举名称对应显示名称。
• 布尔型可以填写返回值为false或true时的字段名称。
• 浮点型可以选择返回值精度。
• 日期、日期时间、时间型可以按照时间格式回显。时间格式："%Y"代表年，"%m"代表月"%d"代表日"%H"代表时"%M"代表分"%S"代表秒。 如想表示时间格式为"2022-01-01 01:01:01"，则写为"%Y-%m-%d %H:%M:%S"。

分页

默认为开启分页。可设置是否启用分页查询，启用分页后将显示“总数查询语句”。

总数查询语句

仅在启用分页时显示，且为必填项。依照数据源中数据库类型的语法填写分页查询的sql语句。可以使用变量，格式为“${变量名称}”。

查询语句

必填项。依照数据源中数据库类型的语法填写分页查询的sql语句。可以使用变量，格式为“${变量名称}”。

数据集预览

点击数据集右下角的【预览】按钮。在【预览】弹窗中点击右下角的【查询】按钮进行数据预览。

若有变量则可以填写变量值作为参数进行数据查询。

若在选项中开启分页则会在页面底端显示分页。

删除数据集

点击左侧【数据源管理】列表中数据集的“删除”按键。在操作弹窗中点击“删除”按钮。在【删除确认】弹窗中点击“确定”完成删除操作。

HTTP 数据源

HTTP类型数据源用于通过 HTTP 方式获取数据。

创建数据源

点击左侧【数据源管理】中“+”按钮，在【创建数据源】弹窗中将“数据源类型”设置为“HTTP”，如下图所示：

字段说明：

• 数据源名称：必填项。
• 数据源类型：必选项。在数据源创建后无法修改。
• 描述：选填项。根据需求填写数据库的描述文字。

数据源设置

点击左侧【数据源管理】列表中选中需要设置的数据源，在右侧的数据源详情页面进行设置。

全局变量

全局变量可以被该数据源下的所有数据集使用。

点击【添加变量】可以添加新的变量，支持字符串、数值、布尔型类型，如下图所示：

变量赋值

调用数据集发出 HTTP 请求时，可以通过传参对变量进行赋值。如果不传参，需要设置变量的默认值。

数据源设置中使用变量

可以在数据源的以下设置中引用全局变量：

• 在Headers下的 key 和 value 中引用全局变量，格式为 {{变量名称}}
• 在 Authorization 下的用户名、密码、Token、Key、Value中使用引用全局变量，格式为 {{变量名称}}

数据集设置中使用变量

可以在数据集的以下设置中引用全局变量：

• 在请求地址的 URL Path 中引用全局变量，格式为{{变量名称}}
• 在Headers下的 key 和 value 中引用全局变量，格式为 {{变量名称}}
• 在Params下的 key 和 value 中引用全局变量，格式为{{变量名称}}
• 在Body中引用全局变量，格式为${变量名称}。

Headers 参数

Header 参数用于定义所有数据集公用的请求头，设置后 key 和 value 的值将添加到所有数据集的 HTTP 请求头中。

引用全局变量

在Headers下的 key 和 value 中可以引用全局变量，格式为 {{变量名称}}

Authorization

用于设置 HTTP 请求的认证方式。支持以下几种认证方式：

• 无需认证。
• Basic Auth。
• Bearer Token
• API Key

引用全局变量

在 "用户名"、"密码"、"Token"、"Key"、"Value"中可以使用全局变量，格式为：{{变量名称}}

删除数据源

点击左侧【数据源管理】列表中需要删除的数据源的“操作”按键。在操作弹窗中点击“删除”按钮。在【删除确认】弹窗中点击“确定”完成删除操作。

删除数据源会连同删除在此数据源下创建的数据集，请谨慎操作。

创建数据集

每个数据集对应一个 HTTP 请求。

常规的 http 数据集要求返回的是 JSON 格式的数据，下面是一个示例：

[
  { product: 'Matcha Latte', count: 823, score: 95.8 },
  { product: 'Milk Tea', count: 235, score: 81.4 },
  { product: 'Cheese Cocoa', count: 1042, score: 91.2 },
  { product: 'Walnut Brownie', count: 988, score: 76.9 }
]

点击左侧【数据源管理】列表中数据源的“操作”按键，在操作弹窗中点击“创建”按钮。

字段说明：

• 数据集名称：必填项。
• 数据集标识：选填项。作为操作数据集的唯一标识，不填则会由系统自动生成。
• 描述：选填项。根据需求填写数据集的描述文字。

刚创建的数据集只包含“数据集名称”等基础信息，需要编辑数据集进行其它内容的设置。

编辑数据集

点击左侧【数据源管理】列表中需要编辑的数据集，在右侧的数据集详情页面进行编辑，点击【保存】按钮对修改的内容进行保存。

请求方法和请求地址

请求方法

默认为“GET”方法。请求方法包含“GET”、“POST”、“PUT”、“HEAD”、“DELETE”、“OPTIONS”和“PATCH”。选择“POST”、“PUT”和“PATCH”方法时可以填写Body属性。

请求地址

填写请求地址，可以引用变量，格式为{{变量名称}}。

本地变量

变量参数可以在数据集设置中引用。

点击【添加变量】可以添加新的变量，如下图所示：

变量的使用方法可参考数据源中的“全局变量”。

如果数据源变量与数据集变量的名称相同，则优先使用数据集变量。

预置变量

数据集中默认提供了一些预置的变量：

• offset：可在开启分页是使用，用于定义分页查询的数据偏移量。
• limit：可在开启分页是使用，用于定义分页查询的最大数据量。

Headers 参数

Header 参数用于定义数据集的请求头，通过 key、value 键值对的形式进行设置。

如果数据源Headers与数据集Headers的key值相同，则优先使用数据集Headers。

引用变量

在Headers下的 key 和 value 中可以引用全局变量和本地变量，格式为 {{变量名称}}

Params 参数

Params 设置的 key 和 value 会作为参数被添加到请求地址“？”之后。

引用变量

key 和 value 可以使用全局变量和本地变量，格式为{{变量名称}}

Body 参数

Body 参数用于定义 HTTP 请求体，支持 FormData、x-www-form-urlencoded、json 类型。

引用变量

form-data 和 x-www-form-urlencoded 类型的 body ，键和值可以以{{变量名称}}格式引用全局变量和本地变量。

json 类型的 body ，字符串可以以${变量名称}格式引用全局变量和本地变量。

特别地，当：

1. 字符串不是 object 的键
2. 字符串中有且仅有一个变量引用
3. 字符串在变量引用的两侧没有其他字符

满足以上条件时，数字和布尔型的变量会以对应的类型替换原本的字符串，且未定义的变量替换为 null。

否则，字符串在替换过变量引用后仍以字符串形式出现在请求体中。

例如，如果变量 x 为数值 3：

{ "x": "${x}" }变量替换后为{ "x": 3 }，object 值的部分被替换，且替换为数值。如果想要替换为{ "x": "3" }，应当将变量 x 定义为字符串类型。

{ "${x}": "${x}" }变量替换后为{ "3": 3 }，object 键和值的部分被替换，但只有值的部分被替换为数值，键的部分仍为字符串。

{ "x": "value = ${x}" }变量替换后为{ "x": "value = 3" }，object 值的部分被替换，但由于变量引用的两侧还有其他字符，替换后仍为字符串形式。

{ "x": "${x}${x}" }变量替换后为{ "x": "33" }，object 值的部分被替换，但由于引用了不止一个变量，因此替换后仍为字符串形式。

raw 参数中可以使用全局变量和本地变量，格式为${变量名称}。

Content-Type

如果 headers 中没有设置 Content-Type，根据 body 的类型，请求会按如下规则自动设置 Content-Type：

• form-data 类型的 body：自动设置 Content-Type 为 multipart/form-data
• x-www-form-urlencoded 类型的 body：自动设置 Content-Type 为 application/x-www-form-urlencoded
• json 类型的 body：自动设置 Content-Type 为 application/json
• raw 类型的 body：如果 body 非空，自动设置 Content-Type 为 text/plain；如果 body 为空，不自动设置 Content-Type

分页参数

可设置是否启用分页查询，启用分页后将显示“数据项总数”，默认为开启分页。

• 数据项内容：在启用分页时显示为必填项，禁用分页时为选填项。用以确认返回数据的数据内容的JsonPath。
• 数据项总数：仅在启用分页时显示，且为必填项。用以确认返回数据的数据项总数的JsonPath。

字段

用于定义查询后返回的结果集中每条数据的字段，至少需要设置一个字段。

字段类型

支持以下几种类型：字符串、布尔型、整数型、浮点型、日期、日期时间、时间。

• 字符串与整数型可以添加枚举项，枚举值为对应返回值，枚举名称对应显示名称。
• 布尔型可以填写返回值为false或true时的字段名称。
• 浮点型可以选择返回值精度。
• 日期、日期时间、时间型可以按照时间格式回显。时间格式："%Y"代表年，"%m"代表月"%d"代表日"%H"代表时"%M"代表分"%S"代表秒。 如想表示时间格式为"2022-01-01 01:01:01"，则写为"%Y-%m-%d %H:%M:%S"。

数据集预览

点击数据集右下角的【预览】按钮。在【预览】弹窗中点击右下角的【查询】按钮进行数据预览。

若有变量则可以填写变量值作为参数进行数据查询。

若在选项中开启分页则会在页面底端显示分页。

删除数据集

点击左侧【数据源管理】列表中数据集的“删除”按键。在操作弹窗中点击“删除”按钮。在【删除确认】弹窗中点击“确定”完成删除操作。

全局变量

全局变量是用户自定义的一种变量。可以用于在逻辑开发、告警规则、虚拟点计算、组态开发等各种场景中使用。

NOTE

全局变量功能需要 v5.6.0 及以上版本。

命名空间

定义全局变量需要先定义命名空间，同一个命名空间下，变量名不可重复。

点击命名空间列表中的“+”按钮，弹出创建命名空间对话框，输入命名空间名称即可创建一个新的命名空间。

变量管理

选中命名空间，可以在右侧的表格中查看该命名空间下的变量。

点击“添加”按钮，可创建变量。

变量字段说明：

名称	说明
名称	变量名称，只能包含字母、数字和下划线，必须以字母开头，长度1-20个字符。
变量类型	支持 4 种常用类型：字符串、布尔型、数值型、JSON
描述	变量的描述信息

点击“查看值”按钮，可显示该变量的当前值，在输入框中输入新值，并点击“确定”按钮，可以对变量值进行修改。