搜索
更新人
更新时间 更新日期

1. 简介

1.1 功能概述

前端事件是一种表单数据交互能力,可在用户填写表单时主动调用外部接口,实现接口取数、数据校验、数据处理、事件触发等操作。通过安装并启用对应插件,无需编写代码即可完成前端事件配置。

1.2 应用场景

1.3 前提条件

使用前端事件前,需要先在 开放平台 安装并启用对应插件。

2. 设置入口

操作路径:表单设计页面 >> 表单属性 >> 前端事件

3. 操作指南

3.1 安装并启用插件

本文以“汇率转换”为例说明配置流程。
1)进入工作台「开放平台 >> 插件市场」,选择需要使用的插件,例如:汇率转换插件
2)进入插件详情页后,点击「安装」。
3)安装完成后,进入「插件管理」,在已安装插件列表中启用对应插件。
完成后,插件即可在前端事件配置中正常选择和调用。

3.2 搭建业务表单

根据插件需求创建对应字段。汇率转换场景中,可添加以下字段:
字段名称 字段类型 用途
货币类型-转换前 下拉框 存放转换前币种(设置选项为:CNY、USD、EUR、JPY、HKD、KRW等)
数值-转换前 数字输入框 存放转换金额
货币类型-转换后 下拉框 存放目标币种(设置选项为:CNY、USD、EUR、JPY、HKD、KRW等)
数值-转换后 数字输入框 存放转换结果

3.3 配置前端事件

3.3.1 添加前端事件
1)找到「表单属性 >> 前端事件」,点击「设置」。
2)点击「+添加前端事件」,进入配置页面。
3.3.2 设置事件名称与说明
1)填写事件名称(必填)。
2)根据需要填写事件说明(选填)。
完成后,可通过名称和说明区分不同前端事件。
3.3.3 设置触发字段
前端事件支持以下触发方式:
  • 字段值变更时触发 :当指定字段的值被手动修改时,系统自动触发前端事件。
  • 提交时触发 :用户点击提交按钮时触发。
  • 提交后触发 :表单数据提交成功后触发。
本文示例采用“字段值变更时触发”,触发字段设置为“货币类型-转换后”。
3.3.4 配置触发条件
触发条件用于进一步限定前端事件的执行范围。当触发字段发生变化后,系统将判断是否满足此处设置的触发条件,满足时才调用插件。
1)点击「配置条件」,选择筛选字段及筛选规则。支持的筛选规则包括:等于、不等于、等于任意一个、不等于任意一个、包含、不包含、为空、不为空。
2)根据需要添加多个条件或条件组,设置条件关系为“并且”或“或者”。
3)点击「筛选」保存条件。
本文示例中,设置“数值-转换前大于100 ”时触发前端事件。
3.3.5 选择触发插件并配置
1)在插件列表中选择需要调用的插件。本文示例中,选择“汇率转换”插件。
2)插件发送参数 用于定义调用插件时传递的数据。支持以下三种类型:
  • 字段值 :直接引用当前表单中的某个字段值作为参数。
  • 自定义 :手动输入固定值作为参数(如固定币种等)。
  • 组合 :将多个字段值或固定值组合成一个参数(如“字段A + 固定文本+字段B”)。
本文示例中,需要配置以下参数:
  • 转换前货币类型:货币类型-转换前;
  • 转换前金额:数值-转换前;
  • 转换后货币类型:货币类型-转换后。
触发事件时,系统将自动读取表单数据并发送至插件。
3.3.6 配置数据填充
数据填充用于将插件返回结果自动写入指定字段。
1)点击「新增」。
2)选择需要回填的目标字段。
3)设置插件返回结果与表单字段的对应关系。
  • 添加到已有字段 :表单中已有字段与返回结果一一对应。
  • 添加到新字段 :系统将根据插件返回结果自动在当前表单中创建对应字段。
3.3.7 保存并调试
操作步骤
1)点击「保存并调试」,进入调试页面。
2)在调试页面中输入测试数据(模拟表单字段值)。
3)点击「发送请求」,系统将调用插件进行调试。
4)查看请求信息(发送给插件的参数)及返回结果(插件返回的数据),验证配置是否正确。

4. 效果演示

以汇率转换场景为例:
1)当“数值-转换前”未满足触发条件时,系统不会执行前端事件,目标字段不会自动回填数据。
2)当满足触发条件后,系统自动调用汇率转换插件,并将转换结果回填至目标字段。

5. 管理前端事件

已创建的前端事件支持以下管理操作:
  • 编辑前端事件配置。
  • 调试前端事件。
  • 删除前端事件。
  • 启用或停用前端事件。

6. 注意事项

  • 使用前需先安装并启用对应插件,否则无法在前端事件中进行调用。
  • 触发字段仅在手动修改字段值时触发前端事件。
  • 未满足触发条件时,系统不会调用插件。
  • 保存并调试功能仅用于验证当前配置,正式使用前建议进行完整业务测试。