二次開發(fā)需求說明書模板

1、網(wǎng)管服務(wù)二次開發(fā)需求說明書需求類型網(wǎng)管服務(wù)二次開發(fā)需求一告警類需求名稱XXX需求需求工單號(hào)文檔評(píng)審/修訂記錄1. 文檔介紹1.1文檔目的該需求說明書詳細(xì)描述了XXX需求，便于需求分析人員和軟件開發(fā)人員更準(zhǔn)確地理解客戶 所需要的需求1.2文檔范圍本文檔包含了XXXX功能全部軟件需求，其中包含了對(duì)軟件的功能性需求和非功能性需求。1.3讀者對(duì)象【廣西移動(dòng)】XX室、XX室 【億陽信通】需求分析人、軟件開發(fā)人、需求管理接口人1.4參考文檔如有，請(qǐng)列舉出相關(guān)文檔1.5術(shù)語與縮寫解釋2. 需求范圍/介紹2.1 需求提出提出時(shí)間2016T1-29時(shí)限要求XXX完成上線需求負(fù)責(zé)人 與聯(lián)系方式張三，1231231

2、2312312需求等級(jí)枚舉：一級(jí)、二級(jí)、三級(jí)需求依據(jù) 需求用途 需求總述附集團(tuán)工單等枚舉：集團(tuán)上報(bào)、管理考核、日常工作使用者人員區(qū)監(jiān)控 地市自維 地市代維需求依據(jù) 需求用途 需求總述附集團(tuán)工單等枚舉：集團(tuán)上報(bào)、管理考核、日常工作使用者人員區(qū)監(jiān)控 地市自維 地市代維任務(wù)派發(fā)監(jiān)控任務(wù)使用頻率每日（周、月）X次 每日（周、月）亍次 每日（周、月）X次文件存儲(chǔ)IE 曰數(shù)據(jù)量文件存儲(chǔ)IE 曰數(shù)據(jù)量支撐系統(tǒng)如：故障管理系統(tǒng)+電子運(yùn)維管理+手機(jī)2.2需求背景XXXXXX。2.3需求概述/目標(biāo)中興軟創(chuàng)10M系統(tǒng)通過socke t接口，將寬帶裝移機(jī)與資源、BOSS、RADIUS系統(tǒng)交互時(shí)出現(xiàn)異?？▎蔚母婢l(fā)送到

3、故障管理系統(tǒng)，億陽故障管理系統(tǒng)將卡單告警解析入庫，并派單。3. 詳細(xì)功能描述3.1故障管理3.1.1 告警采集標(biāo)準(zhǔn)告警接口：通常走統(tǒng)一采集，統(tǒng)一采集的告警適配器這塊目前是黑盒，不了解。走 統(tǒng)一采集采的，一般是從OMC/EMS/專業(yè)網(wǎng)管獲取的告警。非標(biāo)準(zhǔn)告警接口： SOCKET、SNMP。提醒：非標(biāo)準(zhǔn)告警接入一般都需要故障系統(tǒng)給對(duì)端系統(tǒng)開通監(jiān)聽端口，若有可以沿用的 端口，則不需要新開。開通監(jiān)聽端口的工作可以在需求分析的時(shí)候就做，以便提供給對(duì)端系 統(tǒng)進(jìn)行網(wǎng)絡(luò)連通性測(cè)試。模板樣例：SOCKET:與中興軟創(chuàng)IOM系統(tǒng)建立socket接口。沿用現(xiàn)有框架，socket接口方式采集 卡單告警。億陽接口信息：

4、10.184.141.182的5403端口。SNMP：華為廠家提供標(biāo)準(zhǔn)的SNMP接口，采用SNMP V2協(xié)議將信測(cè)的告警從10.188.51.49 (華為的服務(wù)器IP)轉(zhuǎn)發(fā)到綜合告警服務(wù)器10.184.141.182的162端口。讀團(tuán) 體名： Mkdtcp881 ，寫團(tuán)體名： Private123。3.1.1.1 告警接口說明接口方式：故障管理系統(tǒng)作為告警接入的服務(wù)端，其他系統(tǒng)作為消息客戶端，負(fù)責(zé)主動(dòng)發(fā)起連接和 自動(dòng)重連。在具體接口協(xié)議上，各個(gè)應(yīng)用系統(tǒng)應(yīng)當(dāng)以Socket、MQ等實(shí)時(shí)消息接口進(jìn)行連接 并傳送數(shù)據(jù)。消息格式說明：本消息格式采用X.733協(xié)議所要求的內(nèi)容，采用類XML格式進(jìn)行描述。其

5、中以“AlarmStart”和“AlarmEnd”作為一條告警消息的開始和結(jié)束標(biāo)志。中間 的消息體以“告警字段:字段值”出現(xiàn)，每個(gè)告警字段值均以“chr(13)+chr(10)”結(jié)束，每個(gè) 信息字段采用英文名稱作為標(biāo)識(shí)，通過“:”與實(shí)際Value內(nèi)容進(jìn)行分隔。告警字段值不能包含其它任何一個(gè)“告警字段：”關(guān)鍵字。 消息以文本流方式進(jìn)行傳送。例如：AlarmStartMsgSerial：1234AlarmUniqueId：12345678NeName：TJG1AlarmEnd告警接入接口消息內(nèi)容說明：中文名稱英文名稱數(shù)據(jù)類型說明接口版本號(hào)IntVersionString接口協(xié)議版本號(hào)告警唯一標(biāo)識(shí)A

6、larmUniqueldString一條告警的唯一標(biāo)識(shí)(發(fā) 生與清除要求一致)網(wǎng)元標(biāo)識(shí)NeIdString網(wǎng)元的唯一標(biāo)識(shí)網(wǎng)元名稱NeNameString網(wǎng)元名稱告警來源SystemNameString網(wǎng)元產(chǎn)生的告警：網(wǎng)元名稱網(wǎng)元管理系統(tǒng)產(chǎn)生的告 警：OMC或EMS名稱網(wǎng)絡(luò)管理系統(tǒng)產(chǎn)生的告 警：網(wǎng)絡(luò)管理系統(tǒng)名稱設(shè)備類型EquipmentclassString設(shè)備類型名稱，告警設(shè)備 類型，MSC、TMSC_server、MGW、 HLR、 GMSC、 BSC、TMSC1、 TMSC2、 SSP、 SMP、SCP、 VC、 OMC設(shè)備類型編碼需要統(tǒng)一， 以告警ID中的設(shè)備類型 為準(zhǔn)（參考文檔中國移動(dòng)

7、 告警ID編碼規(guī)則）廠家標(biāo)識(shí)VendorString廠家名稱:設(shè)備廠家，廠家 編碼以告警ID中的廠家 編碼為準(zhǔn)（參考文檔中國 移動(dòng)告警ID編碼規(guī)則）網(wǎng)元版本VersionString廠家網(wǎng)元設(shè)備版本；保留 告警發(fā)生時(shí)的網(wǎng)元版本告警定位對(duì)象 標(biāo)識(shí)LocateNeldString定位到告警網(wǎng)元的具體細(xì) 粒度對(duì)象，如link、cell 等，他們的網(wǎng)元標(biāo)識(shí)分別 對(duì)應(yīng)msc、基站。告警定位對(duì)象 名稱LocateNeNameString告警定位對(duì)象名稱告警定位對(duì)象 類型LocateNeTypeString定位對(duì)象的類型，如msc、 bsc、link、cell 等。告警對(duì)象工程 狀態(tài)LocateNeStat

8、usString資源工程狀態(tài)定位信息LocatelnfoString告警的詳細(xì)定位信息告警發(fā)生時(shí)間EventTimeString告警發(fā)生的時(shí)間，時(shí)間格 式為 YYYY-MM-DDHH:mm:ss告警清除時(shí)間CancelTimeString告警清除的時(shí)間，時(shí)間格 式為 YYYY-MM-DDHH:mm:ss廠家告警類型VendorAlarmTypeString廠家原始告警類型網(wǎng)管告警類型AlarmTypeString網(wǎng)管系統(tǒng)內(nèi)的告警類型廠家告警級(jí)別VendorSeverityString女如愛立信A1網(wǎng)管告警級(jí)別AlarmSeverityString1：緊急(Critical) 2：重要(Majo

9、r) 3：次要(Major)4：提示(Warning)廠家告警號(hào)VendorAlarmIdString廠家原始告警號(hào)網(wǎng)管告警IDNmsAlarmldString中國移動(dòng)對(duì)廠家告警的統(tǒng) 一編碼（參考文檔中國移 動(dòng)告警ID編碼規(guī)則）告警狀態(tài)AlarmStatusInt0：清除告警1：活動(dòng)告警告警標(biāo)題AlarmTitleString告警含義的簡要概括告警可能原因ProbableCauseTxtString詳細(xì)說明此告警的具體含 義，產(chǎn)生原因等告警正文AlarmTextString告警正文全部內(nèi)容專業(yè)SpecialtyInt專業(yè)名稱1：無線接入網(wǎng)2：核心網(wǎng)電路域3：核心網(wǎng)分組域4：數(shù)據(jù)網(wǎng)5：傳送網(wǎng)6：

10、動(dòng)力環(huán)境告警邏輯分類AlarmLogicClassString告警邏輯分類名稱:處理 器模塊、輸入輸出設(shè)備、 話務(wù)處理、計(jì)費(fèi)系統(tǒng)、中 繼與傳輸、信令與IP、操 作維護(hù)、數(shù)據(jù)配置，詳見告警梳理模板告警邏輯子類AlarmLogicSubClassString告警邏輯子類名稱:如中 央處理器故障、區(qū)域處理 器故障等集團(tuán)統(tǒng)一劃分的 20類告警邏輯子類，詳見告警梳理模板該事件對(duì)設(shè)備 的影響EffectOnEquipmentInt該事件對(duì)設(shè)備造成影響程 度1：設(shè)備全阻2：可能設(shè)備全阻3：設(shè)備局部故障4：可能設(shè)備局部故障5：設(shè)備性能下降6：無影響該事件對(duì)業(yè)務(wù) 的影響EffectOnBusinessInt該事

11、件對(duì)業(yè)務(wù)的影響程度1：業(yè)務(wù)全阻2：可能業(yè)務(wù)全阻3：業(yè)務(wù)受影響4：可能業(yè)務(wù)受影響5：業(yè)務(wù)質(zhì)量下降6：無影響告警類別NmsAlarmTypeInt1：設(shè)備告警2：性能告警告警地區(qū)AlarmRegionString告警對(duì)象所在地區(qū)312告警解析告警解析指的是告警正文的深度解析，統(tǒng)一采集采回來的告警僅進(jìn)行了淺度解析。提醒：在定接口協(xié)議時(shí)，就要確認(rèn)告警接入后是否派單。若需要，則要了解工單處理對(duì)象 一般是什么人，并且要將確定派單對(duì)象的關(guān)鍵字段充分明確下來。比如按設(shè)備維護(hù)班組派 單，則要求告警接口傳送過來的網(wǎng)元名稱、設(shè)備類型必須跟綜資的上的保持一致。其他的 無設(shè)備維護(hù)班組的告警，則需要確定下來哪個(gè)字段或者哪

12、些字段組合能夠唯一確定派發(fā)對(duì) 象。告警傳送字段除了必須包含的（見上文中標(biāo)黃的字段），其他字段是否為必填傳送，由 雙方協(xié)定并在文檔中體現(xiàn)。模板樣例：Socket接口協(xié)議- 告警字段定義.xlsxSNMP接口協(xié)議- 告警Mib定義.xlsx需求案例：二更接入需求案例-rar說明：大部分接入的告警都會(huì)有活動(dòng)告警和清除告警。但是也有一些是沒有清除告警消息的，比如10M卡單告警。313告警標(biāo)準(zhǔn)化告警標(biāo)準(zhǔn)化梳理表樣例:家客PON各理標(biāo)準(zhǔn)rar一般非標(biāo)準(zhǔn)告警，用戶一般梳理不出來標(biāo)準(zhǔn)化梳理表信息。3.1.4 告警關(guān)聯(lián)此類告警無告警關(guān)聯(lián)的需求。告警關(guān)聯(lián)模板：告警關(guān)聯(lián)規(guī)則模板20160329.xlsx備注：應(yīng)網(wǎng)管

13、室系統(tǒng)管理員要求，在開發(fā)配置關(guān)聯(lián)規(guī)則時(shí)，要在系統(tǒng)的配置界面描 述項(xiàng)中說明需求來源，包括工單號(hào)和工單主題。3.1.5 告警派單派單規(guī)則派單規(guī)則名稱：家寬卡單告警派單派單時(shí)間：7*24 小時(shí)規(guī)則優(yōu)先級(jí)：普通關(guān)聯(lián)關(guān)系動(dòng)作：獨(dú)立派單派單時(shí)延：立即派單對(duì)象：T2備注：應(yīng)網(wǎng)管室系統(tǒng)管理員要求，在開發(fā)配置派單規(guī)則時(shí)，要在系統(tǒng)的配置界面描述項(xiàng)中說明需求來源，包括工單號(hào)和工單主題。以 IOM 卡單告警派單規(guī)則為例，如下：派單約定該角色角色備注該網(wǎng)絡(luò)類是已有對(duì)應(yīng)E0MS網(wǎng) 絡(luò)類型型是已有/ 新增派單對(duì)象/新增設(shè)備類型為“綜合資源”的告 警，工單派單給“網(wǎng)管室-綜合 資源維護(hù)組”角色網(wǎng)管室- 綜合資源 維護(hù)組已有人

14、員信息列表 見附件支撐網(wǎng)-億陽- 綜合資源已有設(shè)備類型為“BOSS”的告警，工 單派單給“廣西-BOSS”角色廣西-BOSS新增人員信息列表 見附件業(yè)務(wù)平臺(tái)-亞信-BOSS新增設(shè)備類型為“Radius ”的告警， 工單派單給“廣西-RADIUS”角 色廣西-RADIUS新增人員信息列表見附件業(yè)務(wù)平臺(tái)-亞信-Radius新增設(shè)備類型為“IOM ”的告警，工單 派給“廣西一IOM中興軟創(chuàng)”廣西一IOM中興軟創(chuàng)新增人員信息列表 見附件支撐網(wǎng)-中興軟創(chuàng)-IOM新增角色人員列表：網(wǎng)管系統(tǒng)問題處理 流程維護(hù)人員信息071追單規(guī)則追單規(guī)則模板：告警追單規(guī)則模板20160329.xlsx3.2故障與E0MS接

15、口改造派單接口規(guī)范字段如下附件7-GTFT派單接口-與EOMS的派單字段若需要在工單呈現(xiàn)的告警信息不在接口規(guī)范中，則需要改造派單接口。說明清楚需要在接口增加的字段。3.3 EOMS3.3.1 工單內(nèi)容呈現(xiàn)工單主題：XXXX（如果沒有特殊要求，一般是專業(yè)+網(wǎng)元名稱+告警標(biāo)題，例如無線專業(yè)的：無線 梧州藤縣天平鎮(zhèn)陶村高鐵12-1 基站 射頻單元維護(hù)鏈路異常告警）故障工單網(wǎng)絡(luò)分類：例如:設(shè)備類型為“綜合資源”的告警，工單的網(wǎng)絡(luò)分類為支撐網(wǎng)-億陽-綜合資源設(shè)備類型為“BOSS”的告警，工單的網(wǎng)絡(luò)分類為業(yè)務(wù)平臺(tái)-亞信-BOSS （此字典 值需要 eoms 新增）設(shè)備類型為“Radius”的告警，工單的網(wǎng)

16、絡(luò)分類為業(yè)務(wù)平臺(tái)亞信-Radius （此 字典值需要eoms新增）其他字段若有特殊要求，逐一說明3.3.2 角色及維護(hù)人員配置需要新增 T2 角色或配置人員信息例如IOM卡單告警，需要新增廣西-BOSS、廣西-RADIUS角色在對(duì)應(yīng)的角色中配置維護(hù)人員，人員信息如下：卡單告警故障維護(hù) 人員信息.xlsx3.3.3 工單處理時(shí)限要求模板：集中化故障工單處 理時(shí)限規(guī)則.Xis3.3.4工單督辦規(guī)則督辦：按一般集中化工單督辦規(guī)則進(jìn)行，無特殊要求。集中化督辦規(guī)則2016O422.xls3.3.5 預(yù)處理規(guī)則一般用戶在一次告警接入到派單的需求中，是無法梳理出預(yù)處理規(guī)則。會(huì)在以后的單獨(dú)提需求，而且非標(biāo)準(zhǔn)的告警一般沒有預(yù)處理要求。無特殊說明時(shí)，默認(rèn)無預(yù)處理。3.3.6T2 回單信息說明T2 回單內(nèi)容基本信息有如下：操作人系統(tǒng)自動(dòng)填寫操作人部門系統(tǒng)自動(dòng)填寫操作人聯(lián)系方式系統(tǒng)自動(dòng)填寫操作時(shí)間系統(tǒng)自動(dòng)填寫是否故障是/否是否與預(yù)處理輸出內(nèi)容一致是/否枚舉值（需要明確現(xiàn)有枚舉是否滿足使用，不滿故障原因類別足則需要明確新增需求要求）枚舉值（需要明確現(xiàn)有枚舉是否滿足使用，不滿故障原因細(xì)分足則需要明確新增