Ecology系统接口指南

Ecology系统集成接口指南（V0.1）SUBMITED BY WEA VER

目录

1、集成登陆 (3)

1.1使用说明 (3)

2．数据源 (10)

3. 计划任务接口 (11)

4. 流程接口 (14)

4.1．节点附加操作接口 (14)

4.2. 自定义浏览框接口 (16)

5. 短信接口 (18)

1、集成登陆

企业在信息化的过程中不可避免的会购置各种各样的业务系统，为了登陆不同的系统，用户需要频繁的打开不同的窗口、输入各自的帐号密码，费时费力。但是通过ecology系统的自定义菜单功能和集成登陆接口，可以比较方便的实现登陆ecology系统后直接到达其他业务系统的功能，省去了繁琐的登陆过程。

1.1使用说明

1.系统管理员维护待集成系统的登陆页面地址，如图所示：

（图一，集成登陆菜单入口）

（图二，点“集成登陆”菜单后的显示页面，我们可以通过“新建”来维护需要集成的系统。本文以集成网易163邮箱为例。注意：标识很重要，不能重复，在后面的步骤中会用到标识值）

（图三，新建页面。内网地址为局域网访问，外网地址为internet访问。账号参数名和密码参数名通过查看该系统登录页面的html源码获得，如果登陆页面还有其他输入项的话则添加其他参数）

（图四，给待集成的系统添加左侧菜单）

（图五）

（图六，链接地址必须设为/interface/Entrance.jsp?id=待集成系统的标识值）

（图七，这个菜单用来给系统用户维护集成系统的帐号信息。链接地址必须是

/interface/AccountSetting.jsp)

2.到目前为止，系统设置已经完成，系统用户可以使用被集成的系统了。在使用被集成的

系统之前需要先设置一下自己在被集成系统中的账号信息（通过前文所述的“账号设置”

左侧菜单进行设置，设置一次就可以了，只有在被集成系统的帐号改变了的情况下才需要再次设置。）

（图一）

（图二）

（图三，设置好账号信息后点“网易163邮箱”左侧菜单，直接登录进入163邮箱系统）

3.接口开发

如果上面的设置不能达到直接进入被集成系统的目的，可以通过修改接口文件来自己写集成登陆的代码。

1.找到ecology安装目录/interface/Entrance.jsp文件并打开（最好先备份一下）

2.注意文件中的这段代码：

if(sysid.equals("1")){//如果系统标识值等于1

//163邮件系统集成

out.print(str);

}else if(sysid.equals("2")){//如果系统标识值等于2

//第二套待集成系统

out.print(str);

}

。。。。

else{

out.print(str);

}

str字符串变量是被集成系统的登录页面html表单提交代码，客户开发人员可以自己修改str的值来实现自己的登陆代码。大多数情况下可以不用自己开发，但是对基

于.net技术的网站系统可能需要自己实现登陆部分的代码。

4. 注意事项。

被集成的系统必须是B/S架构的系统，登录页面必须是传统的登录页面（没有验证码、动态密码等）

2．数据源

ecology提供了许多系统扩展接口，开发人员可以通过这些接口操作不同的数据源。例如把ecology的数据同步到其他的系统中去，或把其他系统中的数据同步到ecology中来，本质上就是在两个数据源之间交换数据。定义数据源的方法很简单，只需要在ecology安装目录/WEB-INF/service/datasource.xml中声明一下就可以了。

上面的声明定义了一个oracle数据源，我们可以在datasource.xml文件中定义多个数据源，只需按照上面的格式添加一段新的声明就可以了，仅仅需要改动红色标出来的部分。例如添加一个sql server 数据源：msds

说明：

type: 数据库类型。有效值为oracle、sqlserver、db2、mysql、odbc

host: 数据库主机名或ip

dbname: 数据库名

user：数据库账号

password: 数据库密码

minconn: 连接池最小连接数

maxconn: 连接池最大连接数

3. 计划任务接口

客户开发人员可以利用计划任务接口定时执行一段自己定义的操作，比如在两个数据源之间交换数据。

Ecology提供两种计划任务接口

1.IntervalJob接口，此接口每隔一段时间执行一次（自己定义间隔时间）

2.CronJob接口，此接口在指定的时间点执行（自己定义时间点）

定义计划任务的方法是在ecology安装目录/WEB-INF/service/schedule.xml中声明：

上面的声明定义了一个名为job1的IntervalJob，该接口中的方法execute()将会每60秒执行一次。同时把前面定义的local数据源注入到了接口中，这样的话就可以在execute（）中读写local数据源。我们也可以注入两个数据源到接口中，这样就可以在两个数据源之间交换数据：

声明一个CronJob的方法和IntervalJob类似，在ecology安装目录/WEB-INF/service/schedule.xml中声明：

上面的声明定义了一个周一到周五12：44执行的计划任务。什么时候执行计划任务由cronExpr表达式决定。一个cron表达式有至少6个有空格分隔的时间元素，

按顺序依次为：

秒（0~59）

分钟（0~59）

小时（0~23）

天（月）（0~31，但是你需要考虑你月的天数）

月（0~11）

天（星期）（1~7 1=SUN 或SUN，MON，TUE，WED，THU，FRI，SAT）

0 0 10,14,16 * * ? 每天上午10点，下午2点，4点

0 0/30 9-17 * * ? 朝九晚五工作时间内每半小时

0 0 12 ? * WED 表示每个星期三中午12点

"0 0 12 * * ?" 每天中午12点触发

"0 15 10 ? * *" 每天上午10:15触发

"0 15 10 * * ?" 每天上午10:15触发

"0 * 14 * * ?" 在每天下午2点到下午2:59期间的每1分钟触发

"0 0/5 14 * * ?" 在每天下午2点到下午2:55期间的每5分钟触发

"0 0/5 14,18 * * " 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发

"0 0-5 14 * * ?" 在每天下午2点到下午2:05期间的每1分钟触发

"0 10,44 14 ? 3 WED" 每年三月的星期三的下午2:10和2:44触发

"0 15 10 ? * MON-FRI" 周一至周五的上午10:15触发

"0 15 10 15 * ?" 每月15日上午10:15触发

"0 15 10 L * ?" 每月最后一日的上午10:15触发

"0 15 10 ? * 6L" 每月的最后一个星期五上午10:15触发

"0 15 10 ? * 6#3" 每月的第三个星期五上午10:15触发

有些子表达式能包含一些范围或列表

例如：子表达式（天（星期））可以为“MON-FRI”，“MON，WED，FRI”，“MON-WED,SAT”“*”字符代表所有可能的值

因此，“*”在子表达式（月）里表示每个月的含义，“*”在子表达式（天（星期））表示星期的每一天

“/”字符用来指定数值的增量

例如：在子表达式（分钟）里的“0/15”表示从第0分钟开始，每15分钟

在子表达式（分钟）里的“3/20”表示从第3分钟开始，每20分钟（它和“3，23，43”）的含义一样

“？”字符仅被用于天（月）和天（星期）两个子表达式，表示不指定值

当2个子表达式其中之一被指定了值以后，为了避免冲突，需要将另一个子表达式的值设为“？”

注意，上文中的weaver.interfaces.schedule.BaseIntervalJob和weaver.interfaces.schedule.BaseIntervalJob是ecology提供的默认接口实现，它们的execute()是空的，不做任何操作。客户开发人员如果要使用计划任务接口的话，必需继承weaver.interfaces.schedule.BaseIntervalJob或weaver.interfaces.schedule.BaseIntervalJob，用自己的业务逻辑覆盖它们的execute().

举个简单的例子，我需要ecology系统每隔一小时统计一下系统人数并输出到控制台，步骤如下

1．编写自己的计划任务实现

import weaver.interfaces.schedule.BaseIntervalJob;

import java.sql.Connection;

import java.sql.PreparedStatement;

import java.sql.ResultSet;

/**

* IntervalJob示范代码,集成BaseIntervalJob,用自己的业务逻辑覆盖了execute()方法

*/

public class MyIntervalJob extends BaseIntervalJob {

public void execute() {

//从数据源中获取连接

Connection conn = getDs().getConnection();

try {

//通过jdbc获取人数

PreparedStatement s = conn.prepareStatement("select count(*) as amount from hrmresource");

ResultSet rs = s.executeQuery();

rs.next();

String amount = rs.getString("amount");

//输出到控制台

System.out.println("人数:" + amount);

//关闭记录集

rs.close();

//关闭statement

s.close();

} catch (Exception e) {

getLog().error(e);

} finally {

try {

//关闭连接

conn.close();

} catch (Exception e) {

getLog().error(e);

}

}

}

}

3.在schedule.xml中声明

可以用类似的方法实现自己的cronJob,本文不再赘述。

4.流程接口

4.1．节点附加操作接口

ecology提供了节点附加操作接口。使用这个接口可以让流程在到达某个节点或离开某个节点的时候执行客户自己开发的代码。

要实现这样的功能客户开发人员必须实现ecology提供的接口weaver.interfaces.workflow.action.Action, 该接口包含方法execute(RequestInfo request)，这个方法会在节点到达前或节点到达后被ecology调用。ecology提供了该接口的参考实现weaver.interfaces.workflow.action.BaseAction，客户开发人员可以直接继承BaseAction，用自己的业务逻辑覆盖BaseAction的execute方法。

例如：

import weaver.interfaces.workflow.action.BaseAction;

import weaver.soa.workflow.request.RequestInfo;

public class MyAction extends BaseAction {

public boolean execute(RequestInfo request) {

System.out.println(request.getRequestid());

getLog().debug("my action executed!");

return true;

}

}

上面的代码表示在节点到达前或到达后把流程id打印到控制台。Request参数包含了流程数据，

代码写好之后需要部署到ecology系统中，只需在ecology安装目录

/WEB-INF/service/action.xml中加入下面的声明：

最后在ecology流程管理中配置一下节点附加操作就可以了。

（图一，点节点前附加操作或节点后附加操作）

（图二，勾选上面部署的myAction即可生效）

自定义浏览框接口

是否可以把其它系统的数据定义到ecology表单字段中？例如把财务系统中的会计科目定义为ecology的表单字段供ecology用户选择。如果要实现这样的功能可以通过ecology提供的自定义浏览框接口。

浏览框接口提供给客户开发人员获取其它数据源数据并绑定到ecology表单字段的功能。使用方法很简单，首先，在ecology安装目录/WEB-INF/service/browser.xml中声明：

简单解释一下，msds是财务系统数据源，用前文所述的方法定义。search属性值用来从财务数据源中查询会计科目列表，searchById属性值用来从财务数据源中查询指定的会计科目，searchByName属性值用来从财务数据源中按科目名搜索会计科目nameHeader和descriptionHeader属性用来定义在浏览框页面中显示的表头。

声明之后就可以在ecology表单字段管理中进行配置了：

（图一，新建字段）

（图二，选定上面声明好的baseBrowser即可）

做好上面的部署之后这个字段就可以像ecology系统中的人员浏览框、部门浏览框一样供用户选择来自其他系统地数据了。

提示：虽然通过浏览框接口可以直接从任何使用oracle

、sqlserver、db2、mysql数据库的应用系统中选择数据，从性能上考虑我们可以先使用计划任务接口把其他系统中的数据定时同步到ecology系统中来，然后通过浏览框接口在ecology 数据源中的选择。

5.短信接口

ecology目前使用短信猫作为内置的短信发送设备，但往往客户本身已经采购了其他的短信服务商的产品，比如中国电信的企信通等等，如果要改用其他供应商的短信发送装置的话可以通过ecology短信接口实现。ecology短信接口包含了sendSMS(msg)方法，客户开发人员只要用自己的业务逻辑实现这个方法，ecology系统在需要发送短信的时候就会调用客户自己开发的发送方式。

另外，ecology提供了基于中间表的接口实现，客户可以直接使用。这个接口实现的原理是把要发送的短信数据按照和短信设备供应商约定的格式写道中间表中，由短信设备供应商定时去获取数据并发送（大多数短信设备供应商已经提供了通过中间表方式发送短信的功能。）在理解了上面的原理之后，接下来讲解一下配置使用接口的方法。

1. 找到ecoloyg安装目录/WEB-INF/service/sms.xml,打开这个文件，里面的内

容如下：

需要关注的是红色部分的内容。这里逐一说明.

: 中间表所在的数据源

: 指定往中间表插入数据使用的sql语句。例子中的这条sql是根据一个客户的需求写的，客户提供的中间表结构是：

表名：OutBox

字段：ReceiverMobileNo, ----------------接受人

Msg, ----------------短信内容

SendTime, -----------------发送时间

IsChinese, -----------------是否中文

ExpressLevel, -----------------紧急程度

Sender ----------------发送人

实际上ecology短信接口只需要用到接受人和短信内容两个字段，这两个字段的值不是固定的，由短信接口负责把数据传过来，因此用?号表示他们的值。其他字段的值不用关心，可以随便写死一些数据，这个例子里全部写的是1,发送时间是用sql server自带的函数getDate()获取的。

不妨这样理解，最简单的中间表可以是这样子的：

表名：someTable

字段：MobileNo,

messageBody

2. 修改ecology/WEB-INF/prop/weaver_rtx.properties中的内容为：IsInitRTXOrg=true

IsDownLineNotify=true

#CurSmsServer=rtx

CurSmsServerIsValid=true

RTXServerPort=8036

RTXServerIP=

RTXServerOutIP=

也就是说只要把CurSmsServer=rtx用#号注释掉就可以了。

下面是两个建中间表的sql脚本供参考：

1. for sqlserver

CREATE TABLE outbox (

ID int IDENTITY (1, 1) ,

ExpressLevel int ,

Sender varchar (50) ,

ReceiverMobileNo varchar (50),

Msg varchar (500) ,

SendTime datetime,

IsChinese bit

)

3. for oracle

create table OUTBOX

(

ID NUMBER not null,

EXPRESSLEVEL NUMBER,

SENDER VARCHAR2(50),

RECEIVERMOBILENO VARCHAR2(50) not null,

MSG VARCHAR2(500),

SENDTIME DATE not null,

ISCHINESE NUMBER not null

);

create sequence OUTBOX_ID_SEQ

minvalue 1

maxvalue 999999999

start with 141

increment by 1

cache 20;

CREATE OR REPLACE TRIGGER "SET_OUTBOX_ID" BEFORE INSERT ON "OUTBOX"

FOR EACH ROW

DECLARE

NEXT_OUTBOX_ID NUMBER;

BEGIN

SELECT OUTBOX_ID_SEQ.NEXTVAL INTO NEXT_OUTBOX_ID FROM DUAL;

:NEW.ID := NEXT_OUTBOX_ID;

END;

oracle下对应的sms.xml文件内容为：