OA程序維護手冊

1、 OA系統(tǒng) 1.0程序維護手冊文件控制受控 不受控文檔編號OA-1201版本號1.0分冊名稱OA系統(tǒng)-程序維護手冊第1冊/共1冊總頁數(shù)10正文9附錄無編制江華審批譚璨生效日期2014-06-011 引言1.1 功能 本系統(tǒng)從業(yè)務功能上分為公文管理、個人郵箱、通知管理、個人事務等功能模塊。通用的業(yè)務模塊：根據(jù)多年的軟件開發(fā)經(jīng)驗編寫一個應用平臺，在這個平臺上可以進行用戶的定制化配置，然后達到用戶實際運行的要求。性能要求：遵循總體設計的性能設計要求。動態(tài)提示：新郵件、新通知等都會以消息提示的形式，提示出來并且會播放提示聲音。1.2參考資料編號資料名稱作者日期1OA系統(tǒng)計劃任務書江華2014-02-2

2、52OA系統(tǒng)需求規(guī)格說明江華2014-02-123OA創(chuàng)建規(guī)則需求規(guī)格說明書江華2014-02-184OA項目解決方案江華2014-02-26 2 功能2.1總體說明OA主要分為服務端和前端。服務端部署在專門的 OA服務器（機群）上，前端部署在各個電腦的信息系統(tǒng)之上。各OA前端主要完成數(shù)據(jù)收集工作，將企業(yè)提供的數(shù)據(jù)，按照一定校驗規(guī)則進行檢查，并把符合條件的數(shù)據(jù)放到相應的文本中，為服務段提供數(shù)據(jù)上傳。服務端從若干個前端采集數(shù)據(jù)，并把采集來的數(shù)據(jù)按照一定的規(guī)則加以整理和儲存，最終通過 Web Service提供 OA索引服務。同時，在服務端上運行 OA管理程序，通過 B/S方式提供 OA管理功能，

3、保證OA服務良好運行。系統(tǒng)主要部門的內(nèi)部關系圖如下：2.2程序說明OA系統(tǒng)各個組件特性如下。2.4.1 OA服務端OA服務端是一組服務的集合。其中包括如下組件：2.4.2 FTP服務用于接收前端信息的 FTP上傳。目前是明文傳輸，將來可能要升級為 SSL安全加密的 FTP傳輸。FTP服務將接收的 OA數(shù)據(jù)文件放在相應的目錄，等待 OA管理程序處理。2.4.3 OA數(shù)據(jù)庫用來存儲 OA海量信息。對數(shù)據(jù)容量和數(shù)據(jù)存/取速度有非常高的要求?？紤]用 Oracle企業(yè)版數(shù)據(jù)庫+In-memory數(shù)據(jù)庫，或者集群數(shù)據(jù)庫實現(xiàn)。 數(shù)據(jù)庫一方面由 OA管理程序維護，更新，一方面又為 Web Service提供

4、OA檢索服務。2.4.4 Web Service對外提供 OA信息索引服務。接收相關患者/人員信息，在 OA數(shù)據(jù)庫中檢索后，返回 OA ID。將來可能需要擴展，檢索不到該條信息，則新建一條 OA ID，并返回該 OA ID給用戶。2.4.5 OA管理系統(tǒng)負責由信息文件生成 OA數(shù)據(jù)庫，和管理維護 OA數(shù)據(jù)庫。系統(tǒng)分為兩個部分，一部分是在服務段運行的一組 TOOLKIT，負責把 FTP上傳來的信息文件，經(jīng)過 OA處理規(guī)則，新增到OA數(shù)據(jù)庫中。另外一方面，提供一個 B/S結構的管理程序，允許管理人員登錄到服務器，對OA系統(tǒng)的進行手工維護。2.4.6 OA前端OA前段是部署在各個部門的多個組件的集合

5、，通常各個部門會有不同的結構，需要單獨定制。其差異性主要在通過一個 Spring配置文件來維護。前端服務：前端服務部署在各部門信息系統(tǒng)之上，由一組 Tool Kit組成，主要有如下功能。a)數(shù)據(jù)校驗：對各部門數(shù)據(jù)源的數(shù)據(jù)進行過濾，使得不符合 OA要求的信息不進入系統(tǒng)。并將有問題的數(shù)據(jù)另存在日志文件。b)數(shù)據(jù)采集：將各部門數(shù)據(jù)轉(zhuǎn)換成 OA導入可以識別的文本。數(shù)據(jù)采集程序不斷檢索各部門數(shù)據(jù)源，一旦發(fā)現(xiàn)由需要處理的任務，就開始處理。出于對各部門數(shù)據(jù)源的壓力考慮，數(shù)據(jù)采集程序可以配置運行，避免對各部門數(shù)據(jù)源帶來過多壓力。c)數(shù)據(jù)上傳：將可識別的文本上傳到 OA服務端的 FTP服務器。具有 FTP上傳客

6、戶端功能，經(jīng)過配置，將存放在特定位置的 OA信息，通過 FTP將數(shù)據(jù)上傳到 OA FTP服務器上。輔助工具：幫助開發(fā)/測試系統(tǒng)。a)數(shù)據(jù)分析：對各部門數(shù)據(jù)源各個字段進行分析和統(tǒng)計，得出可以評價各部門數(shù)據(jù)源的有效結論。數(shù)據(jù)分析程序能有效幫助我們對各部門數(shù)據(jù)源進行個性化處理。避免采集的OA信息出現(xiàn)重大問題。b)數(shù)據(jù)生成：模擬各部門數(shù)據(jù)供開發(fā)測試。跟據(jù)數(shù)據(jù)分析結果產(chǎn)生一組相應數(shù)據(jù)，檢查OA處理程序能否對數(shù)據(jù)進行符合期望的處理。數(shù)據(jù)生成程序和數(shù)據(jù)分析程序相互印證。系統(tǒng)應該提供友好的操作界面，滿足客戶易用性要求。3操作環(huán)境3.1.1設備 OA系統(tǒng)設備主要包括 OA中心服務器和各個前端系統(tǒng)的工作站。OA中

7、心服務器推薦配置：Core CPU；8G內(nèi)存；G硬盤。OA前端系統(tǒng)工作站推薦配置：Core CPU；4G內(nèi)存；G硬盤。3.1.2支持軟件OA中心服務器使用支持軟件如下：操作系統(tǒng)：推薦使用 Windows Server 2011 Datacenter；可選 Red Hat ES 5.0；企業(yè)系統(tǒng)平臺：要求 JDK 5.0以上；數(shù)據(jù)庫系統(tǒng)：參見 3.2；FTP服務器：推薦使用 Serv-U FTP Server 7.0以上；可選 IIS FTP Server 5.0以上；Web服務器：推薦使用 Apache Jetspeed 2以上OA前端系統(tǒng)工作站使用支持軟件如下：操作系統(tǒng)：推薦使用 Windo

8、ws Server 2003；可選 Windows XP SP2；企業(yè)系統(tǒng)平臺：要求 JDK 5.0以上；數(shù)據(jù)庫系統(tǒng)：MS SQL Server 2000，MS SQL Server 2005；3.2數(shù)據(jù)庫OA系統(tǒng)使用 Oracle 11g數(shù)據(jù)庫，同時使用 H2作為可替代的開源版本數(shù)據(jù)庫，兩種數(shù)據(jù)庫可根據(jù)具體應用的不同分開或協(xié)同工作。 4維護過程4.1約定一、OA系統(tǒng) Java編碼風格必須符合 OA軟件界面設計及編碼標準規(guī)范中的如下幾個約定（詳細信息參考 OA軟件界面設計及編碼標準規(guī)范文檔）：1、對象命名約定；2、注釋約定；3、結構化編碼約定；4、數(shù)據(jù)源的約定及訪問約定；5、其他約定。二、OA

9、系統(tǒng)數(shù)據(jù)設計編碼風格必須符合 SQL標準編碼規(guī)范。三、OA系統(tǒng)維護、開發(fā)、測試引用以下規(guī)范性指導文件：1、GB/T17544: 1998軟件質(zhì)量要求和測試；2、GB/T18492: 2001系統(tǒng)及軟件完整性級別。4.2驗證過程OA系統(tǒng)開發(fā)過程中的修改，按照開發(fā)流程，必須提交修改報告，根據(jù)修改報告做出相應修改后，由專門測試人員對修改內(nèi)容進行測試。測試完成后，根據(jù)測試分析報告完成修改報告，并發(fā)布 OA系統(tǒng)的更新版本。測試的過程為：1、根據(jù)修改報告制定測試需求；2、設計測試用例；3、準備測試數(shù)據(jù)；4、按計劃執(zhí)行測試用例；5、記錄執(zhí)行過程；6、提出糾正建議措施；7、記錄、報告所發(fā)現(xiàn)的缺陷；8、發(fā)布到

10、JIRA上；9、分析測試結果 10、編寫成測試分析報告。4.3出錯及糾正方法一、程序出錯及糾正方法 1、對于 UI輸入錯誤通過在UI代碼中增加輸入校驗模塊，對用戶輸入進行校驗，如果用戶輸入錯誤則提示用戶出錯信息，要求用戶必須重新輸入。2、對于 UI操作錯誤通過在UI代碼中增加操作校驗模塊，對用戶操作進行校驗或者限制，一旦發(fā)現(xiàn)用戶有非法操作，提示用戶正確的操作流程信息或者限制用戶進行非法操作。3、對于程序運行時捕獲到的異常在程序關鍵代碼里異常捕捉塊，對異常進行捕捉并進行處理，并將異常產(chǎn)生的詳細信息記入日志文件，方便糾錯排錯。如果是普通異常則處理后程序流程繼續(xù)往下走不終止；如果是致命性異?；蛘咤e誤

11、則立即終止程序的執(zhí)行。4、在程序中增加檢查點為了增加代碼的可維護性，方便查錯糾錯，在源代碼中易出錯的地方增加檢查點，這樣方便在程序出錯時進行跟蹤調(diào)試5、內(nèi)存溢出對運行時內(nèi)存溢出錯誤應仔細檢查代碼中引用數(shù)組的上下標，變量的定義。6、資源釋放及時對各種不再運行的資源進行有效釋放，如數(shù)據(jù)庫連接對象，防止產(chǎn)生并發(fā)問題。二、對于數(shù)據(jù)庫錯誤由數(shù)據(jù)庫管理員定期對數(shù)據(jù)庫數(shù)據(jù)進行分析，每隔一段時間對索引進行重建，每天某個時段對數(shù)據(jù)庫文件在多個服務器間進行同步備份。三、對于容錯設置冷后備系統(tǒng)，當聯(lián)機系統(tǒng)出現(xiàn)故障或者停機時，后備系統(tǒng)自動接管工作成為聯(lián)機系統(tǒng)。四、對于持久層設置的二級緩存不同步問題如果頻繁出現(xiàn)不同步問

12、題，可暫時將二級緩存關閉。4.4專門維護過程一、系統(tǒng)配置信息的維護：本系統(tǒng)設計一個單獨的“系統(tǒng)設置”，用于修改人員的基本信息和權限，管理員還可通過本系統(tǒng)提供的外部應用程序直接修改系統(tǒng)的配置文件，部分配置的更改應具有熱部署功能，即在修改程序配置后不需要重新啟動程序。二、源代碼的維護：從增加源代碼的可讀性，可修改性，可維護性，可適應性入手。1、增加代碼的可讀性，統(tǒng)一代碼的命名規(guī)則，給源代碼添加必要的注釋。2、增加代碼的可修改性，將源代碼放在SVN上方便團隊修改3、 增加代碼的可維護性，在源代碼中增加檢測點，方便在程序出錯時進行跟蹤調(diào)試4、增加代碼的可適應性，在保證不影響可讀性和性能的前提下，盡可能

13、增大代碼的復用度，預留若干接口，降低模塊間的藕合度，以適應未來由于需求變動。三、引入工作流在OA系統(tǒng)開發(fā)過程中引入Jira工作流，開發(fā)過程嚴格按照Jira的工作流程走，這樣可以方便地進行源代碼的review和重構，也可以方便地對系統(tǒng)的BUG和ISSUE進行管理。4.5專用維護程序一、BUG和 ISSUE維護程序。采用 JIRA對系統(tǒng) BUG和 ISSUE進行管理和跟蹤，以下是一個 OA系統(tǒng)開發(fā)遵循的 JIRA完整工作流程：二、源代碼維護程序。采用 SVN對源代碼進行管理和維護，但開發(fā)人員對代碼進行修改后，需將修改提交至 SVN服務器。開發(fā)人員也可將最新的源代碼從服務器上簽出，以更新本機源碼。通過 SVN對源代碼進行管理，可以方便地進行團隊開發(fā)。三、系統(tǒng)配置維護程序。在 OA管理程序中增加了一個叫“系統(tǒng)配置”的程序，通過該程序可以對系統(tǒng)的使用權限進行管理，可以增加，刪除用戶，設置用戶密碼和使用權限。另外通過系統(tǒng)配置還可以對系統(tǒng)的配置進行增刪改。其中部分配置修改后有熱部署功能，不需要重啟應用。四、數(shù)據(jù)庫維護程序。采用 Oracle客戶端工具