外键
外键字段用于保存另一张表单中的一条关联记录 Key。当当前记录需要和目标表单记录建立直接关系时，可以使用外键字段。
如果关系需要指定来源表单，并且需要配置目标记录删除后的处理规则，例如发票关联合同、发货单关联订单、服务工单关联资产，就适合使用外键字段。
基础配置
| 配置项 | 说明 |
|---|---|
| 名称 | 展示给用户的字段标签，必填；名称应清楚表达这个关联关系 |
| API 名称 | 数据接口、脚本、公式、导入和集成使用的稳定技术名称，必填 |
| 必填 | 保存记录前必须选择一条关联记录 |
| 只读 | 展示已选择的关联记录，但不允许用户修改 |
| 停用 | 字段不参与常规使用 |
| 隐藏 | 字段会保存所选值，但不在常规表单页面展示 |
外键字段配置
| 配置项 | 说明 |
|---|---|
| 来源表单 | 提供可选记录的目标表单，必填 |
| 删除规则 | 控制目标记录被删除时，当前字段或当前记录如何处理 |
| 关联数据范围 | 可选 Studio 脚本，用于过滤用户可以选择哪些目标记录 |
| 校验时机 | 控制什么时候执行选择校验：值变更时、失焦时或提交记录时 |
| 占位提示 | 用户选择关联记录前显示在字段中的提示文案 |
| 弹窗标题 | 选择记录弹窗的标题 |
| 搜索占位提示 | 选择记录弹窗中搜索框的提示文案 |
| 输入状态 | 给字段添加警告或错误等视觉状态 |
| 无效选择提示 | 所选记录无效或不可用时显示的自定义提示 |
| 颜色 | 设置字段展示颜色 |
| 帮助文案 | 展示在字段附近的辅助说明；可用于说明用户应该选择哪类关联记录 |
删除规则
| 规则 | 含义 |
|---|---|
| 限制删除 | 目标记录仍被引用时，不允许删除目标记录 |
| 置空 | 目标记录被删除时，当前字段清空 |
| 级联删除 | 目标记录被删除时，当前记录一起删除 |
关联数据范围
当这个字段只允许选择来源表单中的一部分记录时，使用 关联数据范围。
常见场景：
- 只允许选择启用中的主数据
- 只允许选择当前客户账号下的合同
- 只允许选择可分配的资产
脚本绑定在当前来源字段上，在选择弹窗加载目标记录前执行。脚本返回 relationDataFilter 条件，条件字段使用目标表单字段 API 名称。
不要把这类过滤规则配置到目标表单页面事件里。Payload 和返回协议请查看 关联数据范围。
常见示例
| 场景 | 来源表单 | 建议规则 |
|---|---|---|
| 发票关联合同 | 合同 | 限制删除 |
| 发货单关联订单 | 订单 | 限制删除 |
| 工单关联资产 | 资产 | 置空 |
| 明细记录归属主记录 | 主表单 | 级联删除 |
配置建议
| 建议 | 说明 |
|---|---|
| 谨慎选择删除规则 | 只有当前记录不能脱离目标记录存在时，才建议使用级联删除 |
| 保持来源表单稳定 | 修改来源表单会改变已保存关联 Key 的业务含义 |
| 设置明确的占位提示 | 例如“请选择合同”，让用户知道应该选择什么 |
| 设置无效选择提示 | 当历史选择不可用时，用业务语言说明原因 |