业务实体

实体是构建 RB 系统的基础。

实体

作为业务数据的载体，业务实体（Business Entity）约定了数据的格式、约束以及与其他实体（数据）间的关联。通过各个实体之间的关系，可以达成具体业务的实现，例如订单与客户、仓库与库存、订单与订单明细等。

在一套业务系统中通常会存在许多实体，这些实体各司其职的同时也能进行有机的结合。例如在一条“订单”记录中，通常包括订单所属的“客户”，这其中订单与客户即存在着引用/关联关系。

在系统实施前期，应当充分考虑与梳理业务实体模型。良好的实体关系设计有利于业务需求的达成，提高系统的易用性，也能够避免冗余或无效数据的存在。

添加实体

进入管理中心 - 实体管理，点击 [添加实体] 进行添加。可以手动添加，也可以从 RB 线上仓库导入。

输入实体名称，点击 [确定] 即可，添加后会进入实体管理页。其中：

• “添加名称字段”表示自动添加一个文本字段并将其设置为 名称字段（此选项是可选的，你可在添加实体后再自行添加）
• “这是一个明细实体”表示添加的实体需要依附在一个主实体上（例如订单明细通常依附于订单），需要注意的是目前 RB 仅支持一个主实体对应一个明细实体

管理实体

添加实体后可以对实体进行进一步的配置，实体管理页有非常丰富的选项供使用。

上图中，名称字段 将作为主显字段、列表点击字段，以及快速查询字段。快速查询字段 是作为可供快速搜索的字段。

主显字段（名称字段）

顾名思义，主显即主要显示字段，例如在下图中“相关客户”（引用字段类型）所显示的就是来自主显字段值（列表亦是如此）

同时，主显字段在列表中会显示为一个 带下划线的链接，点击即可打开记录视图（也可以选中某条记录，然后点击右上角的 [打开] 按钮打开）。

快速查询字段 ~~v2.1

快速查询会应用在多个地方，包括列表中的快速查询，表单页引用字段的快速搜索等。

?注意：默认情况下系统会将名称字段、自动编号字段作为快速查询字段，如果配置了快速查询字段，则以配置的为准

字段

在实体中，最小单位是字段，即可以把实体看作是一组字段的集合。例如在“客户”实体中，包括了“客户名称”、“联系电话”、“所在行业”等字段。这些字段构成了对一个客户的完整表述。

添加字段

进入管理中心 - 实体管理，点击某个实体后进入实体管理页 - 字段管理，点击右上角 [添加] 按钮进行添加。

输入字段名称，选择字段类型（详见下文），最后点击 [确定] 即可，添加后会进入字段管理页。

管理字段

根据不同的字段类型，会有不同的配置选项，如下图是一个引用型字段的配置选项。

其中，多数选项都是显而易懂的，根据字面意思理解即可，此处不再赘述。下面只针对一些可能产生误解的选项进行说明。

• 允许新建 即只能在新建记录时填写
• 允许更新 即记录创建后是否还允许修改
• 允许重复 无论是新建还是更新，如果检测到重复值将会弹出窗口提示哪些重复，并且 不允许保存

引用字段

• 附加过滤条件 可以在选择引用记录时会自动过滤出符合条件的数据

引用字段还可以配置 表单回填，详见下文

自动编号字段

• 编号规则 由常量和变量组成，变量使用 {} 包裹，变量支持
  • YYYY 4 位年份，如 2020
  • YY 2 位年份，如 20
  • MM 2 位月份，如 09
  • DD 2 位日，如 21
  • HH 2 位时，如 23
  • II 2 位分，如 59
  • SS 2 位秒，如 57
  • 0000 自增数字，如 0001（长度可以自定，如 00 000000）
  • 以上变量可组合使用，例如 ABC-{YYYYMMDD}{00000}
• 自增数字归零 即变量中的自增变量是否需要清零（重新从 1 开始计数）以及清零时间

字段类型

为了保证数据的有效性，应该为字段选择合适的字段类型，RB 会在用户填写时做相应校验，不符合的数据将会提示用户错误无法录入。例如电话号码应该选择“电话”而非“文本”类型。以下是 RB 目前所支持的数据类型。

字段类型	备注
文本	一般文本，如客户名称。最大长度 200
多行文本	长文本，如客户跟进情况。最大长度 32767
电话	电话号码或手机号码
邮箱	邮箱地址
链接	支持 http https ftp
自动编号	可设置编号规则，支持 年月日 及 自增序号 变量。如订单号
整数	无小数位数字
货币	含小数位数字
日期	仅日期。如 YYYY-MM-DD
日期时间	包括时间部分。如 YYYY-MM-DD HH:II:SS
下拉列表	下拉列表选项。如客户来源、订单类型等拥有固定值的字段
多选	多项选择，最多支持 64 个选项
分类	可以看作是超大“下拉列表”，带有级联选择关系。如地区（省市区）
引用	与其他实体进行关联，单一引用。如订单实体中的客户字段
多引用 ~~v2.1	与其他实体进行关联，多个引用，最多支持 20 个
文件	无
图片	无
头像	无
二维码	支持二维码与条形码
布尔	单选（是/否）

如默认字段长度不能满足需求可自行至 MySQL 表中修改，但请注意符合 MySQL 索引对于字段长度的要求（根据 MySQL 版本不同而不同）

字段默认值

绝大部分字段支持默认值配置。关于默认值的生效时机，分为两种情况。

1. 字段已布局在表单中：新建时会自动填写，用户可根据需要重新填写
2. 字段未布局在表单中：会在后端进行自动填写（因此默认值在 OpenAPI 中调用也会生效）

? 如字段未布局在表单中，请将字段设置为“允许为空”。因为虽然默认值会在后端自动填写，但无法通过自动填写前的基础校验逻辑

系统字段

当新建一个实体，系统将自动添加以下系统级字段，这些字段值通常由系统自动填写，用户无需关心。

字段	说明
所属用户	记录的所属用户（可通过分派修改）
所属部门	记录的所属部门（与所属用户联动）
创建时间	记录何时创建
创建用户	记录由谁创建
修改时间	记录最近更新时间
修改用户	记录最近更新用户
审批流程	选择的审批流程（实体开启审批流程后可用）
审批状态	当前流程状态（实体开启审批流程后可用）

引用字段扩展

表单回填

当在表单页选择引用字段（值）时，系统将按照设置好的规则自动回填页面上其他字段的值，以此减少重复录入，还能避免错误录入的情况发生。

例如在“订单”中存在一个“相关客户”引用字段，在选择客户时我们希望将相关客户的“电话”自动回填到订单的“电话”中，此时可以在订单的“相关客户”字段中配置表单回填规则。

? 目标字段需要与源字段在类型上保持兼容，例如“电话”类型的字段无法回填到“数字”类型的字段，对于不兼容的目标字段 RB 已自动过滤

? 系统无法对未布局/未显示在表单上的字段进行回填，回填仅仅是页面上发生的行为。如需后端回填或跨实体回填，请考虑使用 触发器-字段更新

点连接

在涉及到字段的配置中（如报表模板设计），引用字段可以通过 . 连接，以此来使用其他实体的字段。例如 createdBy.email 表示创建人（用户）的邮箱，或者更复杂一些 createdBy.deptId.principalId 表示创建人（用户）的所在部门（部门）负责人，RB 支持无级连接。

页面布局

当实体和字段添加完毕后，我们需要将其布局到相应的页面才能使用，包括表单页与列表页。

表单布局

表单常用于数据录入。得益于 RB 的可配置特性，您可以通过配置决定录入哪些数据，并且可以指定哪些数据是必填、哪些数据是选填。

进入管理中心 - 实体管理，点击某实体进入配置页 - 表单设计 即可进行配置。

1. 点击 (1) 字段列表中额字段，可以添加到布局中
2. (2) 显示已布局字段，长按可以拖动位置
3. (3) 可以对字段进行高级控制（详见下文）

布局将同时应用于表单页和视图页。目前仅支持一个布局，且仅有管理员可配置，后续会增加多布局支持

高级控制 ~~v2.2

布局高级控制可控制在数据录入时（新建或修改）的字段状态，包括是否显示、是否必填。请注意 [必填] 选项，如果字段本身不允许为空，则不能在表单中对其进行非必填控制。

? 表单高级控制仅是前端页面行为，如通过 OpenAPI 等方式操作则不会进行验证。如需严格验证请使用 字段属性 控制

列表布局

当数据录入完毕后，我们需要方便的进行查阅和管理，这便是列表所承担的职责。

列表布局即列显示，通过列显示控制要显示的字段。进入列表页后点击右侧 [更多] - [列显示] 即可进行配置。

列显示可以由用户自行配置（可以通过角色控制是否允许），也可以由管理员配置好以后分享给他人使用（只读），一般我们建议此项由管理员配置。