一、功能概述:
在工单中,通常使用【下拉列表】类型字段来承载具有若干标准选择项的字段,但会有如下两种特殊场景无法使用此字段类型来满足使用诉求。
- 场景1:标准选项值数据量过大(大于1000条)时,若直接使用【下拉列表】类型字段,选项值在前端加载耗时较长,影响体验,若数据量大到一定程度,还有可能造成系统卡顿,阻塞使用流程。
- 场景2:标准选项值来自于外部系统,且选项值变更频繁,若通过人工在系统中维护这些选项值,不仅无法实现选项值与三方系统的实时同步,频繁的更改还会增加维护的工作量。
为了支持以上两种场景,工单中新增了【外部扩展】类型的字段,下属【外部扩展-下拉列表】【外部扩展-列表检索】两种数据类型。外部扩展字段,顾名思义,是与外部系统数据实现对接,可在完成了接口对接配置后,从外部接口中获取选项值并展示,用户在前端可直接选用需要的选项值并回填至文选择框中,使用体验与正常的【下拉列表】字段非常相近或几乎无感知。
二、适用场景:
以下为三种下拉相关字段的适用场景,用户可根据自己的需求选择适合的字段类型。
【下拉列表】:适用于选项值条数小于1000条,且选项值相对固定的场景。
【外部扩展-下拉列表】:适用于选项值条数小于1000条,但需要从外部接口动态获取选项值的场景。
【外部扩展-列表检索】:适用于选项值条数大于1000条,或需要从外部接口动态获取选项值的场景。
三、功能表现:
【外部扩展-下拉列表】:功能表现与正常的下拉列表字段的交互完全一致。
【外部扩展-列表检索】:支持对选项值进行模糊查询,未输入目标查询值时,无选项展示,在输入目标查询值后,可根据键入的值进行选项查询,并通过列表展示满足条件的选项值,选中目标选项值后,选项可回填到选择框中。
四、功能配置:
- Step1:在自定义字段中新增【外部扩展】类型字段。
- Step2:将字段添加到表单模版中,并完成【拓展配置】设置。
- API地址:配置外部对接接口地址,字段的选项值将从此接口中进行获取。
- token:接口需要进行鉴权,可支持在url中拼接token后进行接口调用(会将配置的token直接拼接在请求头中,无加密)。
- 超时配置:配置接口调用的超时时间和调用失败时的重试次数,超时时间可输入1-10秒,重试次数可输入0-3次。
- 显示参数:配置字段选项列表取值于哪个返回参数。
- 同步参数:配置该字段用于字段同步功能的触发字段时,取哪个返回参数用于字段同步的入参。
五、接口示例与场景举例:
- 为方便您更好的理解功能的配置方式及交互效果,我们为您提供了体验接口,您可以按如下配置方式,将体验接口配置在您的系统中,真实感受功能的使用方式。
外部扩展-下拉列表
- token:无需填值
- 超时配置:按范围要求配置即可
- 显示参数:result.name
- 同步参数:result.id(无需体验字段同步功能时,不用配置此参数)
- 配置示例
- 查询:完成字段配置后,在搜索框中输入1或2后,可在下拉列表中选择到接口返回的值。
六、接口示例
- 外部扩展-下拉列表:对外部拓展-下拉列表,接口示例如下
- 请求地址:http: //<url>
- 其中url为接口地址
- 外部扩展-列表检索:对外部拓展-列表检索,接口示例如下,其中:
- 请求地址:http: //<url>?param=<param>&limit=<limit>&offset=<offset>
- 其中url为接口地址,其他参数名的解释如下