前端开发API说明

主要介绍前端API，代码示例及写法，同步API文档：http://www.o2oa.net/x_desktop/portal.html?id=dcd8e168-2da0-4496-83ee-137dc976c7f6

概述

• O2OA 是一个高度可定制化的企业级办公平台，您可以通过脚本语言扩展平台功能。

• O2OA 脚本基于Javascript语法，您可以通过脚本访问和操作允许的DOM对象；也可以通过平台定义的API操作业务数据、组织、视图等各种对象。脚本可以在后端（服务器端）和前端（浏览器端）执行。定义在流程中的脚本在后端执行；定义在表单等其他地方的脚本在前端执行。

• 后端脚本基于JDK8标准的Nashorn，遵循ECMAScript 5.1规范。前端脚本基于您使用的浏览器的Javascript引擎。

API总览

对象
业务数据(data)	流程实例(workContext)	内容管理实例(documentContext)
组织(org)	流程表单(form)	页面(page)
视图(view)	数据字典(Dict)	Action(Action)
引用(include)	方法定义(define)	session(session)

page业务数据 - Object: datapage流程实例 - Object: workContextpage内容管理实例 - Object: documentContextpage组织架构管理 - Object: org

服务
x_processplatform_assemble_surface	流程平台相关服务
x_portal_assemble_surface	门户平台相关服务
x_cms_assemble_control	内容管理平台相关服务
x_query_assemble_surface	数据平台相关服务
x_organization_assemble_express	组织架构相关服务
x_file_assemble_control	云文件相关服务
x_meeting_assemble_control	会议管理相关服务
x_bbs_assemble_control	论坛相关服务
x_calendar_assemble_control	日程管理相关服务
x_hotpic_assemble_control	热点信息相关服务
x_mind_assemble_control	脑图模块相关服务
x_organization_assemble_personal	个人设置相关服务
x_attendance_assemble_control.json	考勤模块相关服务

嵌入脚本

　　• O2OA 可在多个位置嵌入脚本代码，用于扩展平台和实现自定义功能。嵌入脚本代码分为前端执行代码和服务端执行代码，两者语法一致，在某些方法和对象的调用上略微有所区别，在后续文档中会一一说明。　　可嵌入脚本位置和说明如下表：

表单 页面
	名称： 表单和页面元素事件 说明： 流程平台和内容平台的表单和门户平台的页面中，每个设计元素包含多种事件，包括DOM对象原生事件和O2平台扩展事件。 执行： 前端执行，基于浏览器
	名称： 表单和页面可编辑元素默认值 说明： 流程平台和内容平台的表单和门户平台的页面中，可编辑元素或文本元素的默认值可以通过脚本指定。 执行： 前端执行，基于浏览器
	名称： 表单和页面元素的部分属性 说明： 流程平台和内容平台的表单和门户平台的页面中，有许多元素的相关属性可以通过脚本来定义。如：下拉框、单选多选按钮的可选值、人员字段的选择范围、区段依据等。 执行： 前端执行，基于浏览器
	名称： 表单可编辑元素校验 说明： 流程平台的表单中，可编辑的字段可以通过脚本进行有效性校验，校验通过返回true，不通过返回提示信息。 执行： 前端执行，基于浏览器
	名称： 表单可编辑元素区段依据 说明： 流程平台的表单中，可编辑的字段可使用区段数据，区段数据依据可通过表单指定 执行： 前端执行，基于浏览器
	名称： 脚本 说明： 流程平台、门户平台和内容管理平台中，都有脚本设计元素，可以在此创建自己的脚本库。 执行： 由调用脚本位置决定运行环境
流程
	名称： 流程活动事件 说明： 流程平台每个活动都有相关事件可以编写脚本，如：工作到达前后、待办执行前后等。 执行： 服务器端执行，基于ECMAScript 5.1规范
	名称： 流程事件 说明： 流程平台每个流程都有四个事件可以编写脚本：流程启动前后和流程结束前后。 执行： 服务器端执行，基于ECMAScript 5.1规范
	名称： 脚本活动 说明： 流程平台的脚本活动，用于自动执行脚本 执行： 服务器端执行，基于ECMAScript 5.1规范
	名称： 服务调用活动 说明： 流程平台的服务调用活动，可以配置WebService和Restful服务，可通过脚本定义参数、消息体和响应。 执行： 服务器端执行，基于ECMAScript 5.1规范
	名称： 选择并行节点路由条件 说明： 流程平台的选择活动和并行活动的路由可以编写一个返回true或false的脚本，来决定路由走向。 执行： 服务器端执行，基于ECMAScript 5.1规范
	名称： 流程和活动的相关人员 说明： 流程平台中，流程和活动的相关人员可以通过脚本指定，如：处理人、阅读人、管理者等 执行： 服务器端执行，基于ECMAScript 5.1规范
视图
	名称： 视图列显示 说明： 数据平台中，视图列的显示值可通过脚本指定，仅用于前端展现，不能作用于统计。 执行： 服务器端执行，基于ECMAScript 5.1规范
服务管理
	名称： 代理配置 说明： 服务管理中可设置定时运行任务，称之为代理。通过脚本实现功能。 执行： 服务器端执行，基于ECMAScript 5.1规范
	名称： 接口配置 说明： 服务管理中可设置Restful的web服务，称之为接口。通过脚本实现功能。 执行： 服务器端执行，基于ECMAScript 5.1规范

样例

• 这是一个简单的样例，用于展现脚本如何编写和运行。

• 本例中我们要实现一个表单中，两个下拉框从配置数据中获取可选数据，以及实现联动。

• 我们需要创建一个流程应用，一个表单以及一个数据字典。在表单中创建两个下拉列表框。

1、先在表单中创建两个下拉框　　

2、在category1和category2两个下拉框的属性中，选择通过“脚本”编辑可选值。category1category2　　

3、在category1和category2两个下拉框的可选值脚本如下：　　

category1的可选值脚本

var dict = new this.Dict("category"); //获取名为category的数据字典
var categoryList = dict.get(); //获取数据字典
var options = Object.keys(categoryList); //获取大类，赋值给options变量
options.unshift("(请选择大类)|"); //在options数组首位插入提示选项，并将“”作为value，“(请选择大类)”作为text
return options; //返回列表，作为列表框的可选值　　

category2的可选值脚本

var dict = new this.Dict("category"); //获取名为category的数据字典
var categoryList = dict.get(this.data.category1); //获取数据字典,以下拉框category1的值为关键字的数据值（数组）
return categoryList; //返回列表，作为列表框的可选值

　4、在category1的change事件中添加如下代码：

//获category2下拉框，并刷新可选项
this.form.get("category2").resetOption();　

　5、设计数据字典如下图，并命名为："分类配置"，别名为：“category”。　　

6、预览表单，即可看到大类下拉框中选项为数据字典中的第一层数据，选择不同的大类可与小类下拉框实现联动。