项目接口需求及设计说明文档(模板).doc

客户化开发需求规格说明书

媒讯集团EAS项目

CTC与EAS接口
需求及设计说明书

文档作者：
创建日期： 2013-05-10
确认日期：
当前版本： 1.0
拷贝数量： 1

审批签字:
客户方：

实施方：

文档控制
修改记录
日期
作者
版本
参考版本
备注

目录
1. 概述 4
1.1读者 4
1.2图例 4
1.3目的 4
二、业务现状 5
三、概要设计 5
3.1接口通讯方式 5
3.2通讯内容定义 5
3.3媒讯CTC系统提供接口使用范例 5
3.4金蝶EAS提供接口使用范例 5
3.5媒讯CTC系统提供接口服务地址 7
3.6金蝶EAS提供接口服务地址 7
3.7接口需求 7
四、详细设计 8
4.1XX EAS接口 8

1. 概述
金蝶与用户及用户业务系统方通过多次讨论，制定了接口开发需求设计说明书，作为双方后续开发指引。
1.1读者
本文读者对象为业务管理人员、系统设计、开发人员、测试人员。
1.2图例
本文中如未进行特殊说明，各图标代表的含义如下：
表示一个活动；
表示动态的业务数据，如系统单据；
表示流程走向；
表示条件判断、流程分支；
表示静态的业务数据，如基础资料；
表示系统外一个手工处理活动；
表示系统外手工填制的单据；
表示当前系统之外的活动；
表示当前系统之外产生的业务数据。

1.3目的
本文档是媒讯CTC系统与EAS系统接口的需求及设计方案相关文档，可用于指导开发、测试工作和作为验收相关依据文档。

二、业务现状
待补充
三、概要设计
3.1接口通讯方式
金蝶EAS与媒讯CTC系统之间通讯采用WebService方式进行数据传输。
3.2通讯内容定义
对于记录型的大对象，在通讯时，采用String型的xml格式的参数进行传递。对于其他非记录型的对象，在通讯时，可采用非xml格式的参数进行传递，也可使用多个参数。具体格式，请参照每个接口的通讯用例说明。
3.3媒讯CTC系统提供接口使用范例
待补充。
3.4金蝶EAS提供接口使用范例
3.4.1规范说明
EAS通过webService接口与异构系统通信。EAS WebService全部是使用java编写的，其接口描述符合WSDL国际标准，其数据描述符合XSD 国际标准。
本次提供的接口除系统登录接口外，其他接口都需要调用登录接口，以便将登陆的SessionId信息放入到 SOAP 的 HEADER 报文中。
3.4.2使用示例
金蝶在EAS上发布WebService服务，提供wsdl文件供客户端下载，其他业务系统根据下载的wsdl文件，产生客户端。
建议使用Axis2来生成客户端代理。

下面是登录接口调用参数说明：

接口地址
http://ip:port/ormrpc/services/EASLogin
方法名称
login
参数列表
参数名称
别名
类型
备注
userName
EAS用户名
String
EAS系统一个非异常的账户的用户名
Password
密码
String
用户名对应的密码
slnName

都为eas
dataCenterName
数据中心id
String
EAS对应的数据中心
Language
语言
String
默认为L2即可
dbType
数据库类型
int
0 sql server
1 oracle
2 db2
相关对象描述
不需要任何对象类型的数据
错误列表
错误代码
错误概述
详细说明

概要逻辑说明
无
调用者说明
无
其他说明
无

以下是Java客户端调用Java webservices接口的调用代码示例:
public class Demo {
public static void main(String[] args) throws Exception {
Demo demo = new Demo();
demo.login();
}
/**
* EAS登录
* login方法的参数分别代表为:
* java.lang.String userName 用户名,
* java.lang.String password 密码,
* java.lang.String slnName eas,
* java.lang.String dcName 数据中心代码,
* java.lang.String language 语言，简体中文为L2,
* int dbType 0 sql server 1 oracle 2 db2
* @throws Exception
*/
private void login() throws Exception
{
String EASLogin_address ="http://IP:6888/ormrpc/services/EASLogin";
URL url = new URL(EASLogin_address);
EASLoginProxy proxy=new EASLoginProxyServiceLocator().getEASLogin(url);
WSContext ctx = proxy.login("user", "pwd", "eas", "001", "L2", 1);
if(ws != null&& ws.getSessionId() !=null){
System.out.println("登录成功");
}
else
{
System.out.println("登录失败");
}
}
}
3.5媒讯CTC系统提供接口服务地址
待三地方补充。
3.6金蝶EAS提供接口服务地址
测试环境：http://192.168.1.209:6888/ormrpc/services
正式环境：http://192.168.1.7:6888/ormrpc/services
建议把IP地址和端口做成一个可配置参数。
3.7接口需求
3.7.1接口概况
本次集成业务所涉及的接口如下表所示:
序号
接口名称
数据发送方
数据接收方
接口提供者
接口调用者

3.7.2接口说明
接口处理过程说明：

其他逻辑控制说明：
3.7.3其他要求

四、详细设计
4.1XX EAS接口
4.1.1设计说明
此接口由EAS端(提供者)开发，供媒讯CTC系统 (调用者)调用。
4.1.2通讯内容
接口地址

方法名称

参数列表
参数名称
别名
类型
备注

返回值

对象描述

bill

错误列表
错误代码
错误概述

概要说明

调用者说明

其他说明

4.1.3通讯用例
--xmlData格式例子
<ComplaintBill>
<bill>
<number>201220383</number>
<recordTime>2012-08-29</<recordTime>
<recorder>2012-08-29</recorder>
<dept>一分</dept>
<telphone>020838010196</telphone>
……
</bill>
</ComplaintBill>
附录资料：
系部事物管理系统需求说明书

*****计算机有限公司
需求部
****年**月**日

引言
背景说明
Xxxxx
本说明书目的在于明确说明系统需求，界定系统实现功能的范围，指导系统设计以及编码。
本说明书的预期读者为：老师及在校学生，测试经理以及测试设计人员等。
参考资料
系统包括的范围：公告展示、请假功能、班级事物管理 ，学生信息反馈。
术语定义
2软件概述
2.1软件范围定义
该系统以现有班级事务管理系统为中心，开发综合素质测评、请假审批、班级事务管理、公告展示、学生信息反馈功能，为学生和教师提供事务便利。
2. 2系统参与者和功能

2.3日常业务
l 综合测评
l 班费流转
l 请假审批
l 意见箱
l 考勤记录统计
2.4查询和报表
l 个人综合测评成绩查询
l 班费流转查询
l 请假记录查询
3系统功能说明
3.1综合测评
用例名称
综合测评
用例编号

复杂度
中
优先级
高
描述
完成大学生综合素质评审成绩
参与者
学生、班主任
非功能需求

前置条件
学生素质奖励证明材料，考勤记录
后置条件

约束（业务规则）
期末考试总成绩*70%+学分总数*30%=综合测评成绩
场景
基本活动步骤
1. 录入期末总成绩
1.1将原有的成绩系统中的学生成绩保存为文档模式，例如*.xls
1.2本系统将识别文档，录入学生成绩
2. 计算学分
公式：学期每天出勤4分+上课全到15分+期末考试全过12分+各项活动加分（按照《大学生手册》规定）=学分总分
2.1调用系统中考勤记录，登记考勤得分
2.2向学生收取各自的活动、奖项等证明材料；
2.3班委根据各自的证明材料由班委在系统中进行登记记录
3.提交审核
3.1记录完毕有提交公告，由学生监督查看（例如，2天期限）
3.2检查期间，如有疑问可以向系统提出，这将匿名交由审批教师处理；
3.3检查期结束后，教师根据质疑问题作出鉴定、回复
3.4情况属实后，审批通过，并发布公告。
可选活动步骤
1. 活动加分项
1.1获取大学生在校参加活动状况
1.2依据学校大学生手册，严格给定评分
例外活动步骤

相关用例
考勤统计
相关图表

备注

用例名称
请假审批
用例编号

复杂度
中
优先级
高
描述

参与者
学生，班主任，辅导员
非功能需求

前置条件

后置条件

约束（业务规则）

场景
基本活动步骤
1. 填写电子请假条、
1.1请假人：不可输入，并获取当前登录用户
1.2请假事由：（病假、事假、其它）由请假人填写请假原因
1.3开始时间----结束时间
1.4申请时间（当前）
1.5审批人：根据请假时长自动获取权限内的教师名称
2. 等待审批
2.1根据请假事由进行审批
3. 销假
3.1请假人在请假时间结束前到审批人老师前报到
3.2审批教师操作系统进行销假
可选活动步骤

例外活动步骤

相关用例
请假审批
相关图表

备注
请假条提交后，在申请时间到假期结束时间段内，不允许第二次提出请假申请。如请假事由发生改变，在假条未通过前可自行修改，在假条已通过后可提出续假申请。

用例名称
班费收支统计
用例编号

复杂度
中
优先级
高
描述

参与者
学生、班委
非功能需求

前置条件
班费流转
后置条件

约束（业务规则）

场景
基本活动步骤
1. 初始化班级资金
2. 班费收入:向学生收取班费
3. 班费支出：
3.1.索取本次消费单据
3.2.根据单据向系统录入电子单据
3.3.系统自动进行财务统计
3.4.生成消费记录
4. 公示班费流转记录
可选活动步骤

例外活动步骤

相关用例

相关图表

备注

用例名称
意见箱
用例编号

复杂度
低
优先级
低
描述

参与者
全体
非功能需求

前置条件

后置条件

约束（业务规则）

场景
基本活动步骤
1. 选取意见对象
2. 编辑意见内容
3. 提交意见内容

可选活动步骤
1. 根据意见内容回复
例外活动步骤

相关用例

相关图表

备注

用例名称
发布事务公告
用例编号

复杂度
低
优先级
中
描述

参与者
班委、教师、
非功能需求

前置条件

后置条件

约束（业务规则）

场景
基本活动步骤
1. 编辑事务内容
2. 发布事务内容
3. 根据系统浏览状况，判断是否阅读公告
可选活动步骤

例外活动步骤

相关用例

相关图表

备注

用例名称
考勤记录
用例编号

复杂度
中
优先级
高
描述

参与者
学生、班委
非功能需求

前置条件

后置条件

约束（业务规则）

场景
基本活动步骤
1. 默认勾选全部到课
2. 老师依据实际情况进行更改到课状态
3. 提交系统
4. 系统计算考勤状态（例如：迟到、旷课、早退）
5. 老师设定考勤提醒
6. 例如：旷课10次自动提醒“该生旷课10次，请注意学生状态！”
可选活动步骤

例外活动步骤

相关用例

相关图表

备注

16