A8平台接口和增值开发手册
? 2006 UF Seeyon Co., Ltd. All rights reserved.
This document contains information that is proprietary and confidential to UF Seeyon., which shall not be
disclosed outside the recipient's company or duplicated, used or disclosed in whole or in part by the recipient for any purpose other than to evaluate this file. Any other use or disclosure in whole or in part of this information without the express written permission of UF Seeyon. is prohibited.
Date: 2009-01-04 Author: Version:
王文友 V1.0
用友致远协同办公系统－开发手册
修改记录 .............................................................................................. 3 1. 概述 ............................................................................................... 4 1.1 编写目的 ................................................................................... 4 1.2 开发背景 ................................................................................... 4 1.3 应用价值 ................................................................................... 4 1.4 接口范围 ................................................................................... 5 2. 二次开发接口 .................................................................................... 6 2.1 接口一览 ................................................................................... 6 2.2 服务列表 ................................................................................... 6 3. Portal集成 ..................................................................................... 7
3.1 单点登录(SSO) ............................................................................ 7
3.1.1 外部平台集成A8 ........................................................................................... 7
3.1.1.1 实现说明 ............................................................................................ 7 3.1.1.2 接口说明 ............................................................................................ 7 3.1.1.3 代码示例 ............................................................................................ 8 3.1.1.4 部署说明 ............................................................................................ 9 3.1.2 A8集成第三方系统 ........................................................................................ 9
3.1.2.1 实现方式一：Ticket ............................................................................... 9 3.1.2.2 实现方式二：关联系统+扩展栏目 ............................................................... 11 3.2 Portlet ................................................................................... 13 3.2.1 概述 ......................................................................................................... 13 3.2.2 开发说明 ................................................................................................... 13
3.2.2.1 确定栏目数据 ...................................................................................... 13 3.2.2.2 确定栏目显示模板 ................................................................................ 13 3.2.2.3 开发说明 ........................................................................................... 14 3.2.2.4 注册到系统 ......................................................................................... 14 3.2.3 代码示例 ................................................................................................... 15 3.2.4 待办事项和跟踪事项 ...................................................................................... 21 3.2.5 新闻和公告 ................................................................................................. 21
4. 消息集成 ....................................................................................... 22 4.1 消息通道 ................................................................................. 22
4.1.1 概述 ......................................................................................................... 22 4.1.2 接口说明 ................................................................................................... 22
4.1.2.1 方法说明 ........................................................................................... 22 4.1.2.2 注册到系统 ......................................................................................... 22 4.1.2.3 原理说明 ........................................................................................... 23 4.1.3 代码示例 ................................................................................................... 23 4.2 短信接口 ................................................................................. 24 4.2.1 概述 ......................................................................................................... 24 4.2.2 接口说明 ................................................................................................... 24
4.2.2.1 注册到系统 ......................................................................................... 26 4.2.2.2 原理说明 ........................................................................................... 27 4.2.3 代码示例 ................................................................................................... 28
5. 组织模型同步 .................................................................................. 29 5.1 初始化同步............................................................................... 29
5.1.1 导出 ......................................................................................................... 29 5.1.2 导入 ......................................................................................................... 30
5.2 实时同步 ................................................................................. 30 5.2.1 实现A8组织模型事件监听接口 ......................................................................... 30 5.2.2 注册事件监听 .............................................................................................. 36
6. BPM集成...................................................................................... 36 6.1 准备 ....................................................................................... 37 6.2 外部系统发起A8表单流程 ............................................................ 38 6.3 轮询完成的表单流程 .................................................................... 38 6.4 导出A8表单流程到外部系统 ......................................................... 38 7. 附录 ............................................................................................. 38 7.1 术语表 .................................................................................... 38
用友致远协同办公系统－开发手册
修改记录
日期 2008-12-08 2008-12-15 2008-12-23 2008-12-29 2009-01-04 2009-06-16 2009-9-27 修改人 王文友 王文友 王文友 王文友 王文友 张勇 王文友 修改内容 创建文档，编写文档模板。 增加了安装服务文档。 增加了文档导出接口例程。 备注 合并刘娜组织模型文档，加入例程； 合并于荒津BPM文档。 合并张勇Portal和消息文档，拆分API文档。 增加单点登录不打开页面方式说明和待办事项接口说明 增加组织模型同步和BPM集成 用友致远协同办公系统－开发手册
1. 概述
1.1 编写目的
本手册主要面向二次开发人员，内容涵盖A8平台的二次开发、第三方应用集成。如果需要更详细的开发信息，请参考《平台API参考手册》。 1.2 开发背景
接口的目标是
1、 与第三方应用集成，达成松散耦合，紧密集成的目标； 2、 与异构应用集成；
3、 降低二次开发的技术难度；
4、 规范化二次开发，提升二次开发的稳定性；
5、 保证二次开发的延续性，降低二次开发应用升级难度。 1.3 应用价值
目前平台开放的接口支持： 1、 组织模型同步
使用组织模型导入接口，实现外部系统到A8的组织模型初始化同步；
调用组织模型管理远程接口，在外部系统组织模型发生变化时实时同步到A8。 实现组织模型事件接口，将A8组织模型变更实时同步到外部系统。
2、 表单流程集成
外部系统通过BPM集成远程接口发起A8的表单流程，在A8中审批流转后回到外部系统，实现表单流程的打通。
3、 文档导出
使用文档导出SDK，将A8的协同、公文、新闻、公告、调查和讨论导出到外部系统，满足数据交换和归档的需求。
4、 Portal集成
A8 Portal可以集成外部系统的页面，也可以将A8集成到第三方Portal中，并且实现单点登录。
5、 消息集成
外部通过消息通道，实时获取A8中的消息。可以将A8的消息以邮件、IM（如GKE、RTX）消息和短信形式发送。
外部系统通过消息接口向A8指定用户发送消息。
6、 待办事项集成
外部系统通过待办事项接口，可以得到A8待办事项的列表，并且可以处理待办事项。
用友致远协同办公系统－开发手册
1.4 接口范围
A8协同办公平台采用Java开发，支持Oracle、mysql和Sql Server数据库。 平台提供了以下接口： 1、 二次开发接口：
提供本地开发的Java SDK和Web Service远程接口，涵盖组织模型同步与导入导出、文档导出、表单与流程集成、新闻与公告发布支持。
2、 Portal接口：
提供页面集成和单点登录接口，实现外部应用在A8-Portal的集中展现。
3、 消息(短信)接口：
提供外部系统获得A8协同办公平台消息的机制。除标准化产品提供的短信集成支持外，A8还提供了短信二次开发接口，支持与特定的短信运营平台集成。