核電廠交互式電子技術(shù)手冊（IETM）第3部分：數(shù)據(jù)管理

1核電廠交互式電子技術(shù)手冊（IETM）第3部分：數(shù)據(jù)管理本文件規(guī)定了核電廠交互式電子技術(shù)手冊的數(shù)據(jù)管理、交換、發(fā)布等總體要求。本文件適用于核電廠交互式電子技術(shù)手冊的研發(fā)、使用和維護(hù)等。2規(guī)范性引用文件下列文件中的內(nèi)容通過文中的規(guī)范性引用而構(gòu)成本文件必不可少的條款。其中，注日期的引用文件，僅該日期對應(yīng)的版本適用于本文件；不注日期的引用文件，其最新版本（包括所有的修改單）適用于本文件。ASDS1000D基于公共源數(shù)據(jù)庫的技術(shù)出版物國際規(guī)范3術(shù)語和定義下列術(shù)語和定義適用于本文件。3.1交互式電子技術(shù)手冊Interactiveelectronictechnicalmanual(IETM)以數(shù)字形式存儲，采用文字、圖形、表格、音頻和視頻等形式，以交互方式提供核電廠基本原理、操作使用和維修等內(nèi)容的技術(shù)出版物。3.2數(shù)據(jù)模塊Datamodule(DM)利用文字、表格、圖形、圖像、動畫、音頻和視頻等多種展現(xiàn)形式，描述核電廠的結(jié)構(gòu)、性能和操作步驟等技術(shù)信息的獨(dú)立的、完整的數(shù)據(jù)單元。3.3信息控制代碼Informationcontrolnumber(ICN)是由數(shù)字、字母等字符組成的結(jié)構(gòu)化標(biāo)識符，用以唯一標(biāo)識及索引與數(shù)據(jù)模塊相關(guān)聯(lián)的圖形、圖像、動畫、音頻和視頻等多媒體信息。在CSDB中，信息控制碼用于與一個或多個數(shù)據(jù)模塊建立管理，對插圖或多媒體對象進(jìn)行控制與訪問。3.4研制單位代碼Originatorcode(OC)用于標(biāo)識數(shù)據(jù)信息（數(shù)據(jù)模塊、出版模塊、實(shí)體等）負(fù)責(zé)或制作單位的代碼。3.5出版物模塊編碼Publicationmodulecode(PMC)用于標(biāo)識出版物模塊，以便于在CSDB中存儲和提取。3.6數(shù)據(jù)分發(fā)文件Datadispatchnote(DDN)ASDS1000D標(biāo)準(zhǔn)定義的、以數(shù)據(jù)包方式將IETM數(shù)據(jù)進(jìn)行分發(fā)的專用文件格式。3.7數(shù)據(jù)交換文件代碼Interchangeofdatamodulescode(IDC)由數(shù)字、字母等字符組成，在文件交換時標(biāo)識數(shù)據(jù)分發(fā)文件、數(shù)據(jù)模塊文件、圖形多媒體文件、數(shù)據(jù)管理列表文件、出版物文件和評注文件等的代碼。3.8技術(shù)出版物模塊Publicationmodule(PM)2用XML語言定義的技術(shù)出版物的結(jié)構(gòu)和內(nèi)容。一個PM可由一個或多個數(shù)據(jù)模塊（DM）、PM或外部引用文件組成。3.9模式Schema用于規(guī)范XML文檔的邏輯結(jié)構(gòu),包括對XML文檔中可用的元素和屬性、子元素的順序和數(shù)量、元素和屬性的數(shù)據(jù)類型等各種元素和屬性使用規(guī)則的定義。3.10元素Element是XML文檔中最主要的一個組件，由開始標(biāo)簽和結(jié)束標(biāo)簽以及中間的內(nèi)容組成，可包含子元素和文本內(nèi)容，具體使用規(guī)則通過Schema進(jìn)行定義。3.11屬性Attribute作為元素的額外（附加）信息，用于描述元素的特性，包含屬性名和屬性值。4縮略語下列縮略語適用于本文件。IETM:交互式電子技術(shù)手冊(Interactiveelectronictechnicalmanual)IETP:交互式電子技術(shù)出版物(InteractiveElectronicTechnicalPublication)CSDB:公共源數(shù)據(jù)庫(CommonSourceDatabase)DM:數(shù)據(jù)模塊(DataModule)DMC:數(shù)據(jù)模塊編碼(DataModuleCode)PM:發(fā)布模塊(PublicationModule)PMC:發(fā)布模塊編碼(PublicationModuleCode)XML:可擴(kuò)展標(biāo)記語言(eXtensibleMarkupLanguage)5概述數(shù)據(jù)管理規(guī)范按照ASDS1000D《基于公共源數(shù)據(jù)庫的技術(shù)出版物國際規(guī)范要求》，適用于核電廠交互式電子技術(shù)手冊制作過程中的數(shù)據(jù)交換、數(shù)據(jù)發(fā)布及數(shù)據(jù)修改更新。6數(shù)據(jù)交換6.1數(shù)據(jù)交換文件格式6.1.1一般要求核電廠IETM研制單位在不同IETM編制系統(tǒng)之間進(jìn)行正式發(fā)布數(shù)據(jù)的交換采用ASDS1000D標(biāo)準(zhǔn)規(guī)定的數(shù)據(jù)分發(fā)文件（DDN）進(jìn)行數(shù)據(jù)交換。一個DDN數(shù)據(jù)包包含一個DDN文件，該DDN文件用于以XML格式記錄數(shù)據(jù)包中包含的所有數(shù)據(jù)模塊、插圖等數(shù)據(jù)編碼。特殊情況下（單個文件或編制過程中文件）可采用數(shù)據(jù)模塊文件、圖形多媒體文件、數(shù)據(jù)管理列表文件、技術(shù)出版物模塊文件和評注文件等方式進(jìn)行數(shù)據(jù)交換。6.1.2文件構(gòu)成基于文件的交換包由一個數(shù)據(jù)分發(fā)文件（DDN文件）以及至少以下一個數(shù)據(jù)文件構(gòu)成：a)一個或多個數(shù)據(jù)模塊及相關(guān)聯(lián)的插圖、多媒體等其它數(shù)據(jù)；b)一個或多個CSDB狀態(tài)清單；c)一個或多個數(shù)據(jù)模塊需求列表；d)一個或多個PM。6.1.3傳輸要求3數(shù)據(jù)交換包在傳輸過程中，應(yīng)：a)在交換包中不使用目錄結(jié)構(gòu)；b)DDN最先傳輸，交換的其余文件可按任意順序傳輸；c)在發(fā)送前，交換雙方可使用同一數(shù)據(jù)壓縮格式將技術(shù)將數(shù)據(jù)文件進(jìn)行壓縮（需要注意統(tǒng)一壓縮工具軟件版本），如：ZIP、RAR。6.2數(shù)據(jù)交換文件代碼編制要求6.2.1文件類型要求數(shù)據(jù)交換文件包括數(shù)據(jù)分發(fā)文件、數(shù)據(jù)模塊文件、圖形多媒體文件、數(shù)據(jù)管理列表文件、技術(shù)出版物模塊文件等。數(shù)據(jù)分發(fā)文件代碼編制方法見6.2.2.2-6.2.2.5，數(shù)據(jù)模塊文件、圖形多媒體文件、數(shù)據(jù)管理列表文件、技術(shù)出版物模塊文件等文件類型編碼見核電廠IETM相關(guān)編碼標(biāo)準(zhǔn)。6.2.2結(jié)構(gòu)要求數(shù)據(jù)分發(fā)文件（DDN）代碼分為2~4個碼段，數(shù)據(jù)分發(fā)文件編碼僅由文件類型段和文件標(biāo)識段組成，各碼段的描述見表1。表1數(shù)據(jù)交換文件代碼結(jié)構(gòu)序號碼段名稱長度(字符)1文件類型段32文件標(biāo)識段6.2.3文件類型段該碼段由3位大寫字母組成，表示數(shù)據(jù)交換文件的類型，具體代碼定義如表2所示：表2文件類型代碼定義代碼定義DDN數(shù)據(jù)分發(fā)文件DMC數(shù)據(jù)模塊文件圖形或多媒體文件數(shù)據(jù)管理列表文件技術(shù)出版物模塊文件COM注評文件6.2.4文件標(biāo)識段DDN文件代碼的該碼段由四部分組成，每部分用連接符-連接，具體示例如下：示例：DDN-ACP1000-SSSSS-DDDDD-XXXX-NNNNN.xmlACP1000標(biāo)識核電廠IETM項(xiàng)目型號。SSSSS表示數(shù)據(jù)發(fā)送方的單位代碼。DDDDD表示數(shù)據(jù)接受方的單位代碼。XXXX表示數(shù)據(jù)發(fā)送時的年份，例如2021、2022等。NNNNN表示五位流水號，從00001開始遞增，當(dāng)進(jìn)入到新的一年以后，流水號從“00001”開始一次遞增。6.2.5編碼示例4不同類型數(shù)據(jù)交換代碼示例如表3所示。表3數(shù)據(jù)交換文件代碼示例序號數(shù)據(jù)交換文件類型數(shù)據(jù)交換文件代碼示例說明1數(shù)據(jù)分發(fā)文件DDN-ACP1000-C0201-K0901-2021-00002.XML核電廠IETM正式發(fā)布數(shù)據(jù)交換的唯一方式，以XML形式記錄所有交換數(shù)據(jù)的一個列表。2數(shù)據(jù)模塊文件DMC-ACP1000-A-000-00-10-00A-040B-C_001-02_zh-CN.XML數(shù)據(jù)模塊XML文件數(shù)據(jù)交換代碼3圖形多媒體文件ICN-ACP1000-A-0000100-A-00001-A-01-1.CGM圖形多媒體文件的數(shù)據(jù)交換代碼，代碼規(guī)則同信息控制代碼編制要求。4技術(shù)出版物模塊文件PMC-ACP1000-K0901-10002-00_001-02_zh-CN.XML技術(shù)出版物模塊數(shù)據(jù)交換代碼，用于標(biāo)識出版物XML文件。7發(fā)布流程與管理7.1編寫流程7.1.1PM創(chuàng)建過程中包括但不限于以下步驟：a)創(chuàng)建PM項(xiàng)目；b)定義PMC，定義規(guī)則參見技術(shù)出版物模塊編碼規(guī)范；c)定義PM的語言和國家，使用標(biāo)識狀態(tài)段中元素<language>的屬性“l(fā)anguageIsoCode”和“countryIsoCode”進(jìn)行標(biāo)識如圖1所示，定義規(guī)則參見GB/T2659-2000和ISO639-1:2002；圖1元素<language>結(jié)構(gòu)4)定義PM/技術(shù)出版物的版本（使用“大版本.小版本”進(jìn)行版本管理技術(shù)出版物版本號與PM版本號一致；在XML語言中，標(biāo)識狀態(tài)段中的元素<issueInfo>記錄PM版本號的信息如圖2所示。其中：5圖2元素<issueInfo>結(jié)構(gòu)——大版本號，用元素<issueInfo>下的屬性issueNumber標(biāo)記，大版本號由三位流水號來表示，流水號隨PM的大版本的升版遞增；——小版本號，用元素<issueInfo>下的屬性inwork標(biāo)記，用于記錄PM兩個相鄰大版本間發(fā)布的小版本，由兩位流水號來表示，流水號隨PM小版本的升版遞增；——屬性issueNumber、inWork的變更規(guī)則如表4所示。表4屬性issueNumber,inWork變更規(guī)則編號規(guī)定屬性屬性值001.00初版技術(shù)出版物模塊。inWork="00"issueNumber="001"001.01初版技術(shù)出版物模塊，第一個小版本。inWork="01"issueNumber="001"001.NN初版技術(shù)出版物模塊,第"NN"個小版本。inWork="NN"issueNumber="001"002.00第二版技術(shù)出版物模塊。inWork="00"issueNumber="002"002.01第二版技術(shù)出版物模塊,第一個小版本。inWork="01"issueNumber="002"002.NN第二版技術(shù)出版物模塊,第"NN"個小版本。inWork="NN"issueNumber="002"NNN.00"NNN"版技術(shù)出版物模塊。inWork="00"issueNumber="NNN"NNN.XX"NNN"版技術(shù)出版物模塊，第XX個小版本。inWork="XX"issueNumber="NNN"7.1.2PM內(nèi)容編寫由以下部分組成：a)正文前資料，由一個或多個正文前資料數(shù)據(jù)模塊組成；b)技術(shù)出版物內(nèi)容，由一個或多個數(shù)據(jù)模塊、技術(shù)出版物模塊、外部引用文件組成。7.1.3PM編寫完成后應(yīng)進(jìn)行審核，審核內(nèi)容包括但不限于：a)PMC設(shè)定的正確性；b)PM的語言、國家、版本信息的正確性；c)PM滿足技術(shù)出版物規(guī)定的內(nèi)容和結(jié)構(gòu)，包括正文前資料的組成和正文內(nèi)容的組成。7.2發(fā)布流程PM審核通過后進(jìn)行技術(shù)出版物發(fā)布。a)發(fā)布過程分為主版本發(fā)布和客戶化發(fā)布：1)主版本發(fā)布為發(fā)布包含所有適用性信息的技術(shù)出版物，技術(shù)出版物內(nèi)容不進(jìn)行任何適用性過濾；62)客戶化發(fā)布為在主版本基礎(chǔ)上經(jīng)特定客戶適用性信息過濾后發(fā)布的技術(shù)出版物。b)發(fā)布的形式為XML、PDF和IETP：1)XML形式為PM的原始XML格式數(shù)據(jù)包，可供用戶進(jìn)行編輯；2)PDF形式為面向頁面的發(fā)布形式，一般用于PDF閱讀、打印等；3)IETP形式為面向?yàn)g覽器的發(fā)布形式，一般用于電子化的交互式閱讀等。7.3管理7.3.1存儲管理發(fā)布之后，出版物模塊應(yīng)按類型進(jìn)行存儲管理，所有存儲數(shù)據(jù)應(yīng)進(jìn)行備份。出版物模塊存儲類型宜從表5中選取。表5技術(shù)出版物存儲類型類型名稱說明型號表示發(fā)布項(xiàng)目。語種表示技術(shù)出版物內(nèi)容的編寫語言。發(fā)布形式PDF、IETP和XML。技術(shù)出版物名稱依據(jù)技術(shù)出版物清單進(jìn)行創(chuàng)建?？蛻艏夹g(shù)出版物的最終用戶。技術(shù)出版物版本日期表示技術(shù)出版物的發(fā)布日期。7.3.2更改管理當(dāng)核電廠主要組成系統(tǒng)發(fā)生設(shè)計(jì)更改、技術(shù)改進(jìn)或設(shè)備改進(jìn)時（核電工程公司發(fā)起時需要對相應(yīng)的數(shù)據(jù)模塊、技術(shù)插圖等數(shù)據(jù)進(jìn)行修改，修改完成后通過更改技術(shù)出版物模塊進(jìn)行重新發(fā)布。技術(shù)出版物模塊更改編寫流程參見第6.3.1節(jié)。8數(shù)據(jù)修改與更新8.1數(shù)據(jù)更改流程當(dāng)核電廠建設(shè)或運(yùn)行期間發(fā)生技術(shù)變更時需要同步進(jìn)行IETM數(shù)據(jù)的修改，包括數(shù)據(jù)模塊、技術(shù)插圖、多媒體等數(shù)據(jù)。數(shù)據(jù)更改流程包括但不限于以下步驟：a)確認(rèn)更改需求，包括設(shè)計(jì)更改或技術(shù)變更輸入、相關(guān)工程圖紙和模型或文件準(zhǔn)備；b)確定更改范圍，分析更改需求確定需要更改的數(shù)據(jù)模塊、插圖、三維動畫等數(shù)據(jù)范圍；c)更改關(guān)聯(lián)性分析，分析需要修改的數(shù)據(jù)模塊、插圖、三維動畫等數(shù)據(jù)的引用或被引用關(guān)系，確認(rèn)這些關(guān)聯(lián)是否繼續(xù)有效，或者是否需要進(jìn)行關(guān)聯(lián)更改；d)更改實(shí)施，包括數(shù)據(jù)模塊簽出、對內(nèi)容進(jìn)行編輯修改、在標(biāo)識和狀態(tài)層的更新原因元素<reasonForUpdate>中添加相應(yīng)的更新說明，更新原因元素的編制說明參見數(shù)據(jù)模塊編制-通用部分定義的內(nèi)容。當(dāng)完成數(shù)據(jù)模塊、插圖等數(shù)據(jù)更改后，完成簽入操作；e)數(shù)據(jù)模塊、插圖等數(shù)據(jù)更改完成后，應(yīng)該重新進(jìn)行數(shù)據(jù)模塊、插圖等數(shù)據(jù)的審簽，通過審簽后即完成了數(shù)據(jù)更改工作；f)數(shù)據(jù)模塊、插圖等數(shù)據(jù)更改后的重新發(fā)布見第6.3章。8.2數(shù)據(jù)更新流程7核電廠IETM數(shù)據(jù)更新主要包括：部分?jǐn)?shù)據(jù)更新和全部數(shù)據(jù)換版發(fā)布兩種，因設(shè)計(jì)更改導(dǎo)致部分?jǐn)?shù)據(jù)模塊（一般0-100個以內(nèi)，視需）內(nèi)容發(fā)生改變時，可以通過部分?jǐn)?shù)據(jù)更新的方