OA详细设计说明书
OA系统 1.0 详细设计说明书
修订历史记录
A - 增加M - 修订 D - 删除
目录
第一章引言 (4)
1.1编写目的 (4)
1.2背景 (4)
1.3术语解释 (4)
第二章系统命名规则 (4)
一协同办公子系统 (4)
1.1 个人邮箱 (4)
1.2通知 (8)
1.3公告 (9)
1.4公文管理 (11)
1.5 公文归档WSDL (18)
1.6 个人事务助理 (18)
第三章系统模块结构 (20)
一协同办公子系统 (20)
第四章协同办公子系统详细设计 (23)
一个人邮箱模块设计 (23)
1.1 程序描述 (23)
1.2 功能设计 (25)
1.3 界面设计 (26)
1.4 输人设计 (27)
1.5 流程逻辑 (28)
1.6 存储设计 (29)
1.7 限制条件 (29)
二．通知模块设计 (29)
2.1 程序描述 (29)
2.2 功能设计 (30)
2.3 界面设计 (31)
2.4 输人设计 (32)
2.5 流程逻辑 (33)
2.6 存储设计 (34)
2.7 限制条件 (34)
三．公告模块设计 (34)
3.1 程序描述 (34)
3.2 功能设计 (35)
3.3 界面设计 (35)
3.4 输入设计 (36)
3.5 流程逻辑 (37)
3.6 存储设计 (38)
3.7 限制条件 (38)
四．发文管理模块设计 (38)
4.1 程序描述 (38)
4.2 用例图 (40)
4.3 界面设计 (41)
4.4 流程逻辑 (42)
4.5 存储设计 (43)
4.6 限制条件 (43)
五．收文管理模块设计 (43)
5.1 程序描述 (43)
5.2 用例图 (45)
5.3 界面设计 (45)
5.4 流程逻辑 (47)
5.5 存储设计 (48)
5.6 限制条件 (48)
六、日程安排模块设计 (48)
6.1 程序描述 (48)
6.2 用例图 (50)
6.3 界面设计 (51)
6.4 流程逻辑 (52)
6.5 存储设计 (52)
七、工作日志模块设计 (52)
7.1 程序描述 (52)
7.2 用例图 (53)
7.3 界面设计 (53)
7.4 流程逻辑 (54)
7.5 存储设计 (55)
八、经办公文查询模块设计 (55)
8.1 程序描述 (55)
8.2 界面设计 (56)
九、收发文查询模块设计 (58)
9.1 程序描述 (58)
9.2 界面设计 (58)
十、公文归档模块设计 (59)
10.1 程序描述 (59)
10.2 界面设计 (59)
第一章引言
1.1 编写目的
1、编写本说明书的目的：本文档的目的在于让开发人员、系统维护人员全面了解本系统的功能设计。
2、预期的读者：协同办公子系统开发人员、系统维护人员。
1.2 背景
a．协同办公子系统；
b.本项目的任务由综合管理部提出，由开发部进行开发。
1.3 术语解释
【列出本文件中用到的专门术语的定义和外文首字母缩写的原词组。】
第二章系统命名规则
一协同办公子系统
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_DISTINCTION distinction:紧急、普通、缓慢
邮件附件：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.AdviceUser
com.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;
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.OaSendAndReceiveServiceIm pl;
（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）公文类别维护：
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.BpmQueryServiceImpl
1.4.3 数据库命名规则
公文电子表单：OA_DOCUMENT
公文附件：OA_ATTACHMENT
公文类型：OA_TYPE
公文类别：OA_CATEGORY
分发对象：OA_DISPENSE
公文意见：OA_OPINION
公文主题词：OA_TOPIC
公文类型：OA_TYPE
OA_UNITS：来文单位
1.5 公文归档WSDL
a) 接口类路径：
https://www.360docs.net/doc/6c15607913.html,mon.service.SystemInterfaceService;
b) 实现类路径：
https://www.360docs.net/doc/6c15607913.html,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