1、1 引言1.1編寫目的1.2背景1.3定義1.4參考資料2 總體設計2.1簡述22架構設計2.2.1 系統邏輯架構圖 2.2.2 系統物理架構圖 2.2.3 頂層系統包圖2.2.4 業務類包圖2.2.5 子系統關系圖 2.3接口設計2.3.1 界面框架設計 2.3.2 外部接口設計3 子系統設計3.1基礎信息子系統3.1.1 子系統說明 3.1.2 類圖3.1.3 類說明3.1.4 界面設計3.2我的工作臺子系統3.2.1 子系統說明 3.2.2 類圖3.2.3 類說明3.2.4 界面設計3.3工作進展子系統3.3.1 子系統說明 3.3.2 類圖3.3.3 類說明3.3.4 界面設計3.4信

2、息發布子系統3.4.1 子系統說明 3.4.2 類圖3.4.3 類說明3.4.4 界面設計3.5系統管理子系統3.5.1 子系統說明 3.5.2 類圖3.5.3 類說明3.5.4 界面設計3.6個人設置子系統3.6.1 子系統說明 362類圖3.6.3 類說明3.6.4 界面設計4 約束和假定5 系統數據結構設計5.1邏輯結構設計5.1.1 角色表(PUBLIC ROLE )5.1.2 權限表(PUBLIC PRIVILEGE )5.1.3 角色權限表(PUBLIC ROLEPRIVILEGE )5.1.4 部門表(PUBLIC DEPT )5.1.5 崗位表(PUBLIC POST)5.1.

3、6 員工表(PUBLIC MEMBER)5.1.7 工作任務表(WORKPLAN TASK )5.1.8 任務分派表(WORKPLAN ALLOTTASK )5.1.9 工作計戈表(WORKPLAN_ PLAN )計戈U任務表(WORKPLAN_ PLANTASK )工作日志表(WORKPLAN WORKLOG )工作匯報表(WORKPLAN_ WORKREPORT )信息發布表(PUBLIC PUBLISHINFO )收件箱表(PUBLIC INBOX )系統操作日志表(PUBLIC_OPERA TELOG )個人提醒設置表(PUBLIC_EVENTS )系統表(PUBLIC SYSTEM

4、)系統功能模塊表(PUBLIC SYSTEMMODULE )5.2物理結構設計5.3數據結構與程序的關系6 系統出錯處理設計6.1出錯信息6.2補救措施6.3系統維護設計工作計劃管理系統概要設計說明書1 引言1.1 編寫目的 此概要設計說明書是為了說明整個系統的體系架構， 以及需求用例的各個功能點在架構 中的體現，為系統的詳細設計人員進行詳細設計時的輸入參考文檔。1.2 背景 石油工程公司將打造“國際一流的石油工程技術服務公司”作為公司發展的戰略目標， 為 確保這一目標的實現，本項目將建立一套以國際一流企業為戰略標桿的企業間對標評價體 系， 引導企業持續對不足， 促改進， 使企業經營管理各項目

5、標不斷縮小與國內或國際先進水 平的差距，保持領先優勢，持續提升綜合贏利能力。1.3 定義1.4 參考資料 石油工程公司對標評價合同書系統項目合同書 石油工程公司對標評價合同書系統項目技術服務合同附件 石油工程公司對標評價系統需求分析說明書2 總體設計2.1 簡述系統采用流行的 B/S 結構模式。系統的分析設計采用面向對象的技術，應用Visio 等工具進行輔助設計。2.2 架構設計2.2.1 系統邏輯架構圖2.2.2 系統物理架構圖2.2.3 頂層系統包圖類包說明 ： 業務頁面：用戶動態網頁。業務操作：主要控制業務訪問的接口和業務流轉。 數據處理：提供業務的實現，包括對業務數據的增、刪、改、查等

6、操作。 數據實體：業務對象的實體類。 數據接口：提供數據庫的訪問，傳遞數據或返回相應數據。 系統輔助：提供了供整個系統輔助的功能。2.2.4 業務邏輯圖2.2.5 模塊關系圖2.3 接口設計2.3.1 界面框架設計2.3.2 外部接口設計 說明本系統同外界的所有接口的安排包括軟件與硬件之間的接口、 本系統與各支持軟件 之間的接口關系。3 系統模塊設計3.1 系統管理模塊3.1.1 模塊說明 系統管理模塊包括：角色管理、部門管理、權限管理、員工管理四部分。 角色管理：定義角色和系統權限之間的對應關系，方便用戶權限的分配控制。 部門管理：實現對公司部門基本信息的維護。 權限管理：實現對用戶訪問權限

7、信息的配置。員工管理：實現對公司員工基本信息的維護。類圖角色、權限部門管理崗位管理員工管理類說明角色、權限通過ID查詢角色：頁面得到角色ID，調用Service:角色的通過ID查詢角色方法，得到指 定角色的實體數據。通過名稱查詢角色：頁面得到角色名稱，調用Service:角色的通過名稱查詢角色方法得到指定角色的實體數據。查詢全部角色：調用Service:角色的查詢全部角色方法，得到全部角色的實體數據。增加角色：在頁面上得到角色的實體數據，調用Service:角色的增加角色方法，實現角色的添加。修改角色：在頁面上得到修改后的角色實體數據，調用Service:角色的修改角色方法,實現角色的修改。刪

8、除角色：調用 Service:刪除角色方法，將指定角色的數據置為已刪除狀態。分配權限：調用 Service:分配權限方法，給指定角色分配權限。讀取角色權限：調用 Service:讀取角色權限方法，讀取指定角色的權限數據。通過 ID 查詢角色：調用Data:角色的通過ID查詢角色方法，得到指定角色的實體數據。通過名稱查詢角色：調用Data:角色的通過名稱查詢角色方法，得到指定角色的實體數據。查詢全部角色：調用 Data:角色的查詢全部角色方法，得到全部角色的實體數據。增加角色：調用 Data:角色的增加角色方法，實現角色的添加。修改角色：調用 Data:角色的修改角色方法，實現角色的修改。刪除角

9、色：調用 Data:刪除角色方法，將指定角色的數據置為已刪除狀態。分配權限：調用 Data:分配權限方法，給指定角色分配權限。讀取角色權限：調用 Data:讀取角色權限方法，讀取指定角色的權限數據。通過 ID 查詢角色：得到指定角色的實體數據。通過名稱查詢角色：得到指定角色的實體數據。 查詢全部角色：調用 Data: 角色的查詢全部角色方法 ,得到全部角色的實體數據。 增加角色：實現角色的添加。修改角色：實現角色的修改。刪除角色：將指定角色的數據置為已刪除狀態。分配權限：給指定角色分配權限。讀取角色權限：讀取指定角色的權限數據。角色實體類數據。頁面顯示全部權限內容：調用Service:權限的查

10、詢全部權限或通過所屬系統查詢全部權 限，將權限數據顯示到頁面上。通過所屬系統查詢全部權限：調用Service:權限的通過所屬系統查詢全部權限，讀取某系統下的全部權限數據。讀取用戶權限：調用 Service:權限的讀取用戶權限，讀取指定用戶的權限數據。查詢全部權限：調用 Data:權限的查詢全部權限，讀取全部的權限數據。通過所屬系統查詢全部權限：調用Data:權限的通過所屬系統查詢全部權限，讀取某系統下的全部權限數據。讀取用戶權限：調用 Data:權限的讀取用戶權限，讀取指定用戶的權限數據。 查詢全部權限：讀取全部權限數據，返回全部的權限實體類數據。通過所屬系統查詢全部權限： 讀取所屬系統權限數

11、據， 返回某系統下的全部權限實體類 數據。讀取用戶權限：讀取指定用戶的權限數據。權限實體類數據。3.1.3.2 部門管理通過ID查詢部門：根據部門ID，得到指定的部門實體類數據。 多條件查詢部門：根據多條件（部門名稱、上級部門）查詢對象，得到部門實體數據。 查詢全部部門：執行查詢，獲取全部部門的實體數據。增加部門：得到部門實體數據，將數據添加至庫中。 修改部門：得到修改后的部門實體數據，將數據保存至庫中。刪除部門：根據部門ID,刪除指定的部門。樹形顯示部門：查詢得到樹形結構上的部門數據，并顯示。此類的說明同上。此類的說明同上。部門實體類數據。3.1.3.3 崗位管理通過 ID 查詢崗位：根據崗

12、位 ID ，得到指定的崗位實體類數據。 多條件查詢崗位：根據多條件（崗位名稱、上級崗位）查詢對象，得到崗位實體數據。 查詢全部崗位：執行查詢，獲取全部崗位的實體數據。 增加崗位：得到部門實體數據，將數據添加至庫中。修改崗位：得到修改后的部門實體數據，將數據保存至庫中。 刪除崗位：根據崗位ID,刪除指定的崗位。 樹形顯示崗位：查詢得到樹形結構上的崗位數據，并顯示。 此類的說明同上。此類的說明同上。崗位實體類數據。3.1.3.4 員工管理通過 ID 查詢員工：根據員工 I D ,得到指定的員工實體類數據。 多條件查詢員工：根據多條件（工號、姓名、性別、部門、崗位、角色）查詢對象,得 到員工實體數據

13、。查詢全部員工：執行查詢,獲取全部員工的實體數據。 增加員工：得到員工實體數據,將數據添加至庫中。 修改員工：得到修改后的員工實體數據,將數據保存至庫中。刪除員工：根據員工ID,刪除指定的員工。員工修改登錄密碼：員工執行修改登錄密碼數據。此類的說明同上。此類的說明同上。員工實體類數據。3.1.4 界面設計基礎信息子系統頁面包括：角色管理、部門管理、崗位管理、員工管理四部分。3.141角色管理頁面部門管理頁面崗位管理頁面3.144員工管理頁面3.2對標評價管理模塊模塊說明對標評價管理模塊包括：對標體系管理、對標指標管理、報表管理、對標評價管理、對 標評價參數管理、對標評價算法管理、對標指標值管理

14、。對標體系管理：實現管理層分派任務和公司員工接收任務的管理功能。對標指標管理：報表管理：對標評價管理：對標評價參數管理：對標評價算法管理：對標指標值管理：類圖工作任務工作計劃工作日志工作匯報審批計劃審批計劃功能的設計實現，參照類圖：工作計劃。類說明3.2.3.1 工作任務通過ID查詢任務：根據任務ID，得到指定工作任務實體類數據。多條件查詢任務：根據多條件（起始日期、截止日期、任務標題、重要程度、任務狀態 部門、任務接收人）查詢對象，得到工作任務的實體數據。查詢全部任務：執行查詢，獲取全部工作任務的實體數據。增加任務：得到任務實體數據，將數據添加至庫中。暫停任務：對指定的任務，執行暫停處理操作

15、。處理完成任務：對指定的任務，執行完成處理操作。實時檢查收到的新任務或還未做計劃的任務：根據當前的用戶ID，實時檢查目前收到的新任務或還未做計劃的任務，以便系統實時提醒用戶，并彈出提醒信息。此類的說明同上。此類的說明同上。工作任務實體類數據。3.2.3.2 工作計劃通過ID查詢計劃：根據計劃ID，得到指定的工作計劃實體類數據。多條件查詢計劃： 根據多條件 （起始日期、 截止日期、 計劃標題、 計劃類型） 查詢對象， 得到工作計劃實體類數據。查詢全部計劃：執行查詢，得到全部工作計劃的實體類數據。 增加計劃：得到計劃實體數據和所屬任務計劃完成百分比列表，將數據添加至庫中。修改計劃： 計劃未經審批時

16、， 得到修改后的計劃實體數據和所屬任務計劃完成百分比列 表，將數據保存至庫中。寫計劃總結： 某指定的工作計劃結束時， 將總結內容和所屬任務實際完成百分比列表數 據，保存至庫中。處理所屬工作任務完成情況： 寫計劃時或寫總結時， 保存所屬工作任務列表 （包括計劃 或實際完成百分比數據） ，添加至數據庫。查詢所屬任務完成情況：根據指定的工作計劃，查詢其所屬工作任務的完成進度情況。審批計劃： 管理層對某一指定的工作計劃，執行審批處理， 以使審批后的工作計劃不能再進行修改。取消審批： 管理層對某一指定的工作計劃，執行取消審批處理， 以使此工作計劃能進行再修改。實時查詢未審批的工作計劃： 執行查詢未經管理

17、層審批的工作計劃， 得到未審批的工作 計劃實體類數據。當有未審批信息時系統應實時提醒用戶，并彈出提醒信息。多條件查詢已審批的工作計劃：根據多條件（起始日期、截止日期、計劃比他、計劃類 型、創建人）查詢對象，得到管理層已審批過的工作計劃實體類數據。實時查詢他人抄送來的工作計劃：根據當前用戶ID，查詢得到他人抄送給自己的工作計劃實體類數據。當有未閱讀的信息時系統應實時提醒用戶，并彈出提醒信息。處理查看未閱讀的他人抄送的工作計劃：根據工作計劃ID，查看未閱讀的他人抄送給自己的工作計劃實體類數據。此類的說明同上。此類的說明同上。工作計劃實體類數據。3.2.3.3 工作日志通過ID查詢工作日志：根據日志

18、 ID，得到指定的工作日志實體類數據。多條件查詢任務：根據多條件（起始日期、截止日期）查詢對象，得到工作日志實體數 據。查詢全部工作日志：執行查詢，得到全部的工作日志實體類數據。 增加工作日志：得到工作日志實體類數據，將數據添加至庫中。刪除工作日志：根據日志ID，刪除指定的工作日志。實時查詢他人發來的工作日志：根據當前用戶ID，查詢得到他人發來的工作日志實體數據。當有未閱讀的信息時系統應實時提醒用戶，并彈出提醒信息。處理查看未閱讀的他人發來的工作日志：根據工作日志ID，查看未閱讀的他人發來的工作日志實體類數據。此類的說明同上。此類的說明同上。工作日志實體類數據。3.2.3.4 工作匯報通過ID

19、查詢工作匯報：根據工作匯報ID，得到指定的工作匯報實體類數據。多條件查詢工作匯報：根據多條件（起始日期、截止日期）查詢對象，得到工作匯報實 體數據。查詢全部工作匯報：執行查詢，得到全部的工作匯報實體類數據。 增加工作匯報：得到工作匯報實體類數據，將數據添加至庫中。實時查詢員工發來的工作匯報：根據當前用戶ID，查詢得到員工發來的工作匯報實體數據。當有未閱讀的信息時系統應實時提醒用戶，并彈出提醒信息。處理查看未閱讀的員工發來的工作匯報：根據工作匯報ID，查看未閱讀的員工發來的工作匯報實體類數據。此類的說明同上。此類的說明同上。 工作匯報實體類數據。3.2.3.5 審批計劃3.2.4 界面設計我的工

20、作臺子系統頁面包括：工作任務、工作計劃、工作日志、工作匯報、審批計劃五部分。3.2.4.1 工作任務頁面3.2.4.2 工作計劃頁面3.2.4.3 工作日志頁面3.2.4.4 工作匯報頁面3.2.4.5 審批計劃頁面3.3 績效考核模塊3.3.1 模塊說明說明3.3.2 類圖3.3.3 類說明3.3.4 界面設計4 約束和假定描述系統設計中最主要的約束， 這些是由客戶強制要求并在需求說明書寫明的。 說明系 統是如何來適應這些約束的。另外如果本系統跟其它外部系統交互或者依賴其它外部系統提供一些功能輔助，那么系統可能還受到其它的約束。 這種情況下， 要求清楚地描述與本系統有交互的軟件類型（比如某某

21、某數據庫軟件， 某某某 EMail 軟件）以及這樣導致的約束 （比如只允許純文本的 Email ）。實現的語言和平臺也會對系統有約束，同樣在此予以說明。對于因選擇具體的設計實現而導致對系統的約束，簡要地描述你的想法思路，經過怎么樣的權衡，為什么要采取這樣的設計等等。包括運行環境的約束，簡要地說明對本系統的運行環境（包括硬件環境和支持環境）的規定，詳細說明參見附錄 C。5系統數據結構設計5.1邏輯結構設計注：表和表字段命名規范：1. 表名的定義：規范格式：系統名表名（字母全部大寫）比如，工作計劃管理系統中的某個表定義為：WORKPLAN_TASK;2. 表字段的定義：規范格式：表名+字段名稱（首

22、字母大寫），以避免字段重名出現在不同表中。比如，表 WORKPLAN_TASK中的字段標識Id定義為：Taskld ；3. 表字段長度的定義：規范格式：長度一般為 8的整數倍；比如，VARCHAR的長度可為 8或16或24或32或64等；4. 表字段類型為日期型的定義：規范格式：一般日期型的字段設為VARCHAR，且長度一般為24 （已精確到毫秒）5. 公共表名的定義：規范格式：PUBLIC名（字母全部大寫）比如，各個子系統都會用到的公共表，如角色或操作日志表可定義為： PUBLIC_ROLE PUBLIC_OPERATELOG;5.1.1 角色表(PUBLIC_ROLE)字段名稱中文說明鍵別

23、是否 空數據類型長度備注RoleId角色標識IdPKNOVARCHAR32RoleName角色名稱NOVARCHAR32Remark角色說明VARCHAR1285.1.2 權限表(PUBLIC_PRIVILEGE )字段名稱中文說明鍵 別是否空數據類型長度備注Privilege"權限標識IdPKNOVARCHAR32PrivilegeCode權限編碼NOVARCHAR32PrivilegeName權限名稱NOVARCHAR64PrivilegePare ntld上級權限IdVARCHAR32上級權限SystemId權限所屬系統IdFKVARCHAR32權限所屬系統5.1.3 角色權限

24、表(PUBLIC_ROLEPRIVILEGE )字段名稱中文說 明鍵別是否 空數據類型長度備注RoleId角色IDPK，FKNOVARCHAR32角色表外鍵PrivilegeId權限IDPK，FKNOVARCHAR32權限表外鍵5.1.4 部門表(PUBLIC_ DEPT )字段名稱中文說明鍵別是否 空數據類型長度備注Dept Id部門標識IdPKNOVARCHAR32Dept Name部門名稱NOVARCHAR32DeptPare ntld父類部門IdVARCHAR32上一級部門Tel電話VARCHAR32Fax傳真VARCHAR32SortOrder排序INT4Remark備注VARCHA

25、R1285.1.5 崗位表(PUBLIC_POST )字段名稱中文說明鍵別是否 空數據類型長度備注PostId崗位標識IdPKNOVARCHAR32PostName崗位名稱NOVARCHAR32PostPare ntld父類崗位IdVARCHAR32上一級崗位DeptId所屬部門IdFKVARCHAR32部門表外鍵Function崗位職責VARCHAR128SortOrder排序INT45.1.6 員工表(PUBLIC_MEMBER )字段名稱中文說明鍵別是否 空數據類型長度備注Member Id部門標識IdPKNOVARCHAR32JobNumber工號NOVARCHAR32作為系統登錄帳號

26、使用Password登錄密碼NOVARCHAR32MemberName員工姓名NOVARCHAR32DeptId所屬部門IdFKNOVARCHAR32部門表外鍵PostId所屬崗位IdFKNOVARCHAR32崗位表外鍵Sex性別VARCHAR1Tel辦公電話VARCHAR30Mobile手機VARCHAR30Email電子郵箱VARCHAR30Address住址VARCHAR64Remark備注VARCHAR128RoleId所屬角色IdFKNOVARCHAR32角色表外鍵Status帳號狀態NOVARCHAR8狀態如：有效，停用；默認值為有效5.1.7 工作任務表(WORKPLAN_ TA

27、SK )字段名稱中文說明鍵別是否 空數據類型長度備注TaskId任務標識IdPKNOVARCHAR32TaskTile任務標題NOVARCHAR32TaskC ontent任務內容NOVARCHAR1024Level重要程度NOVARCHAR8重要程度“”StartDate任務開始時間NOVARCHAR24En dDate任務完成時間NOVARCHAR24CreatorId創建人IdFKNOVARCHAR32員工表外鍵Status任務狀態NOVARCHAR8狀態如：未完成、暫停、已完 成AddDate創建時間NOVARCHAR245.1.8 任務分派表(WORKPLAN_ ALLOTTASK

28、)字段名稱中文說明鍵別是否空數據類型長度備注AllotId分派標識PKNOVARCHAR32IDTaskld派發的工作任務IdFKNOVARCHAR32工作任務表外鍵Receiverld任務接收人IdFKNOVARCHAR32員工表外鍵Rema in Perce nt任務剩余百分比NOINT4默認為1005.1.9 工作計戈9表(WORKPLAN_ PLAN )字段名稱中文說明鍵別是否 空數據類型長度備注Plan Id任務標識IdPKNOVARCHAR32Pla nType計劃類型NOVARCHAR64計劃類型如：周計劃、月計劃、 年計劃Pla nTitle計劃標題NOVARCHAR32Pla

29、 nTime計劃時間NOVARCHAR32Pla nCo ntent計劃內容NOVARCHAR1024Pla nSum計劃總結VARCHAR1024CreatorId創建人IdFKNOVARCHAR32員工表外鍵AddDate創建時間NOVARCHAR24AuditorId計劃審批人IdFKNOVARCHAR32員工表外鍵IsAudit是否審批NOVARCHAR8是或否，默認值為否5.1.10 計戈U任務表(WORKPLAN_ PLANTASK )字段名稱中文說明鍵別是否 空數據類型長度備注Pla nId計劃標識IdPK，FKNOVARCHAR32AllotId接收的任務標識IdPK，FKNO

30、VARCHAR32Pla nPerce nt任務計劃完成百分比NOINT40到100之間Fini shedPerce nt任務實際完成百分比INT40到100之間5.1.11 工作日志表(WORKPLAN_ WORKLOG )字段名稱中文說明鍵別是否 空數據類型長度備注Log Id工作日志標識IdPKNOVARCHAR32LogI nfo日志記錄NOVARCHAR1024LogSum日志小結VARCHAR1024Creatorld創建人IdFKNOVARCHAR32員工表外鍵AddDate創建時間NOVARCHAR245.1.12 工作匯報表(WORKPLAN_ WORKREPORT )字段名

31、稱中文說明鍵別是否 空數據類型長度備注Report Id匯報標識IdPKNOVARCHAR32ReportTitle標題NOVARCHAR32ReportC ontent內容NOVARCHAR1024CreatorId創建人IdFKNOVARCHAR32員工表外鍵AddDate創建時間NOVARCHAR245.1.13 信息發布表(PUBLIC_ PUBLISHINFO )字段名稱中文說明鍵別是否 空數據類型長度備注Info Id消息標識IdPKNOVARCHAR32Title主題NOVARCHAR32Content內容NOVARCHAR1024CreatorId創建人IdFKNOVARCHA

32、R32員工表外鍵AddDate創建時間NOVARCHAR245.1.14 收件箱表(PUBLIC_INBOX )字段名稱中文說明鍵別是否空數據類型長度備注BoxId標識IDPKNOVARCHAR32In foType信息類型NOVARCHAR24抄送或發送來的信息類型如： 工作計劃、工作日志、工作匯 報、發布的消息等Info Id抄送或發送來 的具體信息IdFKNOVARCHAR32ReceiverId信息接收人IdFKNOVARCHAR32員工表外鍵AddDate接收時間NOVARCHAR24接收信息時間IsRead是否已閱讀NOVARCHAR8是或否，默認值為否5.1.15 系統操作日志表

33、(PUBLIC_OPERATELOG )字段名稱中文說明鍵別是否 空數據類型長度備注Log Id操作日志標識IdPKNOVARCHAR32Operatorld操作員IdFKNOVARCHAR32員工表外鍵SystemModule Id系統模塊IdNOVARCHAR32系統功能模塊表外鍵Action Type動作類型NOVARCHAR8女口：增、刪、改、查等Remark操作說明VARCHAR128OperateTime操作時間NOVARCHAR24個人提醒設置表(PUBLIC_EVENTS )字段名稱中文說明鍵 別是 否 空數據類型長度備注Eve ntsld提醒事件標識IdPKNOVARCHAR32Even tsType提醒類型NOVARCHAR24女:工作任務、工作計劃、工作日志、工作匯報等Even tsTitle主題NOVARCHAR32Even tsC ontent內容NOVARCHAR1024Second秒VARCHAR64Min u