初次配置 EnOS 通用数据服务¶
本文介绍初次配置 EnOS 通用数据服务的具体步骤。
前提条件¶
开始之前，请确保以下事项：
当前 OU 已获取、授权和启用通用数据服务并已为资产树配置标签
EnosCDS:true。当前 OU 中通用数据服务已被分配以下 API 接口权限：
- 获取本 OU 内所有用户 ID、账号、邮箱、手机号码。
- 获取本 OU 内所有用户的权限信息。
有关如何分配 API 接口权限，参见 授予应用 API 接口权限。
当前帐号已被分配所需的资产权限、操作权限点和包含通用数据服务所有菜单在内的菜单组。如未分配，联系应用管理员。
配置流程¶
通用数据服务配置流程如下图所示。
- 确定现有数据集是否可以满足需求：
- 若是，通过通用数据服务 API 获取数据。
- 若否，进入下一步。本文假设现有数据集无法满足需求。
- 确定基于现有数据配置虚拟数据是否可以满足需求：
- 若是，配置虚拟数据并通过通用数据服务 API 获取数据。
- 若否，进入下一步。本文假设基于现有数据配置无法满足需求。
- 准备所需数据集并按照规范进行数据源 API 标准化，之后将该数据源注册到通用数据服务。
- 数据源注册完成后，在通用数据服务上注册元数据，声明该数据源可提供的数据内容。
- 注册完成后，调用通用数据服务 API 查询数据，验证配置是否成功。
步骤 1：注册数据源 API¶
| 操作人 | 操作地点 |
|---|---|
| 应用构建者 | EnOS 应用门户 |
- 登录 EnOS 应用门户，在应用列表中选择 通用数据服务。
- 在左侧导航栏中选择 数据源。
- 根据目标数据源的生效范围选择 公有数据源 或 私有数据源 标签页，点击 新建。
- 在新建数据源页面按需填写数据源的基本信息和配置信息后，点击 提交。
更多信息，参见 注册数据源。
步骤 2：注册元数据¶
| 操作人 | 操作地点 |
|---|---|
| 应用构建者 | EnOS 应用门户 |
通用数据服务可以注册多种类型的数据供数据消费者使用，包括记录类型、维度类型、对象类型、原始指标、标准指标、虚拟测点和虚拟属性。以下分别介绍注册不同类型元数据的步骤，应用构建者可基于数据源能够提供的数据类型按需注册。
注册对象类型¶
- 在左侧导航栏中选择 元数据 > 对象类型。
- 根据目标对象类型的生效范围选择 公有对象类型 或 私有对象类型 标签页，点击 导入。
- 在弹窗中点击 下载模板，选择下载 Excel 或 JSON 模板文件。
- 在模板中按需填写对象类型的信息。
- 在弹窗中点击 上传。选择填写后的模板文件并点击 确定。
更多信息，参见 注册对象类型。
注册维度类型¶
- 在左侧导航栏中选择 元数据 > 维度类型。
- 根据目标维度的生效范围选择 公有维度类型 或 私有维度类型 标签页，点击 导入。
- 在弹窗中点击 下载模板，选择下载 Excel 或 JSON 模板文件。
- 在模板中按需填写维度类型的信息。
- 在弹窗中点击 上传。选择填写后的模板文件并点击 确定。
更多信息，参见 注册维度类型。
注册记录类型¶
- 在左侧导航栏中选择 元数据 > 记录类型。
- 根据目标记录类型的生效范围选择 公有记录类型 或 私有记录类型 标签页，点击 导入。
- 在弹窗中点击 下载模板，选择下载 Excel 或 JSON 模板文件。
- 在模板中按需填写记录类型的信息。
- 在弹窗中点击 上传。选择填写后的模板文件并点击 确定。
更多信息，参见 注册记录类型。
注册原始指标¶
- 在左侧导航栏中选择 元数据 > 原始指标。
- 根据目标指标的生效范围选择 公有指标 或 私有指标 标签页，点击 导入。
- 在弹窗中点击 下载模板，选择下载 Excel 或 JSON 模板文件。
- 在模板中按需填写指标的信息。
- 在弹窗中点击 上传。选择填写后的模板文件并点击 确定。
更多信息，参见 注册原始指标。
注册标准指标¶
- 在左侧导航栏中选择 元数据 > 标准指标。
- 根据目标指标的生效范围选择 公有指标 或 私有指标 标签页，点击 导入。
- 在弹窗中点击 下载模板，选择下载 Excel 或 JSON 模板文件。
- 在模板中按需填写指标的信息。
- 在弹窗中点击 上传。选择填写后的模板文件并点击 确定。
更多信息，参见 注册标准指标。
步骤 3：验证配置结果¶
| 操作人 | 操作地点 |
|---|---|
| 应用构建者 | 通用数据服务 API 接口 |
所有配置任务完成后，应用构建者可以通过通用数据服务查询各种类型的数据，包括资产相关信息、测点和指标的实时数据、指标历史数据和第三方记录等。有关数据查询方法，参见 通用数据服务 API 文档。