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

客户化开发需求规格说明书媒讯集团EAS项目CTC与EAS接口需求及设计说明书文档作者：创建日期：2013-05-10确认日期：当前版本：1.0拷贝数量：1审批签字:客户方：实施方：文档控制修改记录日期作者版本参考版本备注目录1.概述41.1读者41.2图例41.3目的4二、业务现状5三、概要设计53.1接口通讯方式53.2通讯内容定义53.3媒讯CTC系统提供接口使用范例53.4金蝶EAS提供接口使用范例53.5媒讯CTC系统提供接口服务地址73.6金蝶EAS提供接口服务地址73.7接口需求7四、详细设计84.1XX EAS接口81. 概述金蝶与用户及用户业务系统方通过多次讨论，制定了接口开发需求设计说明书，作为双方后续开发指引。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参数列表参数名称别名类型备注userNameEAS用户名StringEAS系统一个非异常的账户的用户名Password密码String用户名对应的密码slnName都为easdataCenterName数据中心idStringEAS对应的数据中心Language语言String默认为L2即可dbType数据库类型int0 sql server1 oracle2 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(登录成功);elseSystem.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格式例子2012203832012-08-29/2012-08-29一分020838010196附录资料：系部事物管理系统需求说明书*计算机有限公司需求部*年*月*日引言背景说明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