注册记录类型¶
记录类型是非时序的事实数据的类型。只有在通用数据服务上注册过的记录类型,才能通过通用数据服务 API 查询这些记录的字段。应用构建者可以通过上传模板文件批量注册记录类型。
前提条件¶
开始之前,确保当前帐号已被分配所需的资产权限、操作权限点和包含 记录类型 在内的菜单组。如未分配,联系应用管理员。
操作步骤¶
在左侧导航栏中选择 元数据 > 记录类型。
根据目标记录类型的生效范围选择 公有记录类型 或 私有记录类型 标签页,点击 导入。有关公有/私有记录类型的区别,参见 公有/私有记录类型。
在弹窗中点击 下载模板,选择下载 Excel 或 JSON 模板文件。
参考以下信息填写模板文件。
分类
字段名称
标识符
必填/选填
描述
基础信息
记录类型标识符
recordType
必填
记录类型的标识符,需保证在同一作用域(公有/私有)内的唯一性。
基础信息
记录类型中文/英文/日语/西班牙语名称
nameZh/En/Ja/Es
中文和英文为必填
不同语言的记录类型名称。
基础信息
关联数据源
srcKey
必填
数据源 API 的唯一标识符,即 API Key。
基础信息
数据源路由参数
dataSourceParam
选填
数据源的路由参数。一个数据源可能会提供多类记录,通过在此处传参指定数据源中的记录类别。例如:{“recordType”:“WOWorkType”},含义为:通过
recordType
参数指定获取数据源中WOWorkType
的记录类型。基础信息
是否透出错误代码
showSubMsg
选填
若透出错误码,则填写
Y
;若不透出,则填写N
。默认值为N
。基础信息
父记录类型信息
references
选填
可关联多个父记录类型,格式为:
{“recordType”:“SubCommand”, “foreignKeys”:{“controlRecordId”:“controlRecordId”}}
。字段列表
记录字段Key
field
必填
记录字段的唯一标识符。
字段列表
字段中文/英文/日语/西班牙语名称
nameZh/En/Ja/Es
中文和英文为必填
不同语言的字段名称。
字段列表
字段中文/英文/日语/西班牙语描述
descriptionZh/En/Ja/Es
中文和英文为必填
不同语言的字段描述。
字段列表
数据类型
dataType
必填
字段的数据类型。目前支持的数据类型:Integer,Object,String,timeStamp,JSONObject。
字段列表
单位
units
选填
字段单位,参考 EnOS 内置单位 填写。
字段列表
表达式
expression
必填
指定字段的生成方式,可以直接配置单一字段名表示透传数据源中的字段,也可以通过配置表达式实现轻量计算。
字段列表
是否可排序
sortable
选填
若查询字段的结果可以按升/降序返回结果,则填写
Y
;若不可排序,填写N
。字段列表
筛选器
filters
选填
查询字段时支持的筛选方式。目前支持的筛选方式:in,==,!=,>,>=,<,<=。多个筛选方式之间用英文逗号分隔,例如:==,in。
字段列表
字段内容是否国际化
isl18n
选填
根据字段内容是否为 l18n 结构填写
Y
或N
,默认为N
。字段列表
是否按国际化返回
extractl18n
选填
根据是否需要按指定语言返回填写
Y
或N
,默认为N
。字段列表
枚举量来源类型
enumSourceType
必填
如果是静态枚举,则填写
static
;如果枚举来自通用数据服务的记录,则填写record
;如果枚举来自配置中心的维度表,则填写amcDimension
。字段列表
静态枚举量
enumerate
选填
如果枚举量来源为
static
,则指定枚举量的标识符和名称。字段列表
动态枚举来源ID
enumerateSourceID
选填
如果枚举量来源为
record
或amcDimension
,则指定关联的记录类型或维度表的标识符。字段列表
动态枚举字段映射
enumerateMapping
选填
如果枚举量来源为
record
或amcDimension
,则指定枚举量标识符和名称在关联记录类型或维度表中对应的字段。字段列表
是否关联子记录类型
isSubRecordType
选填
如果是关联子记录类型的字段,则填写
Y
,否则填写N
。字段列表
子记录类型返回字段
subRecordFields
选填
子记录类型中需要返回的字段。
备注
导入模板中的“所属组织标识符”、“所属组织名称”、“记录字段数量”、“更新时间”和“操作人”字段无需填写,将在上传后由系统自动填充。
在弹窗中点击 上传。选择填写后的模板文件并点击 确定。
结果¶
注册成功后,记录类型出现在记录类型列表中。应用构建者可以查看记录类型详情,并进行以下操作:
修改记录类型:点击 导出,按需修改下载的文件后再导入新文件。标识符相同的记录类型会覆盖原有记录类型,不同则新增记录类型。
删除记录类型:点击对应记录类型行的 删除
。记录类型删除后不可恢复。