E9流程表单前端接口API(2021)_泛微E9组件资源-CSDN文库

需积分: 50 99 浏览量 2021-01-06 18:00:01 上传评论 1 收藏 1.55MB PDF 举报

资源详情

资源评论

资源推荐

所有接口统一封装在全局对象window.WfForm中
部分接口存在使用范围，最低kb版本以及是否移动端/PC端独有。没有特殊注明
情况下通用
表单字段相关操作，不推荐使用jQuery，禁止原生JS直接操作DOM结构！
大家开发过程中，推荐都使用API接口操作，由产品统一运维；同时使用API才能
完整的兼容移动终端
WfForm对象下接口，兼容新版移动端EM7
由于API接口在PC端与移动端已经统一，为减少开发工作量以及后期维护成本； 
故EM7表单在移动终端不再引入workflow_base表custompage4emoble列作为
自定义页面，直接引入custompage列(与PC模板一致)作为自定义页面
前端（JS方法）区分终端：
可通过方法WfForm.isMobile()判断是否移动端
1. var isMobile = WfForm.isMobile(); //true表⽰是eMobile、微信、钉钉
等移动终端，false代表PC端
后端请求（自定义页面等）区分终端:
1. boolean isMobile = 
"true".equals(request.getParameter("_ec_ismobile")); //true表⽰
是eMobile、微信、钉钉等移动终端，false代表PC端
方式1：模板上代码块，针对单个节点，在显示/打印/移动模板单独配置
方式2：【路径管理】-打开具体路径-【基础设置】-【自定义页面】，针对此路
径下所有节点所有模板生效
方式3：【路径管理】-【应用设置】-【流程表单自定义页面设置】，针对系统所
有非模板模式的场景(PC及移动)。注意此页面为全局custompage，应避免写
ready、checkCustomize等全局函数，只定义些函数体
特别注意：方式二、方式三禁止引入init_wev8.js。
如遇配置不生效，请先将代码块/custompage仅写alert确认是否生效，再逐步排
查错误原因。
新建请求：传参路径id，会自动计算活动版本的路径id
1. window.open("/workflow/request/CreateRequestForward.jsp?
workflowid=747");
查看请求：传参请求id，用户需本身具备此请求查看权限，主次账号需带入账号
信息
1. window.open("/workflow/request/ViewRequestForwardSPA.jsp?
requestid=5963690");
E9流程表单前端接口API
1.说明
1.1 简介
1.2 移动端兼容
1.3 前端代码开发方式
1.4 PC端打开表单的方式
E9流程表单前端接口API
1.说明
1.1 简介
1.2 移动端兼容
1.3 前端代码开发方式
1.4 PC端打开表单的方式
1.5 移动端打开表单的方式
2.注册自定义事件
2.1 注册拦截事件，指定动作执行前触
发，并可阻断/放行后续操作
2.2 注册钩子事件，指定动作完成后触
发
3.字段基础操作接口(适用表单所有字段类
型)
3.1 将字段名称转换成字段id
3.2 获取单个字段值
3.3 修改单个字段值
3.4 改变单个字段显示属性(只读/必填
等)
3.5 同时修改字段的值及显示属性
3.6 批量修改字段值或显示属性
3.7 触发指定字段涉及的所有联动
3.8 根据字段ID获取字段信息
3.9 获取字段当前的只读/必填属性
4.表单字段事件绑定、自定义渲染
4.1 表单字段值变化触发事件
4.2 明细字段值变化触发事件
4.3 字段区域绑定动作事件
4.4 自定义代理渲染单行文本框字段
4.5 自定义追加渲染表单字段
4.6 函数式自定义渲染表单字段
4.7 根据字段标识获取字段组件
5.明细表操作相关接口
5.1 添加明细行并设置初始值
5.2 删除明细表指定行/全部行
5.3 选中明细指定行/全部行
5.4 获取明细行所有行标示
5.5 获取明细选中行下标
5.6 控制明细行check框是否禁用勾选
5.7 控制明细数据行的显示及隐藏
5.8 获取明细已有行的数据库主键
5.9 获取明细总行数
5.10 添加行、删除行前执行逻辑或阻
断事件
5.11 添加行、删除行后触发事件
5.12 移动端跳转至明细编辑行页面执
行事件
5.13 添加明细时默认复制最后一行记
录
5.14 根据明细行标识获取序号(第几行)
6.常用全局接口(与字段无关)
6.1 获取当前打开请求的基础信息
6.2 可控制显示时间的message信息
6.3 系统样式的Confirm确认框
6.4 表单顶部按钮、右键菜单置灰
6.5 调用右键按钮事件
6.6 刷新表单页面
6.7 移动端打开链接方式
6.8 扩展提交操作发送给服务端的参数
6.9 获取校验必填逻辑第一个未必填的
字段
6.10 触发一次必填验证
7.不同字段类型特定接口(限定指定字段类型
可用)
7.1 扩展浏览按钮取数接口参数值
7.2 获取浏览按钮的显示值
7.3 移除选择框字段选项

移动端表单链接：
//新建链接，传参路径id
var createUrl = "/spa/workflow/forwardMobileForm.html?
iscreate=1&workflowid=747";
//查看链接，传参请求id
var viewUrl = "/spa/workflow/forwardMobileForm.html?
requestid=4503066";
第一种方式(推荐)：调用封装好的方法 
如果是通过移动端脚手架打包的模块，可以直接调用
如果是自行开发的界面，需要引入/spa/coms/openLink.js
最低支持版本：KB900190601
openLink.openWorkflow(url, callbackFun, returnUrl)
参数 参数类型 说明
url String 打开表单的链接
callbackFun Function 仅限EM客户端，返回时的回调函数
returnUrl String 非EM客户端，返回/提交后到指定链接
window.openLink.openWorkflow(createUrl, function(){
    alert("E-mobile打开表单链接，返回或提交后触发此回调函数");
});

//⾮EM终端打开，返回或提交后返回到流程中⼼界⾯
window.openLink.openWorkflow(createUrl, null, 
"/spa/workflow/static4mobile/index.html#/center/doing");
第二种方式：仅限于EM客户端，打开表单并可控制表单返回/提交后事件回调 
使用EM-SDK，弹webview方式实现
//分为两步，第⼀步调⽤SDK弹webview，第⼆步调⽤SDK控制回调刷新
window.em.openLink({
    url: viewUrl,
    openType: 2
});
window.em.ready(function(){
    window.em.registerBroadcast({
      name: "_closeWfFormCallBack",
      action: function (argument) {
        alert("E-mobile打开表单链接，返回或提交后触发此回调函数");
      }
    });
});
第三种方式： window.open或者window.location.href跳转。 
此方式url需要传参returnUrl并转码，用于指定返回/提交后跳转地址。 
建议如果是EM客户端采用方式一或方式二！
支持多次注册，按注册顺序依次执行；支持异步ajax，避免请求卡住
window.open(viewUrl+"&returnUrl="+window.encodeURIComponent("/tes
param1=test11&param2=test22"));
5 移动端打开表单的方式
注册自定义事件
1 注册拦截事件，指定动作执行前触发，并可阻断/放行
后续操作
E9流程表单前端接口API
说明
1 简介
2 移动端兼容
3 前端代码开发方式
4 PC端打开表单的方式
5 移动端打开表单的方式
注册自定义事件
1 注册拦截事件，指定动作执行前触
发，并可阻断/放行后续操作
2 注册钩子事件，指定动作完成后触
发
字段基础操作接口(适用表单所有字段类
型)
1 将字段名称转换成字段id
2 获取单个字段值
3 修改单个字段值
4 改变单个字段显示属性(只读/必填
等)
5 同时修改字段的值及显示属性
6 批量修改字段值或显示属性
7 触发指定字段涉及的所有联动
8 根据字段ID获取字段信息
9 获取字段当前的只读/必填属性
表单字段事件绑定、自定义渲染
1 表单字段值变化触发事件
2 明细字段值变化触发事件
3 字段区域绑定动作事件
4 自定义代理渲染单行文本框字段
5 自定义追加渲染表单字段
6 函数式自定义渲染表单字段
7 根据字段标识获取字段组件
明细表操作相关接口
1 添加明细行并设置初始值
2 删除明细表指定行/全部行
3 选中明细指定行/全部行
4 获取明细行所有行标示
5 获取明细选中行下标
6 控制明细行check框是否禁用勾选
7 控制明细数据行的显示及隐藏
8 获取明细已有行的数据库主键
9 获取明细总行数
10 添加行、删除行前执行逻辑或阻
断事件
11 添加行、删除行后触发事件
12 移动端跳转至明细编辑行页面执
行事件
13 添加明细时默认复制最后一行记
录
14 根据明细行标识获取序号(第几行)
常用全局接口(与字段无关)
1 获取当前打开请求的基础信息
2 可控制显示时间的message信息
3 系统样式的Confirm确认框
4 表单顶部按钮、右键菜单置灰
5 调用右键按钮事件
6 刷新表单页面
7 移动端打开链接方式
8 扩展提交操作发送给服务端的参数
9 获取校验必填逻辑第一个未必填的
字段
10 触发一次必填验证
不同字段类型特定接口(限定指定字段类型
可用)
1 扩展浏览按钮取数接口参数值
2 获取浏览按钮的显示值
3 移除选择框字段选项

场景1：表单提交、保存、退回、转发、强制收回等操作执行前，执行自定义逻
辑并阻断/放行后续操作
场景2：明细添加行、删除行前，执行自定义逻辑并阻断/允许后续操作
动作类型 说明 最低版本要求
WfForm.OPER_SAVE 保存
WfForm.OPER_SUBMIT
提交/批准/
提交需反馈/
不需反馈等
WfForm.OPER_SUBMITCONFIRM
提交至确认页面，
如果是确认界面，
点确认触发的是SUBM
IT
WfForm.OPER_REJECT 退回
WfForm.OPER_REMARK 批注提交
WfForm.OPER_INTERVENE 干预
WfForm.OPER_FORWARD 转发
WfForm.OPER_TAKEBACK 强制收回
WfForm.OPER_DELETE 删除
WfForm.OPER_ADDROW
添加明细行，
需拼明细表序号
WfForm.OPER_DELROW
删除明细行，
需拼明细表序号
WfForm.OPER_PRINTPREVIEW 打印预览 KB900190501
WfForm.OPER_EDITDETAILROW 移动端-编辑明细 KB900191101
WfForm.OPER_BEFOREVERIFY 校验必填前触发事件 KB900191201
接口名称及参数说明
registerCheckEvent:function(type,fun)
参数 参数类型 必须 说明
type String 是 动作类型(详见上表)，多个逗号分隔
fun Function 是
自定义函数，此函数入参为callback，
执行自定义逻辑完成或异步ajax的success函数体
内，放行需调用callback，
不调用代表阻断后续操作
样例
1. jQuery().ready(function(){
2.     WfForm.registerCheckEvent(WfForm.OPER_SAVE, 
function(callback){
3.         jQuery("#field27495").val("保存⾃动赋值");
4.         callback();    //继续提交需调⽤callback，不调⽤代表阻断
5.     });
6. 
7.   
WfForm.registerCheckEvent(WfForm.OPER_SAVE+","+WfForm.OPER_SUBMIT
{
8.         //... 执⾏⾃定义逻辑
9.         callback();
10.     });
11. 
12.     WfForm.registerCheckEvent(WfForm.OPER_ADDROW+"1", 
function(callback){
13.         alert("添加明细1前执⾏逻辑，明细1则是OPER_ADDROW+1，依次类
推")
14 llb k() //允许继续添加⾏调⽤ llb k 不调⽤代表阻
E9流程表单前端接口API
1.说明
1.1 简介
1.2 移动端兼容
1.3 前端代码开发方式
1.4 PC端打开表单的方式
1.5 移动端打开表单的方式
2.注册自定义事件
2.1 注册拦截事件，指定动作执行前触
发，并可阻断/放行后续操作
2.2 注册钩子事件，指定动作完成后触
发
3.字段基础操作接口(适用表单所有字段类
型)
3.1 将字段名称转换成字段id
3.2 获取单个字段值
3.3 修改单个字段值
3.4 改变单个字段显示属性(只读/必填
等)
3.5 同时修改字段的值及显示属性
3.6 批量修改字段值或显示属性
3.7 触发指定字段涉及的所有联动
3.8 根据字段ID获取字段信息
3.9 获取字段当前的只读/必填属性
4.表单字段事件绑定、自定义渲染
4.1 表单字段值变化触发事件
4.2 明细字段值变化触发事件
4.3 字段区域绑定动作事件
4.4 自定义代理渲染单行文本框字段
4.5 自定义追加渲染表单字段
4.6 函数式自定义渲染表单字段
4.7 根据字段标识获取字段组件
5.明细表操作相关接口
5.1 添加明细行并设置初始值
5.2 删除明细表指定行/全部行
5.3 选中明细指定行/全部行
5.4 获取明细行所有行标示
5.5 获取明细选中行下标
5.6 控制明细行check框是否禁用勾选
5.7 控制明细数据行的显示及隐藏
5.8 获取明细已有行的数据库主键
5.9 获取明细总行数
5.10 添加行、删除行前执行逻辑或阻
断事件
5.11 添加行、删除行后触发事件
5.12 移动端跳转至明细编辑行页面执
行事件
5.13 添加明细时默认复制最后一行记
录
5.14 根据明细行标识获取序号(第几行)
6.常用全局接口(与字段无关)
6.1 获取当前打开请求的基础信息
6.2 可控制显示时间的message信息
6.3 系统样式的Confirm确认框
6.4 表单顶部按钮、右键菜单置灰
6.5 调用右键按钮事件
6.6 刷新表单页面
6.7 移动端打开链接方式
6.8 扩展提交操作发送给服务端的参数
6.9 获取校验必填逻辑第一个未必填的
字段
6.10 触发一次必填验证
7.不同字段类型特定接口(限定指定字段类型
可用)
7.1 扩展浏览按钮取数接口参数值
7.2 获取浏览按钮的显示值
7.3 移除选择框字段选项

支持多次调用注册，按注册的先后顺序依次执行
接口名称及参数说明
registerAction: function(actionname, fn)
参数 参数类型 必须 说明
actionname String 是 动作类型，详见上表
fn Function 是 触发事件
样例
1. WfForm.registerAction(WfForm.ACTION_ADDROW+"1", 
function(index){
2.     alert("添加⾏下标是"+index);
3. });     //下标从1开始，明细1添加⾏触发事件，注册函数⼊参为新添加⾏
下标
4. 
14.         callback();    //允许继续添加⾏调⽤callback，不调⽤代表阻
断添加
15.     });
16. 
17.     WfForm.registerCheckEvent(WfForm.OPER_DELROW+"2", 
function(callback){
18.         alert("删除明细2前执⾏逻辑")
19.         callback();    //允许继续删除⾏调⽤callback，不调⽤代表阻
断删除
20.     });
21. 
22.     WfForm.registerCheckEvent(WfForm.OPER_PRINTPREVIEW, 
function(callback){
23.         alert("控制默认弹出的打印预览窗⼝")
24.         alert("当打印含签字意见列表，此接⼝需要放到跳转路由前执⾏，
组件库提供此机制");
25.         window.WfForm.printTimeout = 3000;  //产品是默认延时1s⾃
动弹出，可通过此⽅式控制延时时间
26.         callback();    //允许继续弹出调⽤callback，不调⽤代表不⾃
动弹预览
27.     });
28. 
29.     WfForm.registerCheckEvent(WfForm.OPER_EDITDETAILROW, 
function(callback,params){
30.         alert(JSON.stringify(params));    //参数含当前点击哪个明
细表哪⼀⾏
31.         callback();    //允许跳转明细编辑窗⼝，不调⽤阻断跳转
32.     });
33. });
类型 说明 最低版本要
WfForm.ACTION_ADDROW
添加明细行，
需拼明细表序号
KB900190
WfForm.ACTION_DELROW
删除明细行，
需拼明细表序号
KB900190
WfForm.ACTION_EDITDETAILROW
移动端-
编辑明细行，
需拼明细表序号
KB900190
WfForm.ACTION_SWITCHDETAILPAGING 切换明细分页 KB900191
WfForm.ACTION_SWITCHTABLAYOUT 切换模板布局标签页 KB900191
2.2 注册钩子事件，指定动作完成后触发
E9流程表单前端接口API
1.说明
1.1 简介
1.2 移动端兼容
1.3 前端代码开发方式
1.4 PC端打开表单的方式
1.5 移动端打开表单的方式
2.注册自定义事件
2.1 注册拦截事件，指定动作执行前触
发，并可阻断/放行后续操作
2.2 注册钩子事件，指定动作完成后触
发
3.字段基础操作接口(适用表单所有字段类
型)
3.1 将字段名称转换成字段id
3.2 获取单个字段值
3.3 修改单个字段值
3.4 改变单个字段显示属性(只读/必填
等)
3.5 同时修改字段的值及显示属性
3.6 批量修改字段值或显示属性
3.7 触发指定字段涉及的所有联动
3.8 根据字段ID获取字段信息
3.9 获取字段当前的只读/必填属性
4.表单字段事件绑定、自定义渲染
4.1 表单字段值变化触发事件
4.2 明细字段值变化触发事件
4.3 字段区域绑定动作事件
4.4 自定义代理渲染单行文本框字段
4.5 自定义追加渲染表单字段
4.6 函数式自定义渲染表单字段
4.7 根据字段标识获取字段组件
5.明细表操作相关接口
5.1 添加明细行并设置初始值
5.2 删除明细表指定行/全部行
5.3 选中明细指定行/全部行
5.4 获取明细行所有行标示
5.5 获取明细选中行下标
5.6 控制明细行check框是否禁用勾选
5.7 控制明细数据行的显示及隐藏
5.8 获取明细已有行的数据库主键
5.9 获取明细总行数
5.10 添加行、删除行前执行逻辑或阻
断事件
5.11 添加行、删除行后触发事件
5.12 移动端跳转至明细编辑行页面执
行事件
5.13 添加明细时默认复制最后一行记
录
5.14 根据明细行标识获取序号(第几行)
6.常用全局接口(与字段无关)
6.1 获取当前打开请求的基础信息
6.2 可控制显示时间的message信息
6.3 系统样式的Confirm确认框
6.4 表单顶部按钮、右键菜单置灰
6.5 调用右键按钮事件
6.6 刷新表单页面
6.7 移动端打开链接方式
6.8 扩展提交操作发送给服务端的参数
6.9 获取校验必填逻辑第一个未必填的
字段
6.10 触发一次必填验证
7.不同字段类型特定接口(限定指定字段类型
可用)
7.1 扩展浏览按钮取数接口参数值
7.2 获取浏览按钮的显示值
7.3 移除选择框字段选项

5. WfForm.registerAction(WfForm.ACTION_DELROW+"2", function(arg){
6.     alert("删除⾏下标集合是"+arg.join(","));
7. });     //下标从1开始，明细2删除⾏触发事件
8. 
9. WfForm.registerAction(WfForm.ACTION_SWITCHDETAILPAGING, 
function(groupid){
10.     alert("切换明细表"+(groupid+1)+"的页码触发事件");
11. });
12. 
13. WfForm.registerAction(WfForm.ACTION_SWITCHTABLAYOUT, 
function(tabid){
14.     alert("切换到标签项"+tabid+"触发事件");
15. });
灵活运用此方法，可实现多表单、多环境，代码块通用；解耦代码块中指定
fieldid
convertFieldNameToId: function(fieldname,symbol,prefix)
参数说明
参数 参数类型 必须 说明
fieldname String 是 字段名称
symbol String 否
表单标示，主表(main)/具体明细表
(detail_1),默认为main
prefix Boolean 否
返回值是否需要  field 字符串前缀，
默认为true
样例
1. var fieldid = WfForm.convertFieldNameToId("zs");
2. var fieldid = WfForm.convertFieldNameToId("zs_mx", 
"detail_1");
3. var fieldid = WfForm.convertFieldNameToId("zs_mx", "detail_1", 
false);
getFieldValue: function(fieldMark)
参数说明
参数 参数类型 必须 说明
fieldMark String 是
字段标示，
格式  field${字段ID}_${明细⾏号} 
样例
1. var fieldvalue = WfForm.getFieldValue("field110");
此方法修改的字段如果涉及到触发联动、单元格格式化等，修改完值会自动触发
联动/格式化
改值的格式在添加明细行初始化、批量修改字段等场景类同
changeFieldValue: function(fieldMark, valueInfo)
参数说明
3.字段基础操作接口(适用表单所有字段类型)
3.1 将字段名称转换成字段id
3.2 获取单个字段值
3.3 修改单个字段值
E9流程表单前端接口API
1.说明
1.1 简介
1.2 移动端兼容
1.3 前端代码开发方式
1.4 PC端打开表单的方式
1.5 移动端打开表单的方式
2.注册自定义事件
2.1 注册拦截事件，指定动作执行前触
发，并可阻断/放行后续操作
2.2 注册钩子事件，指定动作完成后触
发
3.字段基础操作接口(适用表单所有字段类
型)
3.1 将字段名称转换成字段id
3.2 获取单个字段值
3.3 修改单个字段值
3.4 改变单个字段显示属性(只读/必填
等)
3.5 同时修改字段的值及显示属性
3.6 批量修改字段值或显示属性
3.7 触发指定字段涉及的所有联动
3.8 根据字段ID获取字段信息
3.9 获取字段当前的只读/必填属性
4.表单字段事件绑定、自定义渲染
4.1 表单字段值变化触发事件
4.2 明细字段值变化触发事件
4.3 字段区域绑定动作事件
4.4 自定义代理渲染单行文本框字段
4.5 自定义追加渲染表单字段
4.6 函数式自定义渲染表单字段
4.7 根据字段标识获取字段组件
5.明细表操作相关接口
5.1 添加明细行并设置初始值
5.2 删除明细表指定行/全部行
5.3 选中明细指定行/全部行
5.4 获取明细行所有行标示
5.5 获取明细选中行下标
5.6 控制明细行check框是否禁用勾选
5.7 控制明细数据行的显示及隐藏
5.8 获取明细已有行的数据库主键
5.9 获取明细总行数
5.10 添加行、删除行前执行逻辑或阻
断事件
5.11 添加行、删除行后触发事件
5.12 移动端跳转至明细编辑行页面执
行事件
5.13 添加明细时默认复制最后一行记
录
5.14 根据明细行标识获取序号(第几行)
6.常用全局接口(与字段无关)
6.1 获取当前打开请求的基础信息
6.2 可控制显示时间的message信息
6.3 系统样式的Confirm确认框
6.4 表单顶部按钮、右键菜单置灰
6.5 调用右键按钮事件
6.6 刷新表单页面
6.7 移动端打开链接方式
6.8 扩展提交操作发送给服务端的参数
6.9 获取校验必填逻辑第一个未必填的
字段
6.10 触发一次必填验证
7.不同字段类型特定接口(限定指定字段类型
可用)
7.1 扩展浏览按钮取数接口参数值
7.2 获取浏览按钮的显示值
7.3 移除选择框字段选项