致远OA通用接口开发

一、概述

致远OA中，流程表单及无流程表单可以通过配置业务关系，关联本表单之外的数据，包括本系统数据以及第三方系统数据，也可以通过触发设置调用第三方接口，向第三方接口传递参数，由第三方接口执行业务动作。

通常这类需求可以使用致远封装的可视化工具dee配置完成，该工具使用简单，功能也很强大。除了dee，那就是使用本文介绍的通用接口达到自己的业务需求。与dee相比较，同样能关联第三方系统数据以及通过触发关系执行第三方接口，通用接口由于是自己编写实现代码，灵活性肯定比dee更高，但使用难度比dee大，胜在免费。

官方文档对于通用接口的使用描述相对模糊，对接口中的各个文件及代码没有明确的说明，本文将详细介绍通用接口从建立到编写代码，最后打包上传、配置业务关系到表单的通路。

二、致远官方说明

数据魔方 | 应用平台

1、应用应用设计师进入业务包-->管理设置-->接口管理

2、集团管理员/单位管理员进入CIP集成平台-->集成资源库-->CAP应用接口

3、新建通用接口，必填以及关键信息如下

1）填写接口名称

2）调用授权，默认是公开，标识所有的业务包都能调用;也可以选择自定义指定某些业务包能够调用

3）点击下一步新建方法，目前只支持关联/触发，注意事项如下

(1) 关联 返回值必填

(2) 触发 没有必填项

(3) 无论是关联和触发，代码名称必须符合java的命名规范，并且不能使用java内置关键字

(4) 关联和触发的传入参数关联条件不允许使用OA内置的函数名称，比如year,date等

4)设置好方法后点击下一步进入接口实现页面先点击下一步将接口定义信息保存入库 然后选中此接口并点击修改 再次进入接口实现。此时接口实现为空需要下载接口代码点击按钮下载接口代码，下载完成后解压后用idea或者eclipse打开

(1) MagicProviderRegisterImpl 此结果在导入接口实现时由程序调用不能删除

(2) 修改pom.xml中的版本号，默认是trunk-SNAPSHOT,需要修改为系统当前的版本

(3) 进入类C372f1c191aaa516db58df5803508499f中编写对应的接口实现。

(4) 代码编写完成后 执行maven 打包命令package

(5) 在接口实现页面点击导入实现将打包后的zip文件上传到OA服务器此次接口实现会显示出导入的实现

(6)确定后页面刷新 这时接口实现就是开发时提供的接口实现

自此 通路已经完成，可以通过表单的业务关系关联/触发选择到自己新建的接口(方法显示名称)后进行业务测试.如果实现类有问题可以修改后重新打包 将之前的实现类删掉 重新导入实现。

三、明确业务需求

1、明确业务场景

   在创建业务接口前，需要自己想清楚自己要干什么，也就是业务的需求是什么，对比着自己的需求，去寻找OA系统的相关功能达到自己的业务目的。

   下文就两个业务场景对通用接口的使用做介绍。一个是CAP4表单中通过关联关系取第三方系统数据，另一个是CAP4流程表单在发起、审核节点、流程结束时通过触发关系向第三方系统发送数据。

2、开发环境

       操作系统：win10

       IDE：IDEA_2023

       OA版本：V8.2SP1

       其他操作系统及开发IDE没有测试过，大同小异，稍微研究下基本都能通，如果不行，请使用介绍