注册原始指标


注册原始指标是对数据源 API 的原始字段进行解释的过程。原始指标注册成功后,才能在指标表达式中被引用,用于自定义标准指标。应用构建者可以通过上传模板文件批量注册原始指标。

备注

原始指标只能作为定义标准指标的素材,无法通过通用数据服务 API 被查询和使用。

前提条件


开始之前,确保当前帐号已被分配所需的资产权限、操作权限点和包含 原始指标 在内的菜单组。如未分配,联系应用管理员。

操作步骤


  1. 在左侧导航栏中选择 元数据 > 原始指标

  2. 根据目标指标的生效范围选择 公有指标私有指标 标签页,点击 导入。有关公有/私有指标的区别,参见 公有/私有指标

  3. 在弹窗中点击 下载模板,选择下载 Excel 或 JSON 模板文件。

  4. 参考以下信息填写模板文件。


    字段名称

    标识符

    必填/选填

    描述

    字段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

    选填

    支持的指标查询聚合维度的标识符,多个聚合维度之间用英文逗号分隔。例如:光伏电站的 等效利用小时 指标支持按电站类型或其下的逆变器机型聚合查询,那么查询结果将会按电站类型或逆变机型返回结果。可前往 元数据 > 维度类型 查看对应维度类型的标识符。


    备注

    导入模板中的“所属组织标识符”、“所属组织名称”、“更新时间”和“操作人”字段无需填写,将在上传后由系统自动填充。

  5. 在弹窗中点击 上传。选择填写后的模板文件并点击 确定

结果


注册成功后,原始指标出现在指标列表中。应用构建者可以查看指标详情,并进行以下操作:

  • 修改原始指标:点击 导出,按需修改下载的文件后再导入新文件。“字段key”相同的指标会覆盖原有指标,不同则新增指标。

  • 删除原始指标:点击对应指标行的 删除 Delete 。指标删除后不可恢复。