XX信息系統(tǒng)項(xiàng)目概要設(shè)計(jì)說明書

1、XX 信息系統(tǒng)項(xiàng)目設(shè)計(jì)概要說明書模板）建設(shè)單位：XXXXXXXXXXXXX承建單位：XXXXXXXXXXXXX二零二零年十月目錄 TOC o 1-5 h z HYPERLINK l bookmark6 o Current Document 第 1 章 引言 3 HYPERLINK l bookmark8 o Current Document 1.1編寫目的 3 HYPERLINK l bookmark10 o Current Document 1.2項(xiàng)目背景 3 HYPERLINK l bookmark12 o Current Document 1.3定義31.4參考資料 3 HYPERLIN

2、K l bookmark14 o Current Document 第 2 章 總體設(shè)計(jì) 4 HYPERLINK l bookmark16 o Current Document 2.1需求規(guī)定 4基本設(shè)計(jì)概念和處理流程 5 HYPERLINK l bookmark18 o Current Document 2.2.1 設(shè)計(jì)原則和要求 5 HYPERLINK l bookmark20 o Current Document 2.2.2 設(shè)計(jì)概念 5 HYPERLINK l bookmark28 o Current Document 2.3 功能需求與程序的關(guān)系 62.3.1 網(wǎng)格事件 62.3.2

3、 基礎(chǔ)數(shù)據(jù) 7 HYPERLINK l bookmark30 o Current Document 2.3.3 綜合指揮 7 HYPERLINK l bookmark32 o Current Document 2.3.4 決策分析 8 HYPERLINK l bookmark34 o Current Document 第 3 章 接口設(shè)計(jì) 9 HYPERLINK l bookmark36 o Current Document 3.1 用戶接口 93.2 外部接口 9 HYPERLINK l bookmark38 o Current Document 3.2.1 短信接口 9 HYPERLINK

4、 l bookmark40 o Current Document 3.2.2 網(wǎng)絡(luò)傳真 9內(nèi)部接口 10 HYPERLINK l bookmark42 o Current Document 第 4 章 運(yùn)行設(shè)計(jì) 11 HYPERLINK l bookmark44 o Current Document 4.1 運(yùn)行模塊組合 11 HYPERLINK l bookmark46 o Current Document 運(yùn)行控制 11 HYPERLINK l bookmark48 o Current Document 運(yùn)行時(shí)間 11 HYPERLINK l bookmark50 o Current Do

5、cument 第 5 章 系統(tǒng)出錯(cuò)處理設(shè)計(jì) 12 HYPERLINK l bookmark52 o Current Document 出錯(cuò)信息 12補(bǔ)救措施 13 HYPERLINK l bookmark56 o Current Document 5.3系統(tǒng)維護(hù)設(shè)計(jì) 13第1章 引言編寫目的本文檔依照xxxx項(xiàng)目_需求規(guī)格說明書進(jìn)行編寫，目的是 對(duì)該項(xiàng)目進(jìn)行總體設(shè)計(jì)，在明確系統(tǒng)需求的基礎(chǔ)上劃分系統(tǒng)的功能模 塊，進(jìn)行系統(tǒng)開發(fā)的分工，為進(jìn)行后面的詳細(xì)設(shè)計(jì)和實(shí)現(xiàn)做準(zhǔn)備。本文檔的預(yù)期讀者為項(xiàng)目業(yè)主、系統(tǒng)設(shè)計(jì)以及項(xiàng)目其他相關(guān)人員項(xiàng)目背景根據(jù)某社會(huì)應(yīng)急聯(lián)動(dòng)工作機(jī)制及機(jī)制運(yùn)行現(xiàn)狀，結(jié)合當(dāng)前先進(jìn)的 網(wǎng)絡(luò)技術(shù)、

6、計(jì)算機(jī)技術(shù)、移動(dòng)互聯(lián)網(wǎng)技術(shù)等搭建一套貫穿各個(gè)聯(lián)動(dòng)單 位的業(yè)務(wù)平臺(tái)，實(shí)現(xiàn)社會(huì)應(yīng)急聯(lián)動(dòng)指令“一個(gè)平臺(tái)”“、“一呼百應(yīng)”、 “一竿到底”、“一觸即發(fā)“及各類應(yīng)急管理信息大整合的城市應(yīng)急綜 合指揮調(diào)度平臺(tái)。平臺(tái)支持多級(jí)派單，根據(jù)用戶需要，可設(shè)定多個(gè)分 中心，以聯(lián)動(dòng)中心為龍頭，分中心為分支，多級(jí)交辦。定義縮略語(yǔ)，包括本文檔規(guī)定的名詞術(shù)語(yǔ)以及英文縮寫：縮略語(yǔ)說明/定義吃111.4 參考資料序號(hào)文檔名稱文檔編號(hào)作者/修訂者發(fā)布日期出版單位備注1項(xiàng)目投標(biāo)書一一技術(shù)文件2項(xiàng)目開發(fā)合同3各階段討論的會(huì)議紀(jì)要4需求規(guī)格說明書本文檔中直接引用的所有文檔，包括其它相關(guān)文檔、經(jīng)審批的立 項(xiàng)申請(qǐng)表或合同、批文和編制該文檔時(shí)

7、參考的資料、文獻(xiàn)、軟件開發(fā) 標(biāo)準(zhǔn)等。第2章 總體設(shè)計(jì)根據(jù)某社會(huì)應(yīng)急聯(lián)動(dòng)工作機(jī)制及機(jī)制運(yùn)行現(xiàn)狀，結(jié)合當(dāng)前先進(jìn)的 網(wǎng)絡(luò)技術(shù)、計(jì)算機(jī)技術(shù)、移動(dòng)互聯(lián)網(wǎng)技術(shù)等搭建一套貫穿各個(gè)聯(lián)動(dòng)單 位的業(yè)務(wù)平臺(tái)，實(shí)現(xiàn)社會(huì)應(yīng)急聯(lián)動(dòng)指令“一個(gè)平臺(tái)”“、“一呼百應(yīng)”、 “一竿到底”、“一觸即發(fā)“及各類應(yīng)急管理信息大整合的城市應(yīng)急綜 合指揮調(diào)度平臺(tái)。平臺(tái)支持多級(jí)派單，根據(jù)用戶需要，可設(shè)定多個(gè)分 中心，以聯(lián)動(dòng)中心為龍頭，分中心為分支，多級(jí)交辦。平臺(tái)以指揮調(diào)度為中心，依靠短信指令、網(wǎng)絡(luò)派單等方式，建立 安全、快速、高效的應(yīng)急指揮體系，以應(yīng)急預(yù)案庫(kù)、應(yīng)急專家?guī)旌蛻?yīng) 急知識(shí)庫(kù)等為輔助，借助 GIS 平臺(tái)進(jìn)一步實(shí)現(xiàn)可視化調(diào)度、扁平化指

8、揮。需求規(guī)定需求包括聯(lián)動(dòng)門戶網(wǎng)站、接警受理子系統(tǒng)相關(guān)平臺(tái)的建設(shè)需求，具體可見某公安分局應(yīng)急聯(lián)動(dòng)子系統(tǒng)需求規(guī)格說明書V1.0.0。設(shè)計(jì)原則和要求程序中各模塊間相互獨(dú)立，但有公共接口供其它模塊訪問，其它 不公開的數(shù)據(jù)嚴(yán)格封閉；當(dāng)某一個(gè)模塊中出現(xiàn)不能解決的異常須彈出 錯(cuò)誤信息；系統(tǒng)中的部分內(nèi)置矩陣可以在后期維護(hù)過程中根據(jù)需求進(jìn) 行更改。設(shè)計(jì)概念Cas 單點(diǎn)認(rèn)證平臺(tái)：Cas是業(yè)界最常用的可靠的單點(diǎn)登錄解決方法，本系統(tǒng)所有應(yīng)用 全部通過 Cas 實(shí)現(xiàn)統(tǒng)一認(rèn)證。 TGT 是 CAS 為用戶簽發(fā)的“總的”登 錄票據(jù)。擁有了 TGT,用戶就可以證明自己在CAS成功登錄過。TGT 相當(dāng)于你的護(hù)照，擁有了護(hù)照就能

9、證明你的身份。 TGT 的本質(zhì)就是 Cookie。用戶在CAS認(rèn)證成功后，CAS生成cookie，寫入瀏覽器，同 時(shí)生成一個(gè)TGT對(duì)象，放入CAS服務(wù)器端的緩存中。當(dāng)客戶端瀏覽 器再次請(qǐng)求時(shí)，會(huì)提交 cookie，CAS 以此 cookie 值為 key 查詢 CAS 服務(wù)器中有無(wú)對(duì)應(yīng)的 TGT ，如果有的話，則說明用戶之前登錄過， 如果沒有，則用戶需要重新登錄。ST是CAS為用戶簽發(fā)的訪問某一 應(yīng)用服務(wù)（Service）的票據(jù)，例如用戶要訪問OA, CAS就會(huì)給用戶 簽發(fā)訪問 OA 的 ST。 ST 有點(diǎn)類似于簽證，在護(hù)照上加蓋一個(gè)簽證的 鋼印，就允許你進(jìn)入某個(gè)國(guó)家了，否則光有一張護(hù)照還是不

10、行的。用 戶訪問Service時(shí)，系統(tǒng)如果發(fā)現(xiàn)用戶沒有ST，則要求用戶去CAS獲 取ST。用戶向CAS發(fā)出獲取ST的請(qǐng)求，如果用戶的請(qǐng)求中包含CAS 服務(wù)器的cookie，則CAS會(huì)以此cookie值為key查詢緩存中有無(wú) TGT，如果存在TGT，則用此TGT簽發(fā)一個(gè)ST，返回給用戶。用戶憑 借 ST 去訪問 service， service 拿 ST 去 CAS 驗(yàn)證，驗(yàn)證通過后，允許 用戶訪問資源。統(tǒng)一管理中心：為集團(tuán)的部門、用戶、權(quán)限、應(yīng)用管理提供一站式解決方案，提 供統(tǒng)一日志服務(wù)，簡(jiǎn)化各個(gè)平臺(tái)組織架構(gòu)、權(quán)限等配置管理。協(xié)同辦公平臺(tái)：以公文管理為核心，以日常管理、事務(wù)審批等功能模塊為輔，

11、提 供便捷高效的日常辦公平臺(tái)。移動(dòng)門戶：通過目前主流平臺(tái)andriod、ios、window，在手機(jī)和平板上實(shí)現(xiàn) 移動(dòng)辦公平臺(tái)全覆蓋，不僅實(shí)現(xiàn)日常辦公平臺(tái)，更提供即時(shí)通訊相關(guān) 功能，使得辦公、溝通更為順暢。即時(shí)通訊：平臺(tái)界面設(shè)計(jì)簡(jiǎn)潔，提供良好的用戶體驗(yàn)，集成了組織架構(gòu)、即 時(shí)通訊、文件傳輸、語(yǔ)音視頻、遠(yuǎn)程協(xié)助、公告通知等功能，開放式 的應(yīng)用中心，用戶可自行集成自己的應(yīng)用，為企業(yè)提供了一站式入口。功能需求與程序的關(guān)系程序 需求網(wǎng) 格 員專 職 網(wǎng) 格 員兼 職 網(wǎng) 格 員網(wǎng)格長(zhǎng)網(wǎng) 格 支 部 書 記社 區(qū) 管 理 員社 區(qū) 業(yè) 務(wù) 處 理街 道 管 理 員街 道 業(yè) 務(wù) 處 理 員區(qū) 級(jí) 管 理

12、 員區(qū) 級(jí) 業(yè) 務(wù) 處 理 員管 理 員系 統(tǒng) 管 理 員參數(shù) 配 置日 志 生 成日 志 查 詢數(shù) 據(jù) 交 換網(wǎng)格自動(dòng)識(shí)別VVVVVVVVVVVV簽收管理VVVV自動(dòng)下派VVV事件延期VVV超時(shí)配置VVV事件標(biāo)記功能VVVX示維護(hù)表卷?yè)Q出數(shù)據(jù)比對(duì)VVVVVVVVV注冊(cè)接口VV全科采集VV分級(jí)走訪V問卷調(diào)查VVV決策分析VV綜合指揮程序需求問題事件個(gè)體工商戶機(jī)關(guān)單位事業(yè)單位社團(tuán)組織場(chǎng)所信息即時(shí)通訊VVVVV信息上圖V網(wǎng)格區(qū)劃V決策分析 程序1 1 需 求待 辦 查 詢已 辦 查 詢緩 辦 查 詢回 收 站關(guān)注 提 醒日志填寫日 志 查 看計(jì) 劃 查 看計(jì) 劃 填 寫領(lǐng) 導(dǎo) 日 程便簽 維 護(hù)工

13、作 交 接交 接 清 單 查 詢流程 監(jiān) 控首 頁(yè) 元 件 配 置快 捷 菜 單 配 置我 的 意 見 配 置個(gè)性 簽 名 配 置常 用 聯(lián) 系 人 配 置短 信 常 用 語(yǔ) 配 置秘 書 代 登 配 置流 程 代 理 人 配 置問 題 反 饋 登 記問 題 反 饋 查 詢事件來源統(tǒng)計(jì)VVVV第3章 接口設(shè)計(jì)用戶接口在用戶界面部分，根據(jù)需求分析結(jié)果，用戶需要一個(gè)友善的界面。 在界面設(shè)計(jì)上，應(yīng)該做到簡(jiǎn)單明了，易于操作，并且要注意到界面的 布局，應(yīng)突出的顯示重要的功能以及出錯(cuò)信息。接口方面，各模塊之間采用函數(shù)調(diào)用、參數(shù)傳遞、返回值的方式進(jìn)行信息傳遞。接口傳遞的信息將是以數(shù)據(jù)結(jié)構(gòu)封裝了的數(shù)據(jù)，以參數(shù)

14、傳遞或返回值的形式在各個(gè)模塊之間傳輸。外部接口短信接口系統(tǒng)短信收發(fā)的功能由移動(dòng)提供相關(guān)接口，系統(tǒng)調(diào)用移動(dòng)提供的webservice,地址為 HYPERLINK http:/X.X.X.X/webservice/services/sendmsg http:/X.X.X.X/webservice/services/sendmsg（ip 為企業(yè)短信接入服務(wù)器 ip）。功能接口名稱、說明短信發(fā)送sendmsg短信接收deliver具體的實(shí)現(xiàn)用例及webservice說明文檔參考移動(dòng)提供的java 調(diào)用webservice接口-示例、Webservice接口網(wǎng)絡(luò)傳真接口協(xié)議：HTTP；數(shù) 據(jù) 格 式 ：

15、 http:/ bnetaccount =& useraccount 二value&；詳細(xì)說明：客戶端調(diào)用此接口通知服務(wù)端要使用網(wǎng)絡(luò)傳真產(chǎn)品， 網(wǎng)絡(luò)傳真根據(jù)傳遞的參數(shù)驗(yàn)證其合法性，若合法則通過進(jìn)入使用頁(yè)面 否則跳出相應(yīng)的錯(cuò)誤提示。具體的接口參數(shù)說明參考電信提供的ECP &網(wǎng)絡(luò)傳真接口規(guī)范1.1。3.3 內(nèi)部接口移動(dòng)門戶：移動(dòng)門戶的日常辦公的相關(guān)接口由 OA 提供，微消息的接口 由即時(shí)通訊平臺(tái)提供，所以接口統(tǒng)一以 webservice 的形式進(jìn)行發(fā)布。 移動(dòng)門戶基于公司的移動(dòng)中間平臺(tái)，根據(jù)不同的操作，調(diào)用不同的接 口，相關(guān)接口見下面列表，具體的接口參數(shù)及返回值格式見數(shù)字城 投（一期）業(yè)務(wù)系統(tǒng)及支

16、撐平臺(tái)詳細(xì)設(shè)計(jì)（統(tǒng)一管理中心、集團(tuán)內(nèi)網(wǎng) 門戶、協(xié)同辦公系統(tǒng)）。功能接口名稱數(shù)據(jù)同步Address_GetAllOUCount、 Address_GetAllUserList用戶登錄User_Getlnfo待辦公文列表Handle_GetUnHandleList、待辦公文查看Handle_GetArchive公文處理過程Handle_PostAud itOpinion信息欄目列表WebInfo_GetCateGory信息明細(xì)WebInfo_GetDetail會(huì)議接口Meeting_Message計(jì)劃總結(jié)Schedule_GetList添加日程Schedule_Add即時(shí)通訊:即時(shí)通訊需提供一些接

17、口供其它系統(tǒng)進(jìn)行調(diào)用，如統(tǒng)一管理中心需要調(diào)用即時(shí)通訊的接口進(jìn)行組織架構(gòu)的同步、OA需要調(diào)用接口進(jìn)行待辦事宜的推送、移動(dòng)門戶需要調(diào)用 接口實(shí)現(xiàn)微消息的相關(guān)功能等，即時(shí)通訊提供的接口以 webservice 形式發(fā)布，目前需要提供的接口見下面列表，具體的接口參數(shù)及返回值格式見數(shù)字城投（一期）業(yè)務(wù)系統(tǒng)及支撐平臺(tái)詳細(xì)設(shè)計(jì)（統(tǒng)一管理中心、集團(tuán)內(nèi)網(wǎng)門戶、協(xié)同辦公系統(tǒng)）。功能接口名稱添加賬號(hào)AddUser刪除賬號(hào)RemoveUser修改帳號(hào)ModifyUser獲取帳號(hào)信息GetUser更改登錄密碼ChangePassword驗(yàn)證登錄令牌ValidateToken發(fā)送系統(tǒng)消息SendSysMsg第4章 運(yùn)行設(shè)

18、計(jì)運(yùn)行模塊組合本程序主要是以一個(gè)窗口為模塊，一般一個(gè)窗口完成一個(gè)特定的 功能，主窗口通過打開另一個(gè)子窗口來實(shí)現(xiàn)各模塊之間不同功能的連 接和組織，各模塊之間相互獨(dú)立，程序的可移植性好，各模塊之間主 要以傳遞數(shù)據(jù)項(xiàng)的方式來實(shí)現(xiàn)模塊之間的合作和數(shù)據(jù)共享。運(yùn)行控制只要符合操作說明書，用戶可自由控制，不額外限定用戶輸入， 異常在程序內(nèi)部進(jìn)行處理，給出相應(yīng)的提示信息。運(yùn)行時(shí)間簡(jiǎn)單的查詢和報(bào)表生成平均響應(yīng)時(shí)間在 2 秒以內(nèi)，最大響應(yīng)時(shí)間 不超過 10 秒；復(fù)雜報(bào)表生成和一般的分析統(tǒng)計(jì)平均響應(yīng)時(shí)間在 10 秒 以內(nèi)，最大響應(yīng)時(shí)間不超過 20 秒；復(fù)雜的分析應(yīng)用平均響應(yīng)時(shí)間在 30 秒以內(nèi)，最大響應(yīng)時(shí)間不超過6

19、0 秒；所有客戶端的操作應(yīng)無(wú)明顯 的等待時(shí)間。第5章 系統(tǒng)出錯(cuò)處理設(shè)計(jì)出錯(cuò)信息統(tǒng)一管理中心、內(nèi)網(wǎng)門戶、協(xié)同辦公系統(tǒng)：利用 log4j/log4net 提供的錯(cuò)誤處理機(jī)制，在程序任何可能出錯(cuò) 的地方設(shè)置錯(cuò)誤捕獲和處理程序，對(duì)因用戶操作不當(dāng)導(dǎo)致的錯(cuò)誤，系 統(tǒng)能積極防止并給出適當(dāng)?shù)腻e(cuò)誤提示。確保系統(tǒng)不因?yàn)槌鲥e(cuò)而意外終 止，確保系統(tǒng)中的數(shù)據(jù)不因?yàn)槌鲥e(cuò)處理不當(dāng)而被破壞或丟失。即時(shí)通訊：利用 Delphi 異常處理機(jī)制，在程序任何可能拋出異常的地方設(shè) 置捕獲和處理程序。對(duì)于因用戶非法操作而導(dǎo)致的異常，及時(shí)給出提 示或者禁止此處操作。對(duì)于系統(tǒng)自身的異常信息一方面記錄在日志文 件中，供開發(fā)人員定位程序問題，另

20、一方面也會(huì)適時(shí)給出錯(cuò)誤提示信 息，確保系統(tǒng)穩(wěn)定運(yùn)行。所有業(yè)務(wù)系統(tǒng)的日志在統(tǒng)一管理中心可以進(jìn)行查看。系統(tǒng)出錯(cuò)信息處理方法統(tǒng)一管理中心、協(xié)同 辦公系統(tǒng)、內(nèi)網(wǎng)門戶系統(tǒng)報(bào)錯(cuò)頁(yè)面由維護(hù)人員查看程序日志記錄，找出報(bào)錯(cuò) 的操作，查看錯(cuò)誤原因，并針對(duì)該錯(cuò)誤進(jìn)行 修改系統(tǒng)錯(cuò)誤提示當(dāng)用戶輸入信息不符規(guī)范時(shí)，系統(tǒng)給出統(tǒng)一友好提示，用戶根據(jù)提示調(diào)整輸入信息系統(tǒng)黃頁(yè)由維護(hù)人員查看后臺(tái)程序日志文件信息，找出報(bào)錯(cuò)程序位置，即時(shí)處理404由維護(hù)人員確認(rèn)相關(guān)頁(yè)面路徑是否配置正 常，即時(shí)調(diào)整頁(yè)面路徑500由實(shí)施或開發(fā)人員確認(rèn)服務(wù)器是否正常工 作，應(yīng)用程序池是否啟動(dòng)，即時(shí)進(jìn)行調(diào)整移動(dòng)門戶導(dǎo)致程序崩 潰的異常，程 序會(huì)黑屏，卡 死或

21、者直接 退出將該異常信息、設(shè)備信息、用戶信息以及發(fā) 生的時(shí)間通過接口發(fā)送給服務(wù)器保存至中 間管理平臺(tái)，由開發(fā)人員或者實(shí)施人員登 錄中間管理平臺(tái)查看錯(cuò)誤日志找出原因進(jìn) 行修復(fù)導(dǎo)致界面數(shù) 據(jù)錯(cuò)誤的異 常，界面沒有 明顯的錯(cuò)誤 或者會(huì)彈出 錯(cuò)誤提醒登錄時(shí)，提示連接超時(shí)首先確認(rèn)移動(dòng)端網(wǎng)絡(luò)是否正常，若移動(dòng)網(wǎng) 絡(luò)正常，則由維護(hù)人員整理移動(dòng)中間平臺(tái)、 移動(dòng)OA相關(guān)接口能否正常訪問即時(shí)通訊統(tǒng)一錯(cuò)誤提示窗體友好提示由用戶自行處理，系統(tǒng)錯(cuò)誤由開發(fā)人員定位程序代碼，修改并更新統(tǒng)一錯(cuò)誤報(bào)告由開發(fā)人員查看相關(guān)日志文件信息，定位程序代碼，修改并更新5.2 補(bǔ)救措施1、通過設(shè)置相關(guān)應(yīng)用服務(wù)的開機(jī)自動(dòng)重啟，當(dāng)服務(wù)器出現(xiàn)異常

22、關(guān)閉，重啟服務(wù)器后，所有應(yīng)用能夠自動(dòng)重啟，無(wú)需再做其它操作， 就可以訪問相關(guān)應(yīng)用；2、通過數(shù)據(jù)庫(kù)的每天定時(shí)備份，當(dāng)原始系統(tǒng)的數(shù)據(jù)丟失時(shí)，可 以通過備份數(shù)據(jù)進(jìn)行恢復(fù)。系統(tǒng)維護(hù)設(shè)計(jì)1、 系統(tǒng)日志監(jiān)控 系統(tǒng)的所有關(guān)鍵操作、訪問、錯(cuò)誤信息統(tǒng)一調(diào)用基礎(chǔ)框架提供的相 關(guān)方法，通過框架的方法存儲(chǔ)在數(shù)據(jù)庫(kù)里，同時(shí)提供相應(yīng)的查看頁(yè)面用 于查看所有記錄。2、 常見配置文件的維護(hù)系統(tǒng)基礎(chǔ)配置文件為web.config,包括了下面幾個(gè)基本配置，cas 單點(diǎn)登錄的相關(guān)配置： 數(shù)據(jù)庫(kù)連接字符串，設(shè)置數(shù)據(jù)庫(kù)地址、用戶名、密碼等： 其它參數(shù)配置，如存儲(chǔ)附件的文件夾地址、是否自動(dòng)遷移日志等： add key二A tt achFileS to rage value二D框架trunkEpointFrameBigFileUpLoadStorage /add key=SuperPasswordValue value=XXXXX /add key二NewWa it HandleSpecial value二辦理/add key=EpointUserManageServiceUrl value= HYPERLINK http:/X.X.X.X/EpointNetoffice7 http:/X.X.X.X/EpointNeto