工单字段同步功能说明

  • 395 views

一、功能概述:

字段同步功能为工单与外部系统实现数据对接的方式之一,在配置了同步规则后,在新增或编辑工单时,若触发字段发生了变更,系统可将触发字段的字段值作为入参调用所配置的接口,并将接口返回的参数值回填到对应的被同步字段中。

二、适用场景:

当工单中所需的一些信息需要从外部系统实时获取时,可使用字段同步功能,即可节省客服的填单时间,又能保证信息的准确性。

场景1:有独立的CRM系统,客服在创建工单时,填入客户公司名称后(适用于ToB服务),可调用CRM系统接口获取更多的客户信息并自动回填到工单中。

场景2:有独立的订单系统,客服在创建工单时,仅需填写订单号/退单号,即可调用订单系统接口获取订单明细并自动回填所需信息到工单中。

三、功能表现:

  • 失焦触发:填写触发字段的值,并失焦,会自动调用字段同步中配置的接口,并将接口返回值回填到对应的字段中。
  • 按钮触发:填写触发字段的值后,点击【点击获取数据】按钮,会自动调用字段同步中配置的接口,并将接口返回值回填到对应的字段中。

四、功能配置:

基础信息:可配置规则名称和规则是否启用,仅当规则启用时,编辑触发字段才能触发字段同步。

规则配置:

  • 工单模版与表单模版:此配置项用于定位字段同步规则所需生效的表单,从大到小依次需选择的信息包括
    1. 模版类别
    2. 工单模版
    3. 表单类型
    4. 表单或子表单
    5. 子表单分类
  • 触发字段:触发字段指的是字段同步的入参字段,比如根据【公司名称】查询公司详细信息,根据【订单号】查询订单详情,此场景中的【公司名称】和【订单号】就被称作触发字段
    1. 在选择了工单模版与表单模版,定位了字段同步规则所需生效的表单后,可选择表单中的任一字段作为触发字段。
    2. 触发字段支持的字段类型包括:单行文本、多行文本、下拉、单选、多选、级联、外部扩展-下拉列表、外部扩展-列表检索、自增表格
  • 触发字段接口入参:调用外部接口时,会将所选触发字段的字段值作为接口入参的value,此处需填写的是调用接口时,接口的入参参数名,比如:触发字段=公司名称,三方接口要求的入参参数名=corpname,则在公司名称的字段值=【大艺术家】时,调用接口时的入参为:corpname='大艺术家'
  • 触发方式
    1. 失焦触发:在编辑了触发字段并失焦后,可触发字段同步的接口调用与字段回填
    2. 点击按钮触发:在触发字段后会显示一个【字段同步】icon,点击后可触发字段同步的接口调用与字段回填,如下图所示
  • 同步规则
    1. 被同步字段:工单中需要被接口返回值回填的字段。比如表单中的字段包括【客户电话】,【客户姓名】,【客户等级】,【客户地址】四个字段,需要填写【客户电话】后,调用外部接口获取【客户姓名】和【客户等级】【客户地址】的值并自动回填,则【客户姓名】【客户等级】和【客户规模】需配置成被同步字段。
    2. 返回参数:填充哪个接口返回参数的参数值到所选择的被同步字段中。比如接口返回字段值包括{level='VIP',name='夏女士'},则【客户等级】的返回参数应填写【level】,【客户姓名】的返回参数应该填写【name】。

接口配置:

  • API地址:配置外部对接接口地址,所需数据将从此接口中获取。
  • 超时配置:配置接口调用的超时时间和调用失败时的重试次数,超时时间可输入1-10秒,重试次数可输入0-3次。
  • 同步方式:配置接口的调用方式,目前支持post和get两种。
  • token:接口需要进行鉴权时,可支持在url中拼接token后进行接口调用。

特殊场景:下面列举了触发字段或同步字段是特殊类型的字段时的配置场景。

  • 触发字段=外部扩展-下拉列表/外部扩展-列表检索
    1. 触发字段的入参参数名:填写字段同步所调用接口的入参参数名即可
    2. 触发字段的入参参数值:若外部扩展-下拉列表/列表检索的扩展配置中,未配置【同步参数】,则触发字段同步时的入参字段值为【返回参数】的参数值,若配置了【同步参数】,则触发字段同步时的入参字段值为【同步参数】的参数值。
    3. 场景举例:比如外部扩展-下拉列表/列表检索的扩展接口返回数据如下图1,扩展配置中配置的【显示参数】为result.name,未配置【同步参数】,则使用该字段去触发字段同步时,入参的字段值为:部门1、部门2。若配置了【同步参数】=result.id,则在选择了字段值=部门1或部门2时,触发字段同步时的入参字段值为:11或22。场景举例:比如外部扩展-下拉列表/列表检索的扩展接口返回数据如下图1,扩展配置中配置的【显示参数】为result.name,未配置【同步参数】,则使用该字段去触发字段同步时,入参的字段值为:部门1、部门2。若配置了【同步参数】=result.id,则在选择了字段值=部门1或部门2时,触发字段同步时的入参字段值为:11或22。

  • 触发字段=自增表格
    1. 触发字段的入参参数名:入参参数名填写字段同步所调用接口的入参参数名即可
    2. 触发字段的入参参数值:在选择了自增表格作为触发字段后,还需选择将自增表格中的哪个字段作为入参的参数值来触发字段同步,如下图所示
    3. 场景举例:如下图所示,配置了【客户订单】字段中的【订单编号】作为触发字段,入参参数名为order,则在工单中,填写【订单编号】字段并失焦,或点击字段同步触发按钮时,可将【订单编号】字段中填写的字段值作为字段同步的入参“order=SF238902380"来调用字段同步接口,并将返回值回填到【客户姓名】【客户电话】【客户等级】字段中
  • 字段同步配置
  • 在工单中的表现
  • 被同步字段=外部扩展-下拉列表(关于该字段本身的扩展配置及接口要求描述,可参考:https://help.clink.cn/archives/6602
    1. 功能表现:被同步字段的字段类型=外部扩展-下拉列表时,可同步字段的可选范围,而不是直接同步字段值。
    2. 适用场景:比如【部门】字段的字段类型为外部扩展-下拉列表,全量的可选项有100个。希望实现的场景为,当【员工归属地】选择区域1时,该字段的选项个数变更为50个,当员工的归属地选择区域2时,该字段的可选项个数变更为20个,此时可以使用字段同步功能,将【员工归属地】设置为触发字段,将【部门】设置为被同步字段
    3. 场景举例
  • 外部拓展-下拉列表字段【部门】的外部扩展接口返回值如下
  • 字段同步接口的返回值如下,其中deptList接口返回值代表【部门】字段
  • 若希望通过【员工归属地】同步【部门】字段的选项范围,则字段同步的配置如下,在【同步值】中,需配置的参数名为【deptList.name,deptList.id】
  • 被同步字段=外部扩展-列表检索(关于该字段本身的扩展配置及接口要求描述,可参考:https://help.clink.cn/archives/6602
    1. 功能表现:被同步字段的字段类型=外部扩展-列表检索时,可同步字段的字段值。
    2. 适用场景:字段类型=外部扩展-列表检索,同时,其他字段填写了某个值时,能自动带入这个字段的字段值,同时,还能修改字段值的选项。比如,选择了【问题分类】后,希望能自动带出【处理人】字段,但同时,当人工判断【处理人】带入的不正确时,还需要修改【处理人】。其中【处理人】的字段类型=外部扩展-列表检索。
    3. 场景举例
  • 外部拓展-列表检索字段【处理人】的外部扩展字接口返回值如下
  • 字段同步接口的返回值如下,其中operator代表【处理人】字段
  • 若希望选择了【问题分类】后,自动填充【处理人】的字段值,则字段同步的【同步值】中,需配置的参数名为【operator】,但接口中该字段值的返回格式需要是【name_TinetTicket_id】,如【张三_TinetTicket_1】
  • 被同步字段=日期
    • 功能表现:被同步字段的字段类型=日期时,同步内容可选【值】或【范围】
      • 值:将接口中返回的值直接回填至日期选择框中
      • 范围:接口中返回可选日期或不可选日期,不可选日期会被置灰
    • 字段同步配置:
    • 接口返回值示例与表现:

五、接口示例与体验接口:

  • 接口示例

请求地址:http: //<url>?param=<param>

其中url为接口地址,参数名的解释如下

参数名类型说明
paramString请求模糊查询的参数名,也是字段同步中配置的入参参数名

字段同步-接口返回示例:

指定不可选日期范围和指定可选日期,一般不会同时返回,请根据需要选择其中一种进行使用:

  • 指定不可选日期:disabledDateRange
  • 指定可选日期:enabledDate
  • 体验接口

为方便用户更好的理解功能的配置方式及交互效果,我们为您提供了体验接口,您可以按上文中的配置方式,将体验接口配置在您的系统中,真实感受功能的使用方式:

  1. 接口地址:https://ticket-sh.clink.cn/api/field_sync/demo/getObjByParam
  2. 入参参数名:param
  3. 入参字段值:输入任意值均可返回结果
  4. 接口返回值

字段同步-体验接口返回值:

匿名

发表评论

匿名网友 填写信息

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen: