OA详细设计项目说明指导书.doc

OA系统 1.0具体设计说明书文件控制受控 不受控文档编号OA-0502版本号1.0分册名称OA系统-具体设计说明书第1册/共1册总页数60正文58附录无编制江华审批谭璨生效日期-03-23修订历史统计A - 增加 M - 修订 D - 删除版本号日期变更类型修改人摘 要备注1.0-03-23M江华建立文档目 录第一章 引言41.1 编写目标41.2 背景41.3 术语解释4第二章 系统命名规则4一 协同办公子系统41.1 个人邮箱41.2通知81.3公告91.4公文管理111.5 公文归档WSDL181.6 个人事务助理18第三章 系统模块结构20一 协同办公子系统20第四章 协同办公子系统具体设计23一 个人邮箱模块设计231.1 程序描述231.2 功效设计251.3 界面设计261.4 输人设计271.5 步骤逻辑281.6 存放设计291.7 限制条件29二通知模块设计292.1 程序描述292.2 功效设计302.3 界面设计312.4 输人设计322.5 步骤逻辑332.6 存放设计342.7 限制条件34三公告模块设计343.1 程序描述343.2 功效设计353.3 界面设计353.4 输入设计363.5 步骤逻辑373.6 存放设计383.7 限制条件38四发文管理模块设计384.1 程序描述384.2 用例图404.3 界面设计414.4 步骤逻辑424.5 存放设计434.6 限制条件43五收文管理模块设计435.1 程序描述435.2 用例图455.3 界面设计455.4 步骤逻辑475.5 存放设计485.6 限制条件48六、日程安排模块设计486.1 程序描述486.2 用例图506.3 界面设计516.4 步骤逻辑526.5 存放设计52七、工作日志模块设计527.1 程序描述527.2 用例图537.3 界面设计537.4 步骤逻辑547.5 存放设计55八、经办公文查询模块设计558.1 程序描述558.2 界面设计56九、收发文查询模块设计589.1 程序描述589.2 界面设计58十、公文归档模块设计5910.1 程序描述5910.2 界面设计59第一章 引言1.1 编写目标1、编写本说明书目标：本文档目标在于让开发人员、系统维护人员全方面了解本系统功效设计。2、预期读者：协同办公子系统开发人员、系统维护人员。1.2 背景a协同办公子系统； b.本项目标任务由综合管理部提出，由开发部进行开发。 1.3 术语解释 【列出本文件中用到专门术语定义和外文首字母缩写原词组。】缩写、术语解 释OA办公自动化PC个人小型计算机第二章 系统命名规则一 协同办公子系统1.1 个人邮箱个人邮箱收邮件收件箱已删除写邮件发件箱初稿箱已删除1.1.1模块命名规则a) 个人邮件：模块路径是/WEB-INF/views/jsp/mail；编辑模块以邮件英文单词mailmain命名，JS脚本是mailmainjs，查询模块命名是mailquery。b) 通讯录：模块路径是/WEB-INF/views/jsp/addressbook；编辑模块以通讯录英文单词addressbook命名，JS脚本是addressbookjs，查询模块命名是addressbookquery。c) 外部邮箱：模块路径是/WEB-INF/views/jsp/outmail；编辑模块以外部邮箱英文单词outmailmain命名，JS脚本是outmailmainjs，查询模块命名是outmailmainquery。1.1.2 类命名规则a)控制类路径：com.csscis.water.lcx.mail.ctrl.MailController;b)接口路径：com.csscis.water.lcx. mail.service.MailService;c)实现类路径：com.csscis.water.lcx. mail.service.impl.MailServiceImpl;d)实体路径：com.csscis.water.lcx. mail.pojo.Mail;1.1.3 数据库命名规则联络人组：EML_LINKMAN_GROUP通讯录：EML_ADDRESS_BOOK邮件状态：EML_STATE邮件状态：未读、已读、已回复、已转发邮件标签：EML_LABEL邮件优先级：EML_DISTINCTIONdistinction:紧急、一般、缓慢邮件附件：EML_ATTACHMENT邮件信息表：EML_MAIL外部邮箱：EML_OUTER外部邮箱登录,保留用户密码和服务器1.2通知通知通知维护通知信息增加、修改、删除、查询。通知查收通知抵达提醒1.2.1模块命名规则a)通知管理：模块路径是/WEB-INF/views/jsp/desktop；编辑模块以通知英文单词advice命名，JS脚本是advicejs。b)我通知：模块路径是/WEB-INF/views/jsp/desktop；模块名为adviceforuser，JS脚本是adviceforuserjs。1.2.2 类命名规则a)控制类路径：com.csscis.water.lcx. desktop.ctrl. AdviceCotroller;b)接口路径：com.csscis.water.lcx. desktop.service. AdviceService;c)实现类路径：com.csscis.water.lcx. desktop.service.impl. AdviceServiceImpl;d)实体路径：com.csscis.water.lcx. desktop.pojo. Bulletin;com.csscis.water.lcx. desktop.pojo. AdviceUsercom.csscis.water.lcx. desktop.pojo. BulletinAttachment;1.2.3 数据库命名规则通知：BULLETIN通知范围：BULLETIN_ASSIGNMENT大多数情况下通知全部会指定下发范围,如不一样部门只能看到下发给本部门通知通知附件：1.3公告通知通知维护通知信息增加、修改、删除、查询。通知查收通知抵达提醒1.3.1模块命名规则a)公告管理：模块路径是/WEB-INF/views/jsp/desktop；编辑模块以公告英文单词bulletin命名，JS脚本是bulletinjs。b)公告栏：模块路径是/WEB-INF/views/jsp/desktop；编辑模块命名为bulletinforuser，JS脚本是bulletinforuserjs。1.3.2 类命名规则a)控制类路径：com.csscis.water.lcx. desktop.ctrl. BulletinCotroller;b)接口路径：com.csscis.water.lcx. desktop.service. BulletinService;c)实现类路径：com.csscis.water.lcx. desktop.service.impl.BulletinServiceImpl;d)实体路径：com.csscis.water.lcx. desktop.pojo.Bulletin;com.csscis.water.lcx. desktop.pojo. BulletinAttachment;1.3.3 数据库命名规则公告：BULLETIN公告附件：1.4公文管理公文管理发文发文拟稿发文查询收文收文登记收文查询委办任务公文分发发文分发收文分发收发文查询公文归档发文归档收文归档公文基础属性维护公文类型维护公文类别维护来文单位维护公文专题词维护经办公文查询步骤监控1.4.1模块命名规则（1）发文管理：模块路径是/WEB-INF/views/jsp/oa/send，编辑模块命名为oasend，JS脚本是oasendjs；查询模块命名为oasendquery，JS脚本oasendqueryjs。（2）收文管理：模块路径是/WEB-INF/views/jsp/oa/receive，编辑模块命名为oareceive，JS脚本是oareceivejs；查询模块命名为oareceivequery，JS脚本oareceivequeryjs。（3）收发文查询：模块路径是/WEB-INF/views/jsp/oa，命名为oasendandreceivequery，JS脚本oasendandreceivequeryjs。（4）公文类型维护：模块路径是/WEB-INF/views/jsp/oa，命名为oatype，JS脚本oatypejs。（5）公文类别维护：模块路径是/WEB-INF/views/jsp/oa，命名为oacategory，JS脚本oacategoryjs。（6）公文专题词维护：模块路径是/WEB-INF/views/jsp/oa，命名为oatopic，JS脚本oatopicjs。（7）收文单位维护：模块路径是/WEB-INF/views/jsp/oa，命名为oaunits，JS脚本oaunitsjs。（8）公文分发：模块路径是/WEB-INF/views/jsp/oa，命名为myarchives，JS脚本myarchivesjs。（9）任务委办：模块路径是/WEB-INF/views/jsp/oa，命名为oacommision，JS脚本oacommisionjs。（10）经办公文查询：模块路径是/WEB-INF/views/jsp/oa，命名为passtask，JS脚本passtaskjs。（11）发文归档：模块路径是/WEB-INF/views/jsp/oa/send，命名为oaSendPigeonhole，JS脚本oaSendPigeonholeJs。（12）收文归档：模块路径是/WEB-INF/views/jsp/oa/receive，命名为oaReceivePigeonhole，JS脚本oaReceivePigeonholeJs。（13）步骤监控：模块路径是/WEB-INF/views/jsp/oa/bpm，步骤状态监控命名为bpmmanager，步骤图命名为bpmview。1.4.2 类命名规则（1）发文管理：a)控制类路径：com.csscis.water.lcx.oa.ctrl. OaSendController;com.csscis.water.lcx.oa.ctrl. OaSendQueryController;b)接口路径：com.csscis.water.lcx.oa.service. OaSendService;com.csscis.water.lcx.oa.service. OaSendQueryService;c)实现类路径：com.csscis.water.lcx.oa.service.impl. OaSendServiceImpl;com.csscis.water.lcx.oa.service.impl. OaSendQueryServiceImpl;d)实体路径：com.csscis.water.lcx.oa.pojo.OaDocument;com.csscis.water.lcx.oa.pojo.OaDispense;com.csscis.water.lcx.oa.pojo. OaAttachment;（2）收文管理：a)控制类路径：com.csscis.water.lcx.oa.ctrl. OaReceiveController;com.csscis.water.lcx.oa.ctrl. OaReceiveQueryController;b)接口路径：com.csscis.water.lcx.oa.service. OaReceiveService;com.csscis.water.lcx.oa.service. OaReceiveQueryService;c)实现类路径：com.csscis.water.lcx.oa.service.impl. OaReceiveServiceImpl;com.csscis.water.lcx.oa.service.impl.OaReceiveQueryServiceImpl;d)实体路径：com.csscis.water.lcx.oa.pojo.OaDocument;com.csscis.water.lcx.oa.pojo.OaDispense;com.csscis.water.lcx.oa.pojo. OaAttachment;（3）收发文查询：a)控制类路径：com.csscis.water.lcx.oa.ctrl. OaSendAndReceiveController;b)接口路径：com.csscis.water.lcx.oa.service. OaSendAndReceiveService;c)实现类路径：com.csscis.water.lcx.oa.service.impl.OaSendAndReceiveServiceImpl;（4）公文类型维护：a)控制类路径：com.csscis.water.lcx.oa.ctrl. OaTypeController;b)接口路径：com.csscis.water.lcx.oa.service. OaTypeService;c)实现类路径：com.csscis.water.lcx.oa.service.impl. OaTypeServiceImpl;d)实体路径：com.csscis.water.lcx.oa.pojo.OaType;（5）公文类别维护：a)控制类路径：com.csscis.water.lcx.oa.ctrl. OaCategoryController;b)接口路径：com.csscis.water.lcx.oa.service. OaCategoryService;c)实现类路径：com.csscis.water.lcx.oa.service.impl. OaCategoryServiceImpl;d)实体路径：com.csscis.water.lcx.oa.pojo.OaCategory;（6）公文专题词维护：a)控制类路径：com.csscis.water.lcx.oa.ctrl.OaTopicController;b)接口路径：com.csscis.water.lcx.oa.service.OaTopicService;c)实现类路径：com.csscis.water.lcx.oa.service.impl. OaTopicServiceImpl;d)实体路径：com.csscis.water.lcx.oa.pojo.OaTopic;（7）来文单位维护：a)控制类路径：com.csscis.water.lcx.oa.ctrl. OaUnitsController;b)接口路径：com.csscis.water.lcx.oa.service. OaUnitsService;c)实现类路径：com.csscis.water.lcx.oa.service.impl. OaUnitsServiceImpl;d)实体路径：com.csscis.water.lcx.oa.pojo.OaUnits;（8）公文分发：a)控制类路径：com.csscis.water.lcx.oa.ctrl.OaMyArchivesController;b)接口路径：com.csscis.water.lcx.oa.service. OaMyArchivesService;c)实现类路径：com.csscis.water.lcx.oa.service.impl.OaMyArchivesServiceImpl;（9）任务委办：a)控制类路径：com.csscis.water.lcx.oa.ctrl.OaCommisionController;b)接口路径：com.csscis.water.lcx.oa.service.OaCommisionService;c)实现类路径：com.csscis.water.lcx.oa.service.impl.OaCommisionServiceImpl;（10）经办公文查询：a)控制类路径：com.csscis.water.lcx.oa.ctrl.PassTaskController;b)接口路径：com.csscis.water.lcx.oa.service.PassTaskService;c)实现类路径：com.csscis.water.lcx.oa.service.impl.PassTaskServiceImpl;（11）收发文归档：a)控制类路径：com.csscis.water.lcx.oa.ctrl.OaPigeonholeController;b)接口路径：com.csscis.water.lcx.oa.service. OaPigeonholeService;c)实现类路径：com.csscis.water.lcx.oa.service.impl.OaPigeonholeServiceImpl;（12）步骤监控：a)控制类路径：com.csscis.water.lcx.oa.ctrl.BpmManagerController;com.csscis.water.lcx.oa.ctrl.BpmQueryController;b)接口路径：com.csscis.water.lcx.oa.service.BpmManagerService;com.csscis.water.lcx.oa.service.BpmQueryService;c)实现类路径：com.csscis.water.lcx.oa.service.impl.BpmManagerServiceImpl;com.csscis.water.lcx.oa.service.impl.BpmQueryServiceImpl1.4.3 数据库命名规则公文电子表单：OA_DOCUMENT公文附件：OA_ATTACHMENT公文类型：OA_TYPE公文类别：OA_CATEGORY分发对象：OA_DISPENSE公文意见：OA_OPINION公文专题词：OA_TOPIC公文类型：OA_TYPEOA_UNITS：来文单位1.5 公文归档WSDLa) 接口类路径：mon.service. SystemInterfaceService;b) 实现类路径：mon.service. SystemInterfaceServiceImpl;c) 返回结果集路径：com.csscis.water.lcx.ws.pojo.WebDocument;WebDocument还包含以下子类：com.csscis.water.lcx.ws.pojo.WebOpinion;com.csscis.water.lcx.ws.pojo.WebAttachment;1.6 个人事务助理个人事物助理日程安排日程安排维护事务抵达提醒工作日志日志维护1.6.1模块命名规则a) jsp文件总路径：/WEB-INF/views/jsp/schedule;1.6.2类命名规则a) 控制类总路径：com.csscis.water.lcx.work.ctrl;b) 接口类总路径：com.csscis.water.lcx.work.service;c) 实现类总路径：com.csscis.water.lcx.work.service.impl;d) 实体类总路径：com.csscis.water.lcx.work.pojo;1.6.2数据库命名规则日程安排：SCHEDULE日程提醒：SCHEDULE_REMIND工作日志：WORKLOG日志附件：WORKLOG_ATTACHMENT第三章 系统模块结构一 协同办公子系统1、结构设计：公文管理协同办公（OA）子系统通知个人邮件公告个人事务发文收文收邮件写邮件通知维护通知查收公告维护公告查收日程安排工作日志步骤监控2、命名规则：全部功效模块使用类文件父路径：com.csscis.water.lcx.oa，以协同办公英文缩写oa命名。3、配置文件路径：/WebRoot/WEB-INF/configs/oa-config.xml，/WebRoot/WEB-INF/configs/csscis.xml；在csscis.xml中协同办公子系统使用到键值说明：a) 打开公文附件超时后系统解锁时间,单位是小时：b) 邮件服务器地址：c) 邮件主机名和域名：d) 邮件中每个人存放附件磁盘大小(单位M)：e) 邮件中每个人存放附件使用磁盘大小提醒界限(单位M)：f) 档案系统安全校验码：4、数据库逻辑结构：5、数据库物理结构：6、用例图第四章 协同办公子系统具体设计一 个人邮箱模块设计1.1 程序描述1、需求要求开发个人邮箱，实现个人邮件收发功效。兼容各类附件文档格式，设置邮件管理、抵达提醒功效。管理其它邮箱账户。2、结构设计个人邮件写邮件收邮件初稿箱已发邮件保持初稿发邮件查看邮件删除收件箱查询垃圾箱还原删除根本删除删除发送邮箱账户维护添加账户删除账户链接邮箱3、功效设计（1）收邮件收件箱：查看收到邮件，同时还有服务器端自动推送到功效，即有新邮件自动推送到用户端。标注邮件状态，已经查看，为查看，紧急或非紧急邮件；删除邮件：不是物理删除，只是状态删除，标识为垃圾邮件；查看邮件：读邮件，同时标识邮件已读；查询：搜索功效，依据关键字查找相关邮件；垃圾箱：其它模块删除邮件全部会先保留在垃圾箱，只有在垃圾箱删除，才是物理删除，还能够对垃圾箱邮件还原；（2）写邮件：发邮件：写完邮件，在发送到时候，能够选择发送并保持，副本会保持到已发邮件。写邮件支持附件发送；保持初稿：写完邮件，能够临时不发送，而是保留起来，择期发送，邮件会预先保持到初稿箱；已发邮件：对已经发送到邮件副本保留，能够进行删除，查看，转发；初稿箱：能够进行删除或发送操作，操作完成后，对应初稿邮件全部会删除；（3）邮箱账户维护添加账户：是将其它邮箱账户和密码保留在本系统；删除账户：删除保留在本系统上非本系统邮箱账户和密码；链接邮箱：经过保留在本系统邮箱账户和密码，打开对应邮箱；1.2 功效设计写邮件收邮件1.3 界面设计个人邮箱实现邮件收发功效，同时支持多种格式附件上传和下载功效，实现多个邮箱一站式登录。n 数据录入、存放、展现方法收件箱列表收件箱 (共 6 封，其中 未读邮件0 封)发件人邮件标签专题日期附件大小今天(1封)相关xxxxxx-xx-xxxx.xxM最近一周(2封)相关xxxxxx-xx-xxxx.xxM相关xxxxxx-xx-xxxx.xxM最近一周(3封)相关xxxxxx-xx-xxxx.xxM相关xxxxxx-xx-xxxx.xxM相关xxxxxx-xx-xxxx.xxM打开后邮件信息：标题：相关xxx文件发件人：收信人：抄送：密送：附件xxx. rar 下载邮件正文内容展示界面以下：邮箱列表163邮箱 登录 编辑 Sina邮箱 登录 编辑 Yahoo邮箱 登录 编辑 1.4 输人设计编辑邮件信息：标题：相关xxx文件发件人：收信人：抄送：密送：附件 .浏览邮件正文内容编辑邮箱帐号界面以下：邮箱名称：163邮箱登录帐号：XXX163.COM登录密码：*确定密码：*1.5 步骤逻辑序号名称类别备注1用户Actor系统使用者2写邮件Use case3添加Use case4保留Use case5发送Use case6查看已发邮件Use case7删除Use case物理删除8查询已发邮件Use case对已发邮件搜索9查询初稿Use case对保留邮件初稿搜索序号名称类别备注1用户Actor系统使用者2查看邮件Use case3删除Use case状态删除4根本删除Use case物理删除5查看收到邮件Use case6还原删除邮件Use case对状态删除邮件还原1.6 存放设计邮件基础数据和邮件正文内容以数据流形式存放于数据库中，其中附件将以文件个体存放于硬盘，以文件流进行读取、下载。1.7 限制条件1、因为服务器性能限制，邮件附件不易过大，限制在30M以内为佳。2、外部邮箱登录只能登录安全限制较小外部邮箱，比如安全限制较大网易邮箱等，只能定位到其登陆界面。二通知模块设计2.1 程序描述1、设计要求开发通知功效，实现各类会议、事务通知公布、查询功效，设置通知信息管理、抵达提醒功效。在系统门户主页设置通知版块，按时间排序。2、结构设计通知通知维护通知查收新增修改删除查询查看提醒查询3、功效设计（1）通知维护由单位或部门专门责任人进行新增通知公布，公布通知需要设定查收对象，是个人，或部门，或单位，或全体；在公布之前能够修改、删除，对历史通知能够搜索查找，查找方法能够是标题，日期等；（2）通知查收收到通知人才能够查看通知，查询和通知即时提醒；2.2 功效设计通知维护权限由系统管理员进行指派，通常一个部门最少有一个人含有此模块权限。本部门人能够修改本部门通知，修改后对修改人和修改时间进行统计跟踪。可按通知标题、录入人、办理部门和通知时间进行模糊查询。写通知由该部门公布通知人员对通知信息进行文字性录入工作，通知信息内容以数据库方法进行存放，在门户首页以文字进行滚动数据展现。收通知2.3 界面设计通知信息列表：门户首页信息展现界面：后台“我通知”模块显示界面查看通知具体内容2.4 输人设计信息录入介面：2.5 步骤逻辑序号名称类别备注1用户Actor系统使用者2添加Use case3删除Use case物理删除（已发送通知不能删除）4查询Use case5修改Use case已发送通知不能修改序号名称类别备注1用户Actor系统使用者2通知提醒Use case3查看通知Use case2.6 存放设计通知基础数据和邮件正文内容以数据流形式存放于数据库中，其中附件将以文件个体存放于硬盘，以文件流进行读取、下载。2.7 限制条件1、考虑到网络带宽等客观原因影响，单个附件最大不宜超出100M（包含100M）。2、上传附件时不宜在当地打开要上传文件（尤其是WPSOffice办公软件），可能会引发文件流传输中止，造成不能成功上传。三公告模块设计3.1 程序描述1、设计要求开发公告功效，实现各类事务公告公布、查询功效，设置公告信息管理、抵达提醒功效。在系统门户主页设置公告版块，按时间排序。2、结构设计公告公告维护修改新增公告查看删除查询查看提醒3、功效设计（1）公告维护由单位或部门专门责任人进行新增通知公布，公布通知需要设定查收对象是全部些人；在公布之前能够修改、删除，对历史通知能够搜索查找，查找方法能够是标题，日期等；修改只能是公布通知部门人员，修改同时统计操作日志；3.2 功效设计通知维护权限由系统管理员进行指派，通常一个部门最少有一个人含有此模块权限。本部门人能够修改本部门通知，修改后对修改人和修改时间进行统计跟踪。可按通知标题、录入人、办理部门和通知时间进行模糊查询。写公告由该部门公布通知人员对通知信息进行文字性录入工作，通知信息内容以数据库方法进行存放，在门户首页以文字进行滚动数据展现。公告栏3.3 界面设计公告信息列表：门户首页信息展现界面：后台“公告栏”展示界面查看公告具体内容3.4 输入设计信息录入介面：3.5 步骤逻辑序号名称类别备注1用户Actor系统使用者2添加Use case3删除Use case物理删除（已发送公告不能删除）4查询Use case5修改Use case已发送公告不能修改序号名称类别备注1用户Actor系统使用者2公告提醒Use case3查看公告Use case3.6 存放设计公告基础数据和邮件正文内容以数据流形式存放于数据库中，其中附件将以文件个体存放于硬盘，以文件流进行读取、下载。3.7 限制条件1、考虑到网络带宽等客观原因影响，单个附件最大不宜超出100M（包含100M）。2、上传附件时不宜在当地打开要上传文件（尤其是WPSOffice办公软件），可能会引发文件流传输中止，造成不能成功上传。四发文管理模块设计4.1 程序描述需求要求n 功效描述对发文信息进行电子文档化步骤处理。n 业务范围拟稿部门拟稿拟稿部门领导核稿拟办人填写拟办意见相关部门会签校核人校核领导签发拟办人印发档案管理部门归档n 业务步骤图n 业务功效具体描述 拟稿：拟搞人进行拟搞，拟搞完成开启步骤，步骤进行下一步走向 审核：拟稿人部门领导进行审核，审核经过步骤下一步走向，审核未经过步骤走向下一步。 拟办：拟办人进行拟办，公文需要会签时拟办人选择部门会签，不需要会签时拟办人选择领导指示。 会签：各部门进行会签，会签全部经过步骤走向，会签过程中有一个部门或人员未经过则公文返回给拟稿人，若公文需要返回给拟办人修改则步骤走向。 指示：领导进行意见指示，指示完成返回给拟稿人进行公文封发 印发：公文印发前填写发文文号和密级，填写完成走向印发前校核,对校核完稿件能够进行印发。 校核：校核人能够对公文信息进行校正修改，校核完成返回给拟办人进行印发。 结束：印发完成，步骤结束。n 数据起源由拟稿部门拟制文字材料，发文基础信息和发文电子文档附件由该部门拟搞人统一录入、上传。n 安全和权限通常人员只能查看或处理自己公文，假如需要了解全局收发文情况则应该由系统管理员指定权限。n 组合查询可按文件标题、文件类别、发文号、主办单位、拟稿人等字段查询和组合查询，文本类型字段支持模糊查询。4.2 用例图4.3 界面设计发文电子表单：发文拟稿：发文查询：4.4 步骤逻辑序号名称类别备注1拟稿人Actor2组织部门领导Act