实体字段

2 分钟阅读

1.功能概述

字段是对实体属性或特征的描述。实体可直观的理解为一张数据库表，实体名对应表名，实体字段即对应表头。一个实体具有多个字段，根据业务需要设计师可以自行添加字段。

每个实体字段都有对应的名称、数据类型（如文本、整数、日期等），并且可以包含额外的属性，比如是否允许为空、是否有默认值、是否唯一等。这些字段共同定义了实体的结构，用于组织和存储信息，以便于进行查询、更新和管理。在应用中，实体字段通常与用户界面中的输入域或显示区域相对应，允许用户与数据进行交互。设计良好的实体字段不仅有助于确保数据的一致性和准确性，而且对于提高数据库的性能和可用性至关重要。

2.字段数据类型

数据类型是软件开发中的重要概念，它决定了可以数据存储的值的种类和范围。通过正确选择和使用数据类型，可以确保数据的准确性、一致性和有效性。例如，当需要存储一个人的年龄信息时，适合使用整数类型的数据来表示，而存储商品价格时则适合使用货币类型。

字段类型	字段说明
文本	表示一串包含字母、数字、和其他字符的字符串，通常用于文本的处理和数据存储。 ● 最多可输入4000字符 ● 支持设置正则规则规范其格式 ● 支持脱敏和加密设置
多行文本	特殊类型的文本，允许用户输入较长的字符串内容，阈值最多可输入 `10000`字符。多行文本最大阈值小于4000时，数据库按文本存储，且运行态提交时会校验数据长度。最大阈值大于等于4000时，数据库按大文本字段存储，且运行态提交时不会校验数据长度。注：文本字段和长度不超过4000的多行文本字段，其总字符数上限为16000，超出限制将无法新增文本类字段。
整数	表示没有小数部分的数字，可以是正数、负数或零。取值范围：-(2 `<sup>`31 `</sup>`-1) ~ 2 `<sup>`31 `</sup>`，即：`-2147483648 ~ 2147483647`
长整数	特殊类型的整数。取值范围：-(2 `<sup>`53 `</sup>`-1) ~ 2 `<sup>`53 `</sup>`-1，即：`-9007199254740991 ~ 9007199254740991`
小数	表示带有小数部分的数字，能够提供更高的精度，通常用于科学计算，或其他需要精度较高的场景，小数位数最大支持 `10`位。
货币	特殊类型的小数，可携带指定币种符号，通常用于货币计算。
日期	表示具体的日期，通常用于仅日期处理和数据存储。
时间	表示具体的时间，通常用于仅时间处理和数据存储。
日期时间	表示具体的日期和时间，通常用于日期和时间的处理和数据存储。
布尔	表示真（`true`）或假（`false`），通常用于条件判断。
选项集	选项集是一种自定义的数据类型，用于定义一组有穷序列集。选项集运行态无法修改，通常用于固定选项的序列集场景。例如“星期”就是一个选项集，`星期一、星期二、星期三、星期四、星期五、星期六、星期日`就是其值。注：选项集详细信息，请参考：空链接。
枚举	枚举也是一种自定义的数据类型，用于定义一组有穷序列集。枚举运行态可扩展，且支持多层级展示。例如“兴趣爱好”就是一个枚举，内部值可在运行态随时定义添加。注：枚举详细信息，请参考：空链接。
附件	通常用于存储指向文件的引用，而不是文件本身。借助页面中附件组件，用户可上传多种类型的文件，文件本身会存储于文件服务器，而附件字段将存储文件的路径、以及文件相关的元数据，如文件名、大小、创建者、创建日期等。
实体	通常用于存储其余实体的唯一标识ID，可建立实体间的关联关系。支持一对一关联或一对多关联。注：多选时，最多选择 `180` 个。
流水号	一种特殊的字段类型，用于唯一标识数据库中的每条记录，通常具有业务意义，如订单编码、交易记录等。流水号字段的值是按规则自动生成的，以确保其唯一性和顺序性。
正文	一种特殊的字段类型，通常用于存储带有格式的大文本，如新闻内容、报告详情等。 ● 支持内容的格式设置，如粗体、斜体、字号等 ● 支持HTML标签，允许用户创建包含各种样式和布局的文本内容 ● 其内容的查看和编辑需依赖页面中的正文组件（富文本编辑器）

3.字段属性

创建字段后，支持的配置如下：

名称：字段的显示名称，可使用中文等任一字符。配置后，在页面中如需展示该字段，会显示对应名称，如数据列表的表头会默认展示字段名称。
编码：字段的唯一标识，只能以字母开头，支持至多 30 个英文字母、数字的组合。
类型：字段数据类型，可根据实际需求选择字段类型。
默认值：字段的初始值。当在创建记录时没有为该字段提供值，系统将自动使用这个默认值进行填充，以减少数据缺失的情况。
计算值：基于其他字段值通过预定义的计算逻辑动态生成的字段值，这种值通常不是用户直接输入的，而是系统根据设置的公式或规则自动计算得出的，例如，根据商品的单价和数量自动计算总价，或根据日期字段计算年龄等。
必填：必填属性要求用户在创建或更新数据时，必须提供有效值。复选框勾选时表示必填，未勾选时表示非必填。勾选时，页面组件会自动校验此字段是否被用户填写。
唯一：设置该字段的值是否唯一，常用于标识记录的主键或确保实体的某个字段（如电子邮件地址、身份证号等）在整个数据集中具有唯一性。字段唯一支持单字段唯一和多字段组合唯一。
- 单字段唯一：单个字段内的值必须唯一
- 多字段组合唯一：由两个或多个字段组合而成的一组值必须在数据库表中保持唯一性
阈值设置：用于限定字段值的允许范围，确保输入或处理的数据满足特定的最小值和最大值要求，以防止无效或不合理的数据被录入数据库，例如，确保年龄字段或者价格字段不会记录负值。
默认显示：用于控制实体生成页面的显示内容，及页面中拖拽实体生成数据控件时的显示内容，支持设置显示在列表、详情、搜索中，如该字段在创建列表时是否自动生成列，自动生成搜索项
- 列表项：复选框勾选时，拖拽实体生成的列表含有该字段
- 详情信息：
- 快捷搜索项：
输入检验：文本字段支持使用正则规则进行内容格式检验同时支持自定义设置格式错误时提示
脱敏加密：文本字段支持脱敏加密配置
- 智能脱敏：智能识别手机号码、银行卡号、身份证号码及邮箱地址并做智能脱敏，其他类型数据全部替换为“”，脱敏效果仅针对页面显示生效
- 全脱敏：针对所有的类型数据全部替换为“*”，脱敏效果仅针对页面显示生效
- 加密：针对数据存储时进行加密，加密效果仅针对数据库数据生效
数据在异构系统加密：加密配置之一，适用于异构系统加密后通过 openapi 接口存入数据的情况
数据不解密传递给异构系统：加密配置之一，适用于 openapi 查询接口中数据不解密传递给异构系统的情况
审计：设置该字段数据是否进行审计。勾选后，平台将追踪和记录数据库中该字段的每一次变更
全文检索：设置是否能对该字段的内容进行全文检索
敏感词检测：用于字段敏感词检测标记，仅文本、多行文本、正文有该属性。勾选后，可遵循平台配置的敏感词监测规范，对该字段进行录入检测
- 保存记录时自动检测，并提示
- 配置页面事件，手动触发检测
默认控件：用于设置页面中拖入字段时自动使用的控件

4.字段分类

应用支持预置字段或用户自定义字段。

4.1预置字段

针对不同类型的实体，平台预置有不同的字段，可以满足最基本的业务需求，系统预置字段如下：

预置字段不可删除，其部分属性不可修改。

1、系统分组：系统字段，由系统自动管理，用以追踪记录的创建和变更历史，字段属性不可修改

ID：数据的主键信息，作为每条数据的唯一标识，数据类型为 Integer 整数类型。字段列表中不可见
创建时间：数据的创建时间，数据类型为 DateTime 日期时间类型
创建人：数据的创建人，数据类型为 Enity 实体类型
创建人机构：创建人所在机构，数据类型为 Enity 实体类型
创建人部门：创建人所在部门，数据类型为 Enity 实体类型
创建人岗位：创建人所在岗位，数据类型为 Enity 实体类型
更新时间：最后一次更新数据的时间，数据类型为 DateTime 日期时间类型
更新人：最后一次更新数据的人，数据类型为 Enity 实体类型
[实体]发送状态：流程中使用的状态，数据类型为 Enum 选项集类型。该字段值及对应的选项集均由系统自动生成
扣减规则信息：单据实体特有系统字段，用于记录扣减规则相关信息的字段，数据类型为 MultiLineString 多行文本类型
父实体：子实体特有系统字段，用于标注所属父实体id，数据类型为 Enity 实体类型
排序号：子实体特有系统字段，用于记录前端录入顺序，数据类型为 Integer 整数类型。前端页面不可见

2、流程分组：流程审批相关字段，由系统自动管理，仅档案和单据实体有该分组字段，字段属性不可修改

流程相关字段：单据状态（草稿、待提交、提交中、已生效）、流程模板、流程实例、流程标题等
流程过程字段：终止（是否终止、终止人、终止时间等）、作废（是否作废、作废人、作废时间等）等过程中特殊状态的相关字段

3、单据分组：单据实体独有字段，为单据业务的常用字段

单据编号：用于唯一标识单据的一串数字或字母组合，数据类型为 SerialNum 流水号类型
单据日期：单据生成或交易发生的日期，默认值为创建时间，可修改，数据类型为 DateTime 日期时间类型
申请人：业务中发起单据或请求的个人，默认值为当前登录人员，可修改，数据类型为 Enity 实体类型

3、档案分组：档案实体特有字段，为档案业务的常用字段

档案业务字段
- 组织机构：档案所属机构，默认值为登录人员所在机构，可修改，数据类型为 Enity 实体类型
- 编码：唯一标识每份档案的编号，数据类型为 String 文本类型
- 名称：档案名称，数据类型为 String 文本类型
- 简称：档案内容的简短描述，数据类型为 String 文本类型
- 助记码：与档案相关联的简短、易记的代码或标识符，数据类型为 String 文本类型
- 是否启用：档案启用状态，数据类型为 Boolean 布尔类型
树形档案的结构字段
- 上级：标识档案的上级或父级档案，用于建立层级关系，数据类型为 Enity 实体类型
- ID路径：从根节点到当前节点的数据ID路径，用于定位档案，数据类型为 String 文本类型
- 显示名称路径：从根节点到当前节点的数据显示名称路径，用于定位档案，数据类型为 String 文本类型
- 是否末级：指示器字段，用于标识当前节点是否是树结构中的最底层或末级节点，数据类型为 Boolean 布尔类型

4.2自定义字段

系统字段以外的字段为自定义字段，设计师可以通过添加自定义字段来扩展实体的描述，以满足具体的业务需求。

添加字段：点击字段列表左上方“ 添加 ”或单击列表下方的“ 添加 ”按钮来添加自定义字段。
删除字段：右键点击字段选择“ 删除所在行 ”或选中字段后单击列表上方的“ 删除 ”按钮来删除该字段。

5.补充说明

5.1字段分组

在实体字段列表中提供字段分组能力，允许将具有相似属性或属于相同业务逻辑的实体字段归类到一个组中。这种分组可以基于字段的数据类型、用途或其他自定义标准，从而简化数据的检索和维护。

添加分组：点击字段列表左上方“ 新建分组 ”来添加空白分组。
分组中添加字段
- 添加字段：鼠标移至对应分组，点击分组项右侧“添加字段”，可添加分组内字段。
- 拖入字段：勾选欲拖入分组的字段，鼠标左键长按字段左侧“拖拽”图标，拖入对应分组。
解散分组：鼠标移至对应分组，点击分组项右侧“解散分组”，可解散当前分组，解散分组后其包含的字段会移出到当前位置。
删除分组：鼠标移至对应分组，点击分组项右侧“删除”，或者勾选分组后，点击列表上方可删除当前分组，删除分组也将会删除其包含的所有字段。