外部字段
外部字段用于定义外部表单的数据模型。在外部字段管理中,管理员可以创建字段、选择字段类型、配置必填和空值规则、设置标识字段,并通过 Excel 工作簿导入或导出字段定义。
外部字段归属于选中的外部表单。先打开 外部表单,选择一个外部表单,再进入 字段。
外部字段页面
从外部表单进入 字段。
页面展示选中外部表单的字段,并通过摘要卡片展示当前字段模型状态。
| 区域 | 说明 |
|---|---|
| 返回 | 返回外部表单页面 |
| 搜索外部字段 | 按关键字筛选字段列表 |
| 新建外部字段 | 打开外部字段新建窗口 |
| 导入字段 | 从 .xlsx 工作簿导入字段定义 |
| 导出字段 | 将当前字段定义导出为工作簿 |
| 标识字段 | 设置用于识别外部记录的字段 |
| 字段列表 | 展示字段名称、编码、类型、标签、状态和审计信息 |
点击字段后会选中该字段。双击字段会打开编辑窗口。
字段摘要
摘要区域帮助管理员检查外部表单模型是否已经适合参与集成。
| 摘要 | 说明 |
|---|---|
| 标识字段 | 用于唯一识别外部记录的字段 |
| 必填字段 | 同步时必须提供值的字段 |
| 启用字段 | 当前可参与对接的字段 |
| 停用字段 | 当前不参与对接的字段 |
| 引用字段 | 已关联到另一个外部表单的字段 |
| 选项字段 | 已配置枚举选项的字段 |
启用外部表单或发布依赖该表单的集成流之前,建议先检查摘要。
新建外部字段
- 从选中的外部表单进入 外部字段
- 点击 新建外部字段
- 从左侧选择字段类型
- 填写 字段名称
- 确认或修改 字段编码
- 按需配置 是否必填 和 允许空值
- 如果字段类型需要引用或选项配置,继续填写对应配置
- 点击 保存
| 字段 | 必填 | 说明 |
|---|---|---|
| 字段类型 | 是 | 决定字段样式和数据类型 |
| 字段名称 | 是 | 显示在字段列表和相关 OpenLink 配置中的名称 |
| 字段编码 | 是 | 映射、导入导出和集成流使用的稳定编码 |
| 是否必填 | 否 | 标记同步时是否必须提供该字段 |
| 允许空值 | 否 | 控制是否允许空值 |
| 引用对象 | 条件必填 | 外键字段需要引用另一个外部表单时配置 |
| 枚举选项 | 条件必填 | 单选和复选字段使用 |
新建外部字段时,Soln 会根据字段名称建议字段编码。新建后的字段默认启用,但不会自动成为标识字段。
字段类型
外部字段复用适合外部数据模型的 Soln 字段样式。一些只适合运行时展示或自动生成的字段类型不会出现在外部字段中。
常见外部字段类型包括:
| 字段类型 | 适用场景 |
|---|---|
| 文本和长文本 | 名称、编码、备注等文本值 |
| 数字 | 金额、数量、评分等数值 |
| 日期、时间、日期时间 | 外部系统中的日期和时间类值 |
| 单选和复选 | 有枚举选项的字段 |
| 外键 | 引用另一个外部表单 |
| 对象 | 结构化的外部数据片段 |
单选和复选字段需要配置枚举选项。外键字段需要选择被引用的外部表单。
编辑外部字段
- 在列表中选择一个字段
- 点击 编辑,或双击字段
- 更新字段类型、名称、编码、标记、引用对象或选项
- 点击 保存
编辑字段会影响外部表单模型在映射和集成流中的使用方式。修改字段编码、字段类型、引用或选项后,建议检查依赖它的集成流。
标识字段
标识字段用于唯一识别外部记录。
- 点击 标识字段
- 选择一个已启用字段
- 点击 保存
| 规则 | 说明 |
|---|---|
| 只能有一个标识字段 | 每个外部表单只能设置一个标识字段 |
| 必须保持启用 | 被选为标识字段的字段必须保持启用 |
| 启用表单必须有标识字段 | 外部表单启用时必须保留一个标识字段 |
| 不能直接删除 | 删除当前标识字段前,需要先更换标识字段 |
建议选择稳定且长期唯一的字段,例如外部 ID 或业务编码。
启用或停用字段
使用列表操作启用或停用字段。
| 状态 | 影响 |
|---|---|
| 启用 | 字段可以参与 OpenLink 配置 |
| 停用 | 字段保留在模型中,但不参与启用中的集成使用 |
标识字段不能直接停用。需要先设置另一个标识字段,再停用原字段。
删除字段
- 选择一个已停用字段
- 点击 删除
- 确认删除
启用中的字段需要先停用后才能删除。标识字段需要先更换后才能删除。
导入和导出字段
当需要批量创建或更新字段时,可以使用 Excel 导入和导出。
| 操作 | 说明 |
|---|---|
| 导出字段 | 下载当前外部字段工作簿 |
| 新增字段模板 | 下载用于新增字段的模板 |
| 更新字段模板 | 下载用于更新已有字段的模板 |
| 导入字段 | 上传、解析、预览并导入 .xlsx 工作簿 |
导入流程会在导入前校验字段编码、字段名称、字段类型、必填和允许空值、引用对象编码、选项、状态和标识字段规则。
导入列
| 列 | 说明 |
|---|---|
| 字段 ID | 更新已有字段时需要 |
| 字段编码 | 稳定的字段编码 |
| 字段名称 | 字段展示名称 |
| 字段类型 | 外部字段类型 |
| 是否必填 | 字段是否必填 |
| 允许空值 | 是否允许空值 |
| 引用对象编码 | 外键字段引用的外部表单编码 |
| 枚举选项 | 选择类字段的选项,一行一个 `label |
导入只支持 .xlsx 文件。
推荐配置流程
为新的外部表单配置字段时,建议按这个顺序处理:
- 创建外部表单,并保持停用
- 新建或导入外部字段
- 配置引用对象和枚举选项
- 设置标识字段
- 检查必填和空值规则
- 需要留档或评审时,导出字段工作簿
- 标识字段和必要字段配置完成后,启用外部表单