数据字典的使用

最后更新:2021-12-07

1. 数据字典介绍

数据字典通过动态定义额外字段的名称,类型,字段值,字段特性等来扩展已有数据表的属性, 达到不增加表不需要开发参与即可增加定制字段的目的。是系统灵活性与兼容性的直观表现。

IDaaS系统中通过数据字典功能可对以下类型数据进行动态扩展。

  • 人员账户属性。

  • 组织机构属性。

  • 组属性。

  • 人员-组织属性(即兼职)。

并可设置各个属性的各类特性,包括是否必填,是否可修改,是否唯一,是否加密等。

2. 管理数据字典

以IT管理员或分级管理员(需要有’机构及组’管理权限)登录系统,依次进入:机构及组->数据字典,即可进入管理界面。

对数据字典管理功能包括有:

  • 添加/修改数据字典

  • 删除数据字典

  • 导入数据字典

  • 导出数据字典

  • 根据条件查询数据字典

2.1. 添加/修改数据字典

在数据字典管理界面点击’添加字段’进入添加界面,如下图:

表单字段说明

  • 字段名称:需要展示的提示名称,如:年龄。

  • 字段值:字段类型绑定的属性值,一般使用字母与数字,如:age。

  • 所属分类:选择此数据字典使用在哪类数据中,有以下选项:账户,组,织机机构与人员-组织属性。

  • 字段类型:选择此字段的类型,有以下选项:文本输入框,文本域,下拉框,日期(若选择下拉框,则需要添加具体的显示名称与字段值,且文本输入框默认最大长度32位,文本域255位,日期格式为YYYY-MM-DD)。

  • 默认值:填写默认值,如某个用户的该扩展字段没填值时,将启用此默认值;如果字段类型是下拉框时,默认值必须是某项下拉框的字段值。

  • 占位符:将填充字段控件的placeholder。

  • 描述:介绍该字段的特点或如何使用,描述信息将会展示在字段控件下方。

  • 字段排序号:数据字典排序号,控制字段在对象属性界面显示顺序,序号越大,越靠前,值为>0的整数。

  • 是否为必填,是否可修改,是否唯一,是否加密这几个属性根据实际需要启用或禁用即可。

  • 用户是否可见:勾选后在IDaaS后台普通用户-我的账户-个人信息中可展示,同时自定义门户用户数据中也有此数据。

  • 用户是否可修改:勾选后在IDaaS后台普通用户-我的账户-个人信息中可展示可修改,同时自定义门户用户数据中也有此数据,通过给定的接口也能修改此数据。

  • 字段状态:启用或禁用(只有启用的数据字典才能使用)。

对已经添加的数据字典,在操作栏点击’编辑’即可去修改数据字典,如下图:

注意:所属分类,字段类型,是否加密在编辑是禁用修改(若需要修改请先删除再重新添加)。

2.2. 删除数据字典

对已经添加的数据字典,在操作栏点击’删除’并确认后即可删除数据字典,如下图:

注意:只有禁用状态的数据字典可删除,且通过此数据字典添加的字段值也会同步删除。

2.3. 导入数据字典

导入数据字典可通过Excel一次性批量添加多个数据字典的信息。

在数据字典管理界面点击’导入数据’打开导入界面,如下图:

导入时需要先下载数据字典格式范例文档,并按要求准备好数据后(如下图),再导入对应的Excel文件,并点击’导入’按钮。

若在导入时有错误会提示具体的错误信息,按提示信息修改Excel文件后重新导入即可。

2.4. 导出数据字典

导出数据字典可将已有的数据字典数据进行备份,或导出到另一IDaaS系统中。

在数据字典管理界面点击’导出数据’按钮,系统即将已有的所有数据字典进行下载,如下图:

2.5. 根据条件查询数据字典

在数据字典管理界面上输入字段名称或选择一种类型,点击’搜索’即可按条件进行查询。

3. 使用数据字典

假设已经定义了3条数据字典并已启用。

分别给账户,组与组织机构定义了各自定义了一个数据字典。 以下的使用以此3条数据来进行说明。

3.1. 添加/修改数据时使用

  • 当在新建账户,添加组织机构,添加组时都会展示tab页’扩展属性’,里面填写具体的数据字典扩展属性值。

(添加账户时)

(添加组时)

(添加组织机构时)

  • 当在修改数据时,也会展示tab页’扩展属性’,若对应的数据字典支持修改,则可在更新数据值。

3.2. 详细数据时使用

当在查看具体的账户,组或组织机构的详细信息时,也能查看到具体的扩展字段信息。

(账户详情中扩展字段展示)

(账户详情中扩展字段展示)

3.3. API中使用

若在IDaaS中定义了数据字典并启用后,在通过IDaaS提供的API对账户数据,组织机构数据进行操作时, 可在API调用时同步对数据字典值进行查看或更新(一般通过参数名extendField来实现)。

在API中使用详见文档 用户目录(UD)

4. 扩展功能

4.1. 通过数据字典实现兼职功能

通过数据字典实现详见兼职功能如何使用