OA程序维护手册.docx

1、OA程序维护手册 OA系统 1.0程序维护手册文件控制受控 不受控文档编号OA-1201版本号1.0分册名称OA系统-程序维护手册第1册/共1册总页数10正文9附录无编制江华审批谭璨生效日期2014-06-011 引言1.1 功能 本系统从业务功能上分为公文管理、个人邮箱、通知管理、个人事务等功能模块。通用的业务模块：根据多年的软件开发经验编写一个应用平台，在这个平台上可以进行用户的定制化配置，然后达到用户实际运行的要求。性能要求：遵循总体设计的性能设计要求。动态提示：新邮件、新通知等都会以消息提示的形式，提示出来并且会播放提示声音。1.2参考资料编号资料名称作者日期1OA系统计划任务书江华2

2、014-02-252OA系统需求规格说明江华2014-02-123OA创建规则需求规格说明书江华2014-02-184OA项目解决方案江华2014-02-26 2 功能2.1总体说明OA主要分为服务端和前端。服务端部署在专门的 OA服务器（机群）上，前端部署在各个电脑的信息系统之上。各OA前端主要完成数据收集工作，将企业提供的数据，按照一定校验规则进行检查，并把符合条件的数据放到相应的文本中，为服务段提供数据上传。服务端从若干个前端采集数据，并把采集来的数据按照一定的规则加以整理和储存，最终通过 Web Service提供 OA索引服务。同时，在服务端上运行 OA管理程序，通过 B/S方式提供

3、 OA管理功能，保证OA服务良好运行。系统主要部门的内部关系图如下：2.2程序说明OA系统各个组件特性如下。2.4.1 OA服务端OA服务端是一组服务的集合。其中包括如下组件：2.4.2 FTP服务用于接收前端信息的 FTP上传。目前是明文传输，将来可能要升级为 SSL安全加密的 FTP传输。FTP服务将接收的 OA数据文件放在相应的目录，等待 OA管理程序处理。2.4.3 OA数据库用来存储 OA海量信息。对数据容量和数据存/取速度有非常高的要求。考虑用 Oracle企业版数据库+In-memory数据库，或者集群数据库实现。 数据库一方面由 OA管理程序维护，更新，一方面又为 Web Se

4、rvice提供 OA检索服务。2.4.4 Web Service对外提供 OA信息索引服务。接收相关患者/人员信息，在 OA数据库中检索后，返回 OA ID。将来可能需要扩展，检索不到该条信息，则新建一条 OA ID，并返回该 OA ID给用户。2.4.5 OA管理系统负责由信息文件生成 OA数据库，和管理维护 OA数据库。系统分为两个部分，一部分是在服务段运行的一组 TOOLKIT，负责把 FTP上传来的信息文件，经过 OA处理规则，新增到OA数据库中。另外一方面，提供一个 B/S结构的管理程序，允许管理人员登录到服务器，对OA系统的进行手工维护。2.4.6 OA前端OA前段是部署在各个部门

5、的多个组件的集合，通常各个部门会有不同的结构，需要单独定制。其差异性主要在通过一个 Spring配置文件来维护。前端服务：前端服务部署在各部门信息系统之上，由一组 Tool Kit组成，主要有如下功能。a)数据校验：对各部门数据源的数据进行过滤，使得不符合 OA要求的信息不进入系统。并将有问题的数据另存在日志文件。b)数据采集：将各部门数据转换成 OA导入可以识别的文本。数据采集程序不断检索各部门数据源，一旦发现由需要处理的任务，就开始处理。出于对各部门数据源的压力考虑，数据采集程序可以配置运行，避免对各部门数据源带来过多压力。c)数据上传：将可识别的文本上传到 OA服务端的 FTP服务器。具

6、有 FTP上传客户端功能，经过配置，将存放在特定位置的 OA信息，通过 FTP将数据上传到 OA FTP服务器上。辅助工具：帮助开发/测试系统。a)数据分析：对各部门数据源各个字段进行分析和统计，得出可以评价各部门数据源的有效结论。数据分析程序能有效帮助我们对各部门数据源进行个性化处理。避免采集的OA信息出现重大问题。b)数据生成：模拟各部门数据供开发测试。跟据数据分析结果产生一组相应数据，检查OA处理程序能否对数据进行符合期望的处理。数据生成程序和数据分析程序相互印证。系统应该提供友好的操作界面，满足客户易用性要求。3操作环境3.1.1设备 OA系统设备主要包括 OA中心服务器和各个前端系统

7、的工作站。OA中心服务器推荐配置：Core CPU；8G内存；G硬盘。OA前端系统工作站推荐配置：Core CPU；4G内存；G硬盘。3.1.2支持软件OA中心服务器使用支持软件如下：操作系统：推荐使用 Windows Server 2011 Datacenter；可选 Red Hat ES 5.0；企业系统平台：要求 JDK 5.0以上；数据库系统：参见 3.2；FTP服务器：推荐使用 Serv-U FTP Server 7.0以上；可选 IIS FTP Server 5.0以上；Web服务器：推荐使用 Apache Jetspeed 2以上OA前端系统工作站使用支持软件如下：操作系统：推荐

8、使用 Windows Server 2003；可选 Windows XP SP2；企业系统平台：要求 JDK 5.0以上；数据库系统：MS SQL Server 2000，MS SQL Server 2005；3.2数据库OA系统使用 Oracle 11g数据库，同时使用 H2作为可替代的开源版本数据库，两种数据库可根据具体应用的不同分开或协同工作。 4维护过程4.1约定一、OA系统 Java编码风格必须符合 OA软件界面设计及编码标准规范中的如下几个约定（详细信息参考 OA软件界面设计及编码标准规范文档）：1、对象命名约定；2、注释约定；3、结构化编码约定；4、数据源的约定及访问约定；5、其

9、他约定。二、OA系统数据设计编码风格必须符合 SQL标准编码规范。三、OA系统维护、开发、测试引用以下规范性指导文件：1、GB/T17544: 1998软件质量要求和测试；2、GB/T18492: 2001系统及软件完整性级别。4.2验证过程OA系统开发过程中的修改，按照开发流程，必须提交修改报告，根据修改报告做出相应修改后，由专门测试人员对修改内容进行测试。测试完成后，根据测试分析报告完成修改报告，并发布 OA系统的更新版本。测试的过程为：1、根据修改报告制定测试需求；2、设计测试用例；3、准备测试数据；4、按计划执行测试用例；5、记录执行过程；6、提出纠正建议措施；7、记录、报告所发现的缺

10、陷；8、发布到 JIRA上；9、分析测试结果 10、编写成测试分析报告。4.3出错及纠正方法一、程序出错及纠正方法 1、对于 UI输入错误通过在UI代码中增加输入校验模块，对用户输入进行校验，如果用户输入错误则提示用户出错信息，要求用户必须重新输入。2、对于 UI操作错误通过在UI代码中增加操作校验模块，对用户操作进行校验或者限制，一旦发现用户有非法操作，提示用户正确的操作流程信息或者限制用户进行非法操作。3、对于程序运行时捕获到的异常在程序关键代码里异常捕捉块，对异常进行捕捉并进行处理，并将异常产生的详细信息记入日志文件，方便纠错排错。如果是普通异常则处理后程序流程继续往下走不终止；如果是致

11、命性异常或者错误则立即终止程序的执行。4、在程序中增加检查点为了增加代码的可维护性，方便查错纠错，在源代码中易出错的地方增加检查点，这样方便在程序出错时进行跟踪调试5、内存溢出对运行时内存溢出错误应仔细检查代码中引用数组的上下标，变量的定义。6、资源释放及时对各种不再运行的资源进行有效释放，如数据库连接对象，防止产生并发问题。二、对于数据库错误由数据库管理员定期对数据库数据进行分析，每隔一段时间对索引进行重建，每天某个时段对数据库文件在多个服务器间进行同步备份。三、对于容错设置冷后备系统，当联机系统出现故障或者停机时，后备系统自动接管工作成为联机系统。四、对于持久层设置的二级缓存不同步问题如果

12、频繁出现不同步问题，可暂时将二级缓存关闭。4.4专门维护过程一、系统配置信息的维护：本系统设计一个单独的“系统设置”，用于修改人员的基本信息和权限，管理员还可通过本系统提供的外部应用程序直接修改系统的配置文件，部分配置的更改应具有热部署功能，即在修改程序配置后不需要重新启动程序。二、源代码的维护：从增加源代码的可读性，可修改性，可维护性，可适应性入手。1、增加代码的可读性，统一代码的命名规则，给源代码添加必要的注释。2、增加代码的可修改性，将源代码放在SVN上方便团队修改3、增加代码的可维护性，在源代码中增加检测点，方便在程序出错时进行跟踪调试4、增加代码的可适应性，在保证不影响可读性和性能的

13、前提下，尽可能增大代码的复用度，预留若干接口，降低模块间的藕合度，以适应未来由于需求变动。三、引入工作流在OA系统开发过程中引入Jira工作流，开发过程严格按照Jira的工作流程走，这样可以方便地进行源代码的review和重构，也可以方便地对系统的BUG和ISSUE进行管理。4.5专用维护程序一、BUG和 ISSUE维护程序。采用 JIRA对系统 BUG和 ISSUE进行管理和跟踪，以下是一个 OA系统开发遵循的 JIRA完整工作流程：二、源代码维护程序。采用 SVN对源代码进行管理和维护，但开发人员对代码进行修改后，需将修改提交至 SVN服务器。开发人员也可将最新的源代码从服务器上签出，以更

14、新本机源码。通过 SVN对源代码进行管理，可以方便地进行团队开发。三、系统配置维护程序。在 OA管理程序中增加了一个叫“系统配置”的程序，通过该程序可以对系统的使用权限进行管理，可以增加，删除用户，设置用户密码和使用权限。另外通过系统配置还可以对系统的配置进行增删改。其中部分配置修改后有热部署功能，不需要重启应用。四、数据库维护程序。采用 Oracle客户端工具 TOAD和 PL/SQL在客户端对数据库进行一些常用的维护。也可以直接使用 Oracle的管理控制台在后端对数据库进行维护。如设置数据库用户、密码、权限。重建数据库表的索引，查看数据库日志，对数据库定期进行备份，对数据库性能进行分析和优化。五、对于开发环境中操作系统故障或者软件故障的恢复。开发环境在 VMWare虚拟机上，因此如果出现系统故障，可以直接能过切换到另一个备份虚拟机，实现故障的快速恢复。 六、OA管理程序流程图