第二講：研發(fā)項目概要設計說明書模板講解與案例分析 V1

研發(fā)項目需求、概設說明書模板講解與案例分析北京合眾偉奇科技有限公司設計部王亮（第二講）目錄CONTENTPART

ONEPART

TWOPART

THREEPART

FOUR預備知識概設模板編寫原則案例分析北京合眾偉奇科技有限公司PART

ONE預備知識北京合眾偉奇科技有限公司PARTONE數(shù)據(jù)庫基礎DBMS基礎主鍵

指的是一個列或多列的組合，其值能唯一地標識表中的每一行，通過它可強制表的實體完整性。主鍵主要是用于其他表的外鍵關聯(lián)，以及本記錄的修改與刪除。外鍵

外鍵表示了兩個關系之間的相關聯(lián)系。以另一個關系的外鍵作主關鍵字的表被稱為主表，具有此外鍵的表被稱為主表的從表。外鍵又稱作外關鍵字。實體

是客觀存在并可相互區(qū)別的事物。就數(shù)據(jù)庫而言，實體往往指某類事物的集合。把每一類數(shù)據(jù)對象的個體稱為實體。關系

主要有：1對1、1對多、多對多。三種關系類型。

DBMS是DataBaseManagementSystem的首字母縮寫，中文全稱“數(shù)據(jù)庫管理系統(tǒng)”。是處理數(shù)據(jù)庫訪問的軟件，提供數(shù)據(jù)庫的用戶接口。

DBMS的目的：提供一個可以方便地、有效地存取數(shù)據(jù)庫信息的環(huán)境。PARTONE數(shù)據(jù)庫基礎文件管理系統(tǒng)（FMS）與數(shù)據(jù)庫管理系統(tǒng)（DBMS）文件系統(tǒng)數(shù)據(jù)庫管理系統(tǒng)文件系統(tǒng)用文件將數(shù)據(jù)長期保存在外存上數(shù)據(jù)庫系統(tǒng)用數(shù)據(jù)庫統(tǒng)一存儲數(shù)據(jù)文件系統(tǒng)中的程序和數(shù)據(jù)有一定的聯(lián)系數(shù)據(jù)庫系統(tǒng)中的程序和數(shù)據(jù)分離文件系統(tǒng)用操作系統(tǒng)中的存取方法對數(shù)據(jù)進行管理數(shù)據(jù)庫系統(tǒng)用DBMS統(tǒng)一管理和控制數(shù)據(jù)文件系統(tǒng)實現(xiàn)以文件為單位的數(shù)據(jù)共享數(shù)據(jù)庫系統(tǒng)實現(xiàn)以記錄和字段為單位的數(shù)據(jù)共享二者的共同點均為數(shù)據(jù)組織的管理技術均由數(shù)據(jù)管理軟件管理數(shù)據(jù)，程序與數(shù)據(jù)之間用存取方法進行轉(zhuǎn)換數(shù)據(jù)庫系統(tǒng)是在文件系統(tǒng)的基礎上發(fā)展而來的

PowerDesigner是Sybase的企業(yè)建模和設計解決方案，采用模型驅(qū)動方法，將業(yè)務與IT結合起來，可幫助部署有效的企業(yè)體系架構，并為研發(fā)生命周期管理提供強大的分析與設計技術。PowerDesigner將多種標準數(shù)據(jù)建模技術（UML、業(yè)務流程建模以及市場領先的數(shù)據(jù)建模）集成一體，并與.NET、WorkSpace、PowerBuilder、Java?、Eclipse等主流開發(fā)平臺集成起來，為軟件開發(fā)周期管理提供業(yè)務分析和規(guī)范的數(shù)據(jù)庫設計解決方案。此外，它支持60多種RDBMS版本。PARTONEPowerDesigner基礎PowerDesignerCDM表現(xiàn)數(shù)據(jù)庫的全部邏輯結構,與任何的軟件或數(shù)據(jù)儲藏結構無關。是最終用戶對數(shù)據(jù)存儲的看法，反映用戶的綜合性信息需求。CDM是適合于系統(tǒng)分析階段的工具。概念模型LDM幫助分析信息系統(tǒng)的結構，獨立于任何具體物理數(shù)據(jù)庫實現(xiàn)。已經(jīng)涉及到實體的標識符，但沒有CDM那么抽象，并不允許設計視圖、索引和其他更具體的物理數(shù)據(jù)模型元素。邏輯模型PDM幫助分析表、視圖、和其他數(shù)據(jù)庫對象，包括數(shù)據(jù)倉庫所需的多維度對象。PDM比CDM和LDM都更為具體?？梢赃M行建模、逆向工程、和生成所有最為流行的數(shù)據(jù)庫物理模型PARTONEPowerDesigner基礎為什么要用LDMLDM能夠清晰表示實體及實體間的關系：1對1、1對多、多對多。比PDM更適合用到設計文檔中PDMLDMCDM、LDM、PDM相互轉(zhuǎn)換轉(zhuǎn)換CDM快捷鍵：Ctrl+Shift+C轉(zhuǎn)換LDM快捷鍵：Ctrl+Shift+L轉(zhuǎn)換PDM快捷鍵：Ctrl+Shift+PPARTONEPowerDesigner基礎PARTONE總體架構圖的由來總體架構圖的由來

一般基于當前項目的基礎項目平臺架構繪制。例如：現(xiàn)場作業(yè)終端安全管理平臺基于“閉環(huán)管理”的基礎平臺架構繪制。PARTONE概設說明書的必要性概設說明書的用途降低溝通成本，提高溝通準確率，改善團隊協(xié)作效率項目管理過程控制的依據(jù)編寫測試用例的基礎指導開發(fā)活動的重要資料設計文檔與測試用例的關系管理過程知識積累的重要資料PARTTWO概設模板北京合眾偉奇科技有限公司PARTTWO概設說明書總目標確保工作經(jīng)驗少的開發(fā)人員能夠輕松看懂，并依照概要設計文檔進行開發(fā)工作PARTTWO填寫概設說明書模板的思路（口訣）概述主要內(nèi)容包括：項目背景、編寫目的、編寫原則、術語定義。開宗明義先概述總體設計主要內(nèi)容包括：設計目標、技術路線、系統(tǒng)架構（含：總體架構、功能架構）總體設計分三步概設說明書的組件章節(jié)分類：功能界面控制組件（UIC）、功能邏輯組件（LC）。其中，功能界面控制組件（UIC）：用于說明系統(tǒng)界面、交互流程及約束等內(nèi)容；功能邏輯組件（LC）：用于說明支撐“功能界面控制組件”所需的邏輯功能組件?？刂?邏輯辨分明概設說明書功能層級劃分：分為三層，即，【模塊】、【組件】、【子組件】。示例：UIC01、UIC01_01、UIC01_01_01功能層級全理清UIC與LC對應關系要明確：一般地，UIC中包含的子組件及其交互流程定義，必然對應的有相關LC子組件提供的邏輯功能支撐。對應關系要確定接口定義及調(diào)用：要明確接口定義及相關調(diào)用過程。調(diào)用脈絡需暢通123456PARTTWO概要設計說明書文檔結構重點注意事項：模板中的文檔結構不允許隨意刪除。如需修改，先上報到部門，經(jīng)部門評審通過后，由部門反饋到質(zhì)管部統(tǒng)一更新、維護、發(fā)布文檔模板PARTTWO模板文檔結構定義概設說明書文檔結構【編寫內(nèi)容】在此處描述項目背景信息，例如項目來源、建設現(xiàn)狀、存在問題、必要性說明等內(nèi)容?！菊母袷健恳螅菏仔锌s進2字符，宋體，小四，行距1.5【描述方法】整段描述

計量防護計量箱管理平臺通過在WEB端搭建計量防護計量箱管理系統(tǒng)和掌機計量箱管理APP的方式實現(xiàn)了對智能計量箱的精細化檔案管理和運行情況監(jiān)控業(yè)務，實現(xiàn)了針對專變用戶智能計量箱的在線狀態(tài)及開關鎖監(jiān)控、竊電分析、溫濕度情況、遠程調(diào)試等業(yè)務需求。智能計量箱防護系統(tǒng)二期建設內(nèi)容包含：計量箱檔案管理、計量箱遠程調(diào)試、計量箱在線監(jiān)控、計量箱異常事件分析、溫濕度變化曲線、實時數(shù)據(jù)采集、數(shù)據(jù)召測等功能。PARTTWO模板文檔結構定義概設說明書文檔結構【編寫內(nèi)容】編寫這份概要設計說明書的目的、適用范圍。如不存在集成設計或安全設計需在此處說明?！菊母袷健恳螅菏仔锌s進2字符，宋體，小四，行距1.5【描述方法】<序號>、<目的描述>1.2.1目的

本文旨在對計量防護計量箱管理系統(tǒng)進行總體規(guī)劃設計，其目的在于對系統(tǒng)總體架構、系統(tǒng)功能架構、功能界面控制組件、功能邏輯組件、業(yè)務組件的輸入/輸出接口、數(shù)據(jù)的邏輯模型等全局特征進行描述，確保開發(fā)團隊在特定技術環(huán)境下滿足功能需求和非功能需求。1.2.2使用范圍本階段對計量防護計量箱管理系統(tǒng)作概要設計。主要解決實現(xiàn)該系統(tǒng)需求的程序模塊設計問題。包括如何把該系統(tǒng)劃分成若干個模塊、決定各個模塊之間的接口、模塊之間傳遞的信息，以及數(shù)據(jù)結構、模塊結構的設計等。在詳細設計階段軟件，設計人員可參考此說明書中所做的模塊結構設計，對系統(tǒng)進行詳細設計。在軟件測試和軟件維護階段，測試人員可參考此說明書，了解概要設計過程中所完成的各模塊設計結構。當項目出現(xiàn)偏差時，參考此說明書找出項目過程中存在的不足或錯誤。PARTTWO模板文檔結構定義概設說明書文檔結構【編寫內(nèi)容】在此處說明文檔的編寫要求，非系統(tǒng)建設原則。例如：1、文檔僅限四級標題?！菊母袷健恳螅菏仔锌s進2字符，宋體，小四，行距1.5【描述方法】<序號>、<目的描述>PARTTWO模板文檔結構定義概設說明書文檔結構【編寫內(nèi)容】在此處說明文檔的術語定義。例如：1、業(yè)務架構：是信息化總體架構的起點，業(yè)務架構定義了在總體企業(yè)戰(zhàn)略指導下希望實現(xiàn)的業(yè)務能力及其關系。【正文格式】要求：首行縮進2字符，宋體，小四，行距1.5【描述方法】<序號>、<術語名稱>：<術語描述>序號術語名稱術語描述1計量防護計量箱管理系統(tǒng)該項目的web端管理系統(tǒng)，文中簡稱“管理系統(tǒng)”2智能計量箱管理APP該項目的APP客戶端，文中簡稱“APP”3智能計量箱該項目的管理對象為專變用戶的智能計量箱，低壓普通用戶的普通計量箱不在該項目管理范圍，文中簡稱“計量箱”PARTTWO模板文檔結構定義概設說明書文檔結構【編寫內(nèi)容】在此處言簡意賅的說明本系統(tǒng)的設計目的。【正文格式】要求：首行縮進2字符，宋體，小四，行距1.5【描述方法】<序號>、<目標描述>系統(tǒng)建設從終端、系統(tǒng)、應用和數(shù)據(jù)著手，建設完成達到以下4目標：目標一：實現(xiàn)對智能計量箱檔案的精細化管理，所有智能計量箱檔案登記在冊，精確管理維護計量箱與SIM卡的綁定關系、計量箱與電能表的綁定關系。目標二：實現(xiàn)對計量箱的實時在線監(jiān)控及遠程調(diào)試，對問題計量箱及時發(fā)現(xiàn)、及時處理，確保計量箱運行質(zhì)量，提高運維效率。目標三：實現(xiàn)對計量箱異常事件的監(jiān)控分析能力，對常見的異常事件如開關鎖、磁場異常、疑似竊電、溫濕度越限等實現(xiàn)實時跟蹤和分析，及時定位問題處理問題。提升計量箱運行的安全性、采集數(shù)據(jù)的準確性防止竊電行為的發(fā)生。目標四：開通智能計量箱管理的掌機APP應用，實現(xiàn)對智能計量箱的現(xiàn)場標準化作業(yè)技術支撐。PARTTWO模板文檔結構定義概設說明書文檔結構分類選型原則技術選型界面展現(xiàn)技術：HTML、JSP、Flex、JavaScript服務器開發(fā)技術：JDK1.5、JavaEE5.0數(shù)據(jù)訪問技術：JDBC部署模式公司總部與?。ㄊ校┕緝杉壊渴痖_發(fā)平臺國家電網(wǎng)公司統(tǒng)一應用平臺中間件應用服務器：Weblogic分析決策工具：CognosETL工具：Informatica數(shù)據(jù)倉庫、數(shù)據(jù)集市：SybaseIQ流程監(jiān)控：國家電網(wǎng)公司BAM流程集成：國家電網(wǎng)公司BPM企業(yè)服務總線：OSB數(shù)據(jù)庫Oracle10g操作系統(tǒng)Windows、Linux、UnixPARTTWO模板文檔結構定義概設說明書文檔結構分類選型原則技術選型界面展現(xiàn)技術：HTML、JSP、JavaScript服務器開發(fā)技術：JDK1.6數(shù)據(jù)訪問技術：JNDIAPP開發(fā)技術：AndroidSDK（版本4.0以上）部署模式省級部署開發(fā)平臺SSI中間件應用服務器：Weblogic消息服務：ActiveMQ數(shù)據(jù)庫Oracle11g操作系統(tǒng)Linux、Android（版本4.0以上）PARTTWO模板文檔結構定義概設說明書文檔結構PARTTWO模板文檔結構定義概設說明書文檔結構PARTTWO模板文檔結構定義概設說明書文檔結構PARTTWO模板文檔結構定義概設說明書文檔結構組件編號/組件名稱組件說明UIC01_001/登錄本組件是對用戶的登錄信息進行驗證和進行記住用戶名操作。UIC01_002/終端信息本組件是對設備檔案信息和掌機監(jiān)控數(shù)據(jù)進行管理，包含設備清單、智能卡檔案管理、SIM卡檔案管理、掌機監(jiān)控管理四個子組件。UIC01_003/采集規(guī)則本組件是對終端設備進行數(shù)據(jù)采集規(guī)則項的配置和展示。UIC01_004/告警管理本組件是對告警規(guī)則進行配置，和對告警記錄進行處理，包含：告警規(guī)則和告警記錄兩個子組件。UIC01_005/標準庫管理本組件是對標準庫進行管理，一期包含應用庫管理一個子組件。UIC01_006/系統(tǒng)管理本組件是對系統(tǒng)進行配置和管理，包含機構人員管理、角色管理、權限管理和資源管四個子組件。UIC02_001/安全中心（APP）本組件是一個安裝在掌機上的APP，該APP隨掌機啟動，為終端設備提供監(jiān)控服務、告警管理、清理加速、安全檢測等功能PARTTWO模板文檔結構定義概設說明書文檔結構業(yè)務項需求功能模塊界面控制組件備注BM08_001_001/需求計劃管理F03_001/編制年度需求計劃UIC01_001_001/編制年度需求計劃

………………PARTTWO模板文檔結構定義概設說明書文檔結構填寫后的效果PARTTWO模板文檔結構定義概設說明書文檔結構

該組件是對終端設備信息進行展示，主要包含：設備列表、設備概況、安裝應用詳情、設備性能監(jiān)控、未處理告警、流量監(jiān)控等六個子組件PARTTWO模板文檔結構定義概設說明書文檔結構PARTTWO模板文檔結構定義概設說明書文檔結構子組件組件描述UIC01_002_001/設備列表本組件提供終端信息查詢、導出功能。UIC01_002_002/設備概況本組件展示終端外觀圖片、檔案信息、智能卡信息、SIM卡信息以及設備狀態(tài)。UIC01_002_003/安裝應用詳情本組件展示終端安裝的應用列表及應用卸載功能。UIC01_002_004/設備性能監(jiān)控本組件展示過去24小時終端的CPU使用率、內(nèi)存使用率、電池溫度的折線圖信息。UIC01_002_005/未處理告警本組件展示終端設備未處理的告警的列表以及處理告警信息的功能。UIC01_002_006/流量監(jiān)控本組件展示終端設備中過去24小時SIM卡的發(fā)送流量、接收流量、總流量的折線圖信息。PARTTWO模板文檔結構定義概設說明書文檔結構組件名稱UIC01_002_001/設備列表英文名UIC_HandSetInfo組件說明本組件提供終端信息查詢、導出功能。原型圖約束無方法交互場景設計初始化1．顯示終端信息列表。其中展示屬性包含：終端資產(chǎn)編號、終端序列號、終端類別、終端廠家、終端型號、子型號、在線狀態(tài)、領用人和數(shù)據(jù)來源。2．查詢條件下拉選項為默認狀態(tài)“全部”。3．關鍵字輸入框為空。查詢輸入查詢條件。點擊“查詢”，顯示“設備列表”查詢結果。重置點擊“重置”，當前輸入的查詢條件被清空，設備列表顯示默認信息。導出點擊“導出”默認選中終端信息列表中的所有頁、所有字段。選擇文件存放的位置。執(zhí)行導出操作，默認格式為csv鏈接詳情點擊“終端資產(chǎn)編號”和“終端序列號”打開終端信息詳情頁面；PARTTWO模板文檔結構定義概設說明書文檔結構填寫后的效果PARTTWO模板文檔結構定義概設說明書文檔結構組件編號/組件名稱組件說明LC01_001/登錄本組件是后臺管理平臺登錄組件，對用戶名和密碼進行驗證操作，并進入后臺管理平臺。LC01_002/設備管理本組件是對終端設備及附件進行管理。LC01_003/告警管理本組件是對終端設備的“設備告警”、“應用列表”等“掌機監(jiān)控”業(yè)務的項管“告警規(guī)則”、“白名單”等信息進行管理。LC01_004/標準庫管理本組件是對終端設備允許安裝的“白名單”APP應用信息進行管理。LC01_005/系統(tǒng)管理本組件是對使用“安全管理平臺”操作人員的“角色”、“權限”、“機構人員”、“資源”等業(yè)務項進行管理。LC02_001/掌機監(jiān)控本組件提供終端設備告警功能，包含：非白名單應用安裝、SIM卡插拔、SIM卡一致性功能。PARTTWO模板文檔結構定義概設說明書文檔結構界面控制組件邏輯組件備注UIC01_001/登錄LC01_001/登錄

UIC01_002/終端信息LC01_002/終端信息

UIC01_003/采集規(guī)則LC01_003/采集規(guī)則

UIC01_004/告警管理LC01_004/告警管理

UIC01_005/標準庫管理LC01_005/標準庫管理

UIC01_006/系統(tǒng)管理LC01_006/系統(tǒng)管理

UIC02_001/安全中心（APP）LC02_001/安全中心（APP）PARTTWO模板文檔結構定義概設說明書文檔結構

本組件是包含六個子組件，分別為：設備列表、設備詳情、安裝應用詳情、設備性能監(jiān)控、未處理告警、流量監(jiān)控PARTTWO模板文檔結構定義概設說明書文檔結構組件編號/組件名稱組件說明LC01_002_001/設備列表本組件查詢、展示終端設備列表信息，提供查詢、重置、導出功能。LC01_002_002/設備詳情本組件展示設備外觀、設備檔案、智能卡關聯(lián)、SIM卡關聯(lián)、設備狀態(tài)等信息，并提供SIM卡解綁操作。LC01_002_003/安裝應用詳情本組件展示終端設備安裝應用數(shù)量、白名單數(shù)量、非白名單數(shù)量，以及終端設備上的應用列表。LC01_002_004/設備性能監(jiān)控本組件提供過去24小時CPU使用率、內(nèi)存使用率、電池溫度折線圖功能。LC01_002_005/未處理告警本組件提供終端設備未處理告警列表信息及操作“處理告警”功能。LC01_002_006/流量監(jiān)控本組提供過去24小時SIM卡的發(fā)送流量、接收流量及總流量的折線圖功能。PARTTWO模板文檔結構定義概設說明書文檔結構PARTTWO模板文檔結構定義概設說明書文檔結構實體英文名/中文名稱簡要說明SC_HANDSET_INFO/手持機檔案信息存放手持終端標識、終端序列號、終端類別、終端生產(chǎn)廠家、終端型號、終端子型號、硬件版本、軟件版本、到貨批次號、到貨日期、終端狀態(tài)、所屬單位、接收人、接收時間、登記人、登記時間、終端資產(chǎn)編號等屬性。該實體通過閉環(huán)系統(tǒng)同步產(chǎn)生記錄。SC_HANDSET_INFO_EXPAND/終端檔案信息擴展表存放終端標識、終端數(shù)據(jù)來源、操作系統(tǒng)、安全單元版本號等屬性。該實體通過初始化產(chǎn)生記錄。HBAQ_HANDSET_MORE_INFO/掌機監(jiān)控信息表存放終端標識、終端在線狀態(tài)、電池溫度、電池電量、CPU使用率、運行內(nèi)存總量、運行內(nèi)存使用量、存儲空間總量、存儲空間使用量、WIFI是否關閉、藍牙是否關閉、USB調(diào)試模式是否關閉、終端定位是否開啟、是否ROOT、最后更新時間等屬性。該實體通過“掌機采集信息上傳接口（103）”接口產(chǎn)生記錄。PARTTWO模板文檔結構定義概設說明書文檔結構組件名稱LC01_002_001/設備列表英文名LC_HandSetInfo組件說明本組件查詢、展示終端設備列表信息，提供查詢、重置、導出功能。方法名稱組件方法精化設計初始化【方法說明】加載查詢條件及終端設備信息列表?！据斎?yún)?shù)】無【處理過程】（1）讀取SELECT數(shù)據(jù)表：SC_HANDSET_INFO/手持機檔案信息；HBAQ_HANDSET_MORE_INFO/掌機監(jiān)控信息表；SYS_CODE/字典表。【輸出參數(shù)】“終端信息”結果集。查詢【方法說明】查詢“終端設備信息列表”。【輸入?yún)?shù)】終端類別；終端廠家；數(shù)據(jù)來源；終端型號；終端狀態(tài)；關鍵字?！咎幚磉^程】（1）獲取查詢條件：終端類別=“全部/現(xiàn)場抄表終端/采集維護終端/全功能終端”；（2）終端廠家=“全部/SELECT*FROMSYS_CODEWHERECODE_TYPE=’HAND_SUPPLIER’”；（3）數(shù)據(jù)來源=“全部/閉環(huán)系統(tǒng)”；（4）終端型號=“全部/SELECT*FROMSYS_CODEWHERECODE_TYPE=’MODEL_CODE’”；（5）終端狀態(tài)=“全部/在線/離線”。執(zhí)行查詢操作：查詢SELECT數(shù)據(jù)表：HBAQ_HANDSET_MORE_INFO/掌機監(jiān)控信息表；SC_HANDSET_INFO/手持機檔案信息?！据敵鰠?shù)】“終端設備信息”查詢結果集；重置【方法說明】重置終端設備查詢條件及列表信息?！据斎?yún)?shù)】【處理過程】（1）獲取查詢條件：終端類別=“全部”；（2）終端廠家=“全部”（3）數(shù)據(jù)來源=“全部”（4）終端型號=“全部”（5）終端狀態(tài)=“全部”；（6）關鍵字=“”。執(zhí)行查詢操作：查詢SELECT數(shù)據(jù)表：HBAQ_HANDSET_MORE_INFO/掌機監(jiān)控信息表；SC_HANDSET_INFO/手持機檔案信息?！据敵鰠?shù)】“終端設備信息”查詢結果集。PARTTWO模板文檔結構定義概設說明書文檔結構填寫后的效果PARTTWO模板文檔結構定義概設說明書文檔結構

安全中心（APP）監(jiān)聽消息服務，在收到告警規(guī)則變更后，請求此接口，從現(xiàn)場作業(yè)終端安全管理平臺下載“告警規(guī)則信息”。安全中心（APP）根據(jù)本地SQLite存儲的“告警規(guī)則配置信息”進行對比做增量更新PARTTWO模板文檔結構定義概設說明書文檔結構（2）交互流程說明1、

安全中心（APP）監(jiān)聽消息服務，如收到告警規(guī)則配置發(fā)生變化的消息后，調(diào)用“終端下載告警規(guī)則配置信息”接口服務。2、

現(xiàn)場作業(yè)終端安全管理平臺收到請求后,從數(shù)據(jù)庫中提取“告警規(guī)則配置信息”。3、

安全中心（APP）請求數(shù)據(jù)接口的serviceCode判斷以何種形式組織返回的數(shù)據(jù)集。4、

現(xiàn)場作業(yè)終端安全管理平臺將組織好的結果數(shù)據(jù)集返回給安全中心（APP）。（1）交互流程圖PARTTWO模板文檔結構定義概設說明書文檔結構接口名稱終端下載告警規(guī)則配置信息接口接口方式HTTP方法名稱ApiDo數(shù)據(jù)頻度實時輸入?yún)?shù)中文名稱輸入?yún)?shù)英文名稱參數(shù)格式含義業(yè)務號serviceCodeInt取值：100參數(shù)信息paramJson參數(shù)，JSON格式

updateTimeString更新時間返回數(shù)據(jù)中文名稱返回數(shù)據(jù)英文名數(shù)據(jù)格式含義返回碼codeInt1：接收成功；0：接收失敗返回信息msgString信息描述?？蔀榭辗祷亟Y果集resultJsonJSON格式結果集。可為空

idInt告警規(guī)則ID

monitorRoleIdInt告警項ID

nameString告警項名稱

maxValueInt閾值

levelInt安全等級

isEnableInt是否啟用

appIsExecIntAPP是否執(zhí)行

conditionString告警條件PARTTWO模板文檔結構定義概設說明書文檔結構針對需通過中間庫完成數(shù)據(jù)交互的接口方式，需提供接口交互中間表信息列表，如果未采用中間庫方式交互信息，可忽略此章節(jié)。具體示意如下：接口數(shù)據(jù)類中文名數(shù)據(jù)類英文名配送申請接口配送申請DIST_APP_INFO配送申請明細DIST_APP_DET訂單響應跟蹤ORDER_REPLY_TRACK單位與操作標識關系表ORG_OPER_ID_RELA注意：如果沒有交互數(shù)據(jù)，請寫“無”PART

THREE編寫原則北京合眾偉奇科技有限公司PARTTHREE編寫概要設計說明書的注意事項注意事項約束定義從約束的概念、約束需求兩方面說明約束的基本含義。LC邏輯設計LC邏輯設計的用途，內(nèi)容，以及設計過程的注意事項。LDM模型使用LDM模型的必要性；實體關系的完整性；LC實體列表中信息描述清晰準確。需求、概設相呼應用戶需求說明胡、產(chǎn)品需求說明書以及概要設計說明書之間應該能互查。

約束不是行為，是設計或項目的某些限制條件，這些限制條件也屬于需求，但通常被稱為“約束”來強調(diào)其限制性，例如：i.必須使用Oracle（我們硬件簽署過使用許可證了）；ii.必須在Linux上運行（成本低）。PARTTHREE約束定義——約束的概念1、架構師必須充分考慮客戶對上線時間的要求、預算限制、以及集成需要等非功能需求。2、客戶所處的業(yè)務領域為哪些？有什么業(yè)務規(guī)則和業(yè)務限制？3、是否需要關注相應的法律法規(guī)、專利限制？……業(yè)務環(huán)境因素1、軟件將人提供給何階層用戶？2、用戶的年齡及使用偏好是哪些？3、用戶是否遍及多個國家？4、使用期間的環(huán)境有電磁干擾、車船移動等國因素嗎？……使用環(huán)境因素1、開發(fā)團隊的技術水平如果有限（有些軟件企業(yè)甚至希望通過招聘便宜的程序員來降低成本）、磨合程度不高、分布在不同城市，會有何影響？2、開發(fā)管理方面、源代碼保密方面，是否需要顧及？……構建環(huán)境因素1、技術平臺、中間件、編程語言等的流行度、認同度、優(yōu)缺點等。2、技術發(fā)展的趨勢如何？……技術環(huán)境因素1234PARTTHREE約束定義——約束需求約束需求=業(yè)務環(huán)境因素+使用環(huán)境因素+構建環(huán)境因素+技術環(huán)境因素使用LDM的必要性

概設說明書必須使用LDM作為數(shù)模設計的依據(jù)。LDM能夠清晰表示實體及實體間的關系：1對1、1對多、多對多。比PDM更適合用到設計文檔中。PARTTHREELDM模型PDMLDM

構建LDM模型時，如果實體間存在關系，必須使用PowerDesigner的LDM模型“Relationship”組件，正確連接表示兩（多）個實體間的關系。PARTTHREELDM模型LDM模型實體間的關系要完整LC設計中的“實體列表”主要用于逐個說明“實體關系”圖中所涉及到的每個表的詳細信息，包括：表中存放的字段、該表的數(shù)據(jù)來源（即，誰或者什么業(yè)務產(chǎn)生的該表數(shù)據(jù)記錄）。概設說明書中的LC實體列表示例PARTTHREELDM模型實體英文名/中文名稱簡要說明SC_HANDSET_INFO/手持機檔案信息（1）存放手持終端標識、終端序列號、終端類別、終端生產(chǎn)廠家、終端型號、終端子型號、硬件版本、軟件版本、到貨批次號、到貨日期、終端狀態(tài)、所屬單位、接收人、接收時間、登記人、登記時間、終端資產(chǎn)編號等屬性。（2）該實體通過閉環(huán)系統(tǒng)同步產(chǎn)生記錄。SC_HANDSET_INFO_EXPAND/終端檔案信息擴展表（1）存放終端標識、終端數(shù)據(jù)來源、操作系統(tǒng)、安全單元版本號等屬性。（2）該實體通過初始化產(chǎn)生記錄。HBAQ_HANDSET_MORE_INFO/掌機監(jiān)控信息表（1）存放終端標識、終端在線狀態(tài)、電池溫度、電池電量、CPU使用率、運行內(nèi)存總量、運行內(nèi)存使用量、存儲空間總量、存儲空間使用量、WIFI是否關閉、藍牙是否關閉、USB調(diào)試模式是否關閉、終端定位是否開啟、是否ROOT、最后更新時間等屬性。（2）該實體通過“掌機采集信息上傳接口（103）”接口產(chǎn)生記錄。PARTTHREELC邏輯設計LC邏輯組件設計要點組件名稱LC01_002_001/設備列表英文名LC_HandSetInfo組件說明本組件查詢、展示終端設備列表信息，提供查詢、重置、導出功能。方法名稱組件方法精化設計初始化【方法說明】加載查詢條件及終端設備信息列表?！据斎?yún)?shù)】無【處理過程】（1）讀取SELECT數(shù)據(jù)表：SC_HANDSET_INFO/手持機檔案信息；HBAQ_HANDSET_MORE_INFO/掌機監(jiān)控信息表；SYS_CODE/字典表?！据敵鰠?shù)】“終端信息”結果集。查詢【方法說明】查詢“終端設備信息列表”。【輸入?yún)?shù)】終端類別；終端廠家；數(shù)據(jù)來源；終端型號；終端狀態(tài)；關鍵字?！咎幚磉^程】（1）獲取查詢條件：終端類別=“全部/現(xiàn)場抄表終端/采集維護終端/全功能終端”；（2）終端廠家=“全部/SELECT*FROMSYS_CODEWHERECODE_TYPE=’HAND_SUPPLIER’”；（3）數(shù)據(jù)來源=“全部/閉環(huán)系統(tǒng)”；（4）終端型號=“全部/SELECT*FROMSYS_CODEWHERECODE_TYPE=’MODEL_CODE’”；（5）終端狀態(tài)=“全部/在線/離線”。執(zhí)行查詢操