注册原始指标¶
注册原始指标是对数据源 API 的原始字段进行解释的过程。原始指标注册成功后,才能在指标表达式中被引用,用于自定义业务指标。
原始指标可作为定义业务指标的素材,也可在开放查询后通过通用数据服务 API 查询。
通用数据服务面向不同的使用场景,提供以下方式注册原始指标:
如需在通用数据服务注册全新的原始指标或更新通用数据服务已有原始指标,包括公有和私有原始指标,可通过 导入文件 的方式批量注册。
若已在指标管理中注册过原子指标,并配置了派生指标和衍生指标,可选择直接 从指标管理同步 至通用数据服务的私有原始指标和私有派生指标,减少手动匹配、调试、导入的工作量。
前提条件¶
当前帐号已被分配所需的资产权限、操作权限点和包含 原始指标 在内的菜单组。如未分配,联系应用管理员。
如需从指标管理同步指标,确保帐号已被分配指标同步相关权限点。如未分配,联系应用管理员。
通过文件导入 ¶
在左侧导航栏中选择 原始数据 > 原始指标。
根据目标指标的生效范围选择 公有指标 或 私有指标 标签页,点击 导入。有关公有/私有指标的区别,参见 公有/私有指标。
在弹窗中点击 下载模板,选择下载 Excel 或 JSON 模板文件。
参考以下信息填写模板文件。
字段名称
标识符
必填/选填
描述
字段Key
fieldKey
必填
数据源 API 提供的原始指标字段的标识符,需保证在同一作用域(公有/私有)内同一数据源中同一对象类型下的唯一性。
字段中文/英文/日语/西班牙语名称
fieldNameZh/En/Ja/Es
中文和英文为必填
数据源 API 提供的原始指标字段的多语言名称。
API Key
srcKey
必填
数据源 API 的标识符。可前往 数据源 查看所属数据源 API 的标识符。
对象类型标识符
mdmType
必填
指标对应的对象类型的标识符。可前往 业务对象类型 查看对应对象类型的标识符。
对象类型名称
mdmTypeName
选填
指标对应的对象类型的名称。可前往 业务对象类型 查看对应对象类型的名称。
数据类型
dataType
必填
指标数值的数据类型。目前支持的数据类型:Int,Double,String。
是否可排序
sortable
选填
若查询指标时可以按升/降序返回结果,填写
Y
;若不可排序,填写N
。筛选器
filters
选填
查询指标时支持的筛选方式。目前支持的筛选方式:in,==,!=,>,>=,<,<= 。多个筛选方式之间用英文逗号分隔,例如:==,in。
聚合方式
aggMethod
选填
多对象查询时支持的指标聚合方式。例如:传入一组光伏电站 ID,查询汇总的
发电量
指标时,系统将返回多光伏电站的发电量之和(sum)。目前支持的聚合方式:sum,avg,max,min。查询间隔
interval
选填
指标支持的查询间隔。目前支持的查询间隔:L(最新数据),15m(15 分钟),30m(30 分钟),H(小时),D(日),W(周),M(月),Q(季),Y(年),T(总计)。多个查询间隔之间用英文逗号隔开,例如:D,W,M,Y,T。
关联测点
accumulativePoint
选填
通用数据服务提供当日、当月、当年、总等二级指标时,会用指标的历史值+当日值,其中当日值由通用数据服务基于关联测点查询累计型测点 API 得到。
单位
units
选填
指标数值的单位,参考 EnOS 内置单位 填写。
聚合维度
dimensions
选填
支持的指标查询聚合维度的标识符,多个聚合维度之间用英文逗号分隔。例如:光伏电站的
等效利用小时
指标支持按电站类型或其下的逆变器机型聚合查询,那么查询结果将会按电站类型或逆变机型返回结果。可前往 业务对象要素 > 维度类型 查看对应维度类型的标识符。是否开放查询
openForQuery
选填
开放查询后的原始指标可以通过 通用数据服务 API 查询。Y 表示开放查询,N 表示不开放查询,默认为 N。
备注
导入模板中的“所属组织标识符”、“所属组织名称”、“更新时间”、“操作人”和“是否与公有标识符重复”字段无需填写,将在上传后由系统自动填充。
在弹窗中点击 上传。选择填写后的模板文件并点击 确定。注册私有指标时,若文件中的指标标识符与已注册的公有指标标识符重复,引用重复的标识符时,系统将使用私有指标。
从指标管理同步 ¶
备注
仅支持同步 EnOS 指标管理中的派生指标和衍生指标。同步指标前,确保:
已在指标管理中注册对应指标,并完成属性配置。更多信息,参见 将派生指标同步到通用数据服务 和 将衍生指标同步到通用数据服务。
已注册规约为
OLAP 2.3
的数据源,否则当前 OU 不支持同步指标。更多信息,参见 注册数据源。当前帐号已获取指标同步相关权限点。如未分配,联系应用管理员。
在左侧导航栏中选择 原始数据 > 原始指标。
在 私有指标 标签页中,选择 导入 > 同步自指标管理。
在弹窗中选择指标所关联的业务对象类型。一次最多选择 10 种业务对象类型。
选择 同步,完成指标同步。
同步成功后,可继续同步为业务指标。更多信息,参见 从指标管理同步业务指标。
从指标管理同步而来的指标均为私有指标,私有指标标识符不能与当前 OU 已有的私有原始指标和私有业务指标标识符重复。下表展示来自指标管理的指标与当前 OU 指标标识符重复的结果:
新增指标类型 |
新增指标来源 |
已有指标类型 |
已有指标来源 |
标识符重复的结果 |
---|---|---|---|---|
公有 |
通用数据服务 |
私有 |
指标管理 |
无影响 |
私有 |
通用数据服务 |
私有 |
指标管理 |
相同标识符的已有指标的所有信息将被覆盖。 |
私有 |
指标管理 |
公有 |
通用数据服务 |
无影响 |
私有 |
指标管理 |
公有 |
指标管理 |
无影响 |
私有 |
指标管理 |
私有 |
通用数据服务 |
相同标识符的新增指标将同步失败。 |
私有 |
指标管理 |
私有 |
指标管理 |
相同标识符的已有指标的所有信息将被覆盖。 |
结果¶
注册成功后,原始指标出现在指标列表中。应用构建者可以进行以下操作: