National Information Exchange Model(NIEM)是一項由美國政府資助的創新計畫,目標是打通公、私部門組織之間的資訊共享。它最初聚焦於執法、公共安全與緊急管理,如今正持續向更多領域擴展。美國司法部、國土安全部等聯邦機構在推動新的 XML 計畫時,都把 NIEM 當作公共的基礎資料模型與方法論,藉此提升資料與軟體的互操作性、縮短資訊交換應用的設計開發週期,並支持知識資產與技術跨專案重用。
之所以稱 NIEM 為「框架」而非單一詞彙表,是因為它由多個部分組成:
本文是這套四部曲系列的第一篇,將帶你認識 NIEM,並示範如何運用統一建模語言(UML)為一個 NIEM Information Exchange Package Documentation(IEPD)建模。工作模型與最終的 UML 模型皆可於「下載」區取得。
NIEM 的 XML 資料模型提供的是各類公共物件的「積木」。這些積木的粒度可粗可細:可能是「個人姓名」、「生日」這類細緻的元件,也可能是「逮捕」、「訴訟案件」這種較複雜的組合。但請注意,NIEM 模型本身並不定義完整的信息交換訊息(例如「逮捕報告」或「可疑活動報告」),也不指定任何特定訊息類型或 XML 文件的根元素。
要真正把 NIEM 用起来,你必須構建一個 IEPD。IEPD 會從 NIEM 核心與各域模型中挑出所需元素並加以擴展,最終形成一則資訊交換。一個 IEPD 通常包含下列工件:
任何資訊交換專案的首要任務,都是收集並分析需求。NIEM 並未規定必須採用某種特定的需求定義方法,因此本文略過這一環,並假設你在正式動手建立 IEPD 之前,已經對想交換的資料元素、以及用來組織這些元素的消息類型有了初步概念。
本文會從頭到尾拆解一個簡單範例,最終產出一個完整的 IEPD。這個案例是一份簡化的「失竊報告」,用來通報涉及已登記車輛的竊案。假設當地司法機關會用它來通知相關單位(例如機動車管理部門或城市腳踏車登記局)有關機動車與腳踏車遭竊的情形。在需求收集階段,我已經掌握了需要共享的資料大要,並確認只需一種消息類型:失竊報告。(現實中的 IEPD 往往包含多種相關消息類型。)
由於 NIEM 的核心目標之一是資料互操作性,在從零打造新 IEPD 之前,先評估能否重用現成的 IEPD 才是明智之舉。NIEM 設有一個 IEPD 交換所(clearinghouse),可搜尋其他組織已提交的 IEPD。
若始終找不到符合需求的現成 IEPD,那就得自己動手了。構建一個全新的 NIEM IEPD,需要五個步驟:
本文聚焦第 1 步,其餘步驟將由本系列其他文章承接。即便你打算重用既有 IEPD,讀完這個系列也有助於你理解手中 IEPD 的內容與結構。
動手建模之前,先摸清 NIEM 資料模型的結構會很有幫助。NIEM 定義了幾個你或許已在其他建模範式中見過的概念——型別、屬性、關聯等等。
整個 NIEM 模型都以一組 W3C XML Schema 文件的形式實作,並透過註解與參照來標示某物究竟是型別、關聯還是其他。所幸你不必親自啃 XML Schema 才能理解這個模型——NIEM 提供了圖形化的瀏覽與搜尋工具。
一般來說,NIEM 型別會實作為 XML Schema 的複雜型別(complexType),屬性則是這些型別中的子元素。清單 1 展示了一個 ActivityType 如何以複雜型別呈現,ActivityIdentification、ActivityCategoryText 等屬性則被實作為子元素。
清單 1. XML Schema 中的部分 NIEM ActivityType 實作
<xsd:complexType name="ActivityType">
<xsd:complexContent>
<xsd:extension base="s:ComplexObjectType">
<xsd:sequence>
<xsd:element ref="nc:ActivityIdentification" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="nc:ActivityCategoryText" minOccurs="0" maxOccurs="unbounded"/>
<!-- ... -->
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
NIEM 以 XML Schema 的 extension 來做型別派生。清單 2 展示了一個更具體的活動型別 AssessmentType 如何從 ActivityType 派生而來。
清單 2. XML Schema 中的 NIEM 型別派生
<xsd:complexType name="AssessmentType">
<xsd:complexContent>
<xsd:extension base="nc:ActivityType">
<xsd:sequence>
<xsd:element ref="nc:AssessmentScoreText" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="nc:AssessmentFee" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="nc:AssessmentProgram" minOccurs="0" maxOccurs="unbounded"/>
<!-- ... -->
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
關聯則是特殊的複雜型別,內部含有對其所連接型別的參照。清單 3 展示了人與活動之間的關聯——ActivityPersonAssociationType 如何實作。所有關聯型別,都是 NIEM 核心 AssociationType 的直接或間接擴展。
清單 3. XML Schema 中的 NIEM 關聯型別
<xsd:complexType name="ActivityPersonAssociationType">
<xsd:complexContent>
<xsd:extension base="nc:AssociationType">
<xsd:sequence>
<xsd:element ref="nc:ActivityReference" minOccurs="0" maxOccurs="unbounded"/>
<xsd:element ref="nc:PersonReference" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
NIEM 並不強制你使用任何特定的方法論或圖表類型,甚至不要求你一定建模。但建模無疑是 IEPD 設計中極具價值的一環:它能把抽象需求具體化,最終產出對業務與技術人員都有幫助的文件,也為後續步驟提供了寶貴的輸入。
好的選擇是 UML——特別是 UML 類別圖,因為 UML 的概念能與 NIEM 模型概念輕鬆對應。當然,你也可以用個案圖、序列圖等其他 UML 範式來記錄交換。本文聚焦類別圖,因為它對 IEPD 開發流程最為關鍵。
若使用 UML,選一個支援 XML 的工具(如 IBM® Rational® Modeler 或 ArgoUML)會很加分,因為你能據此自動生成一份對應試算表,供下一步使用。本文採用開源的 UML 編輯器 ArgoUML。
有個重要建議:先獨立建立你的初始模型,別急著去遷就 NIEM。唯有不受 NIEM 方法的先入為主影響,模型才能更貼近你的業務真實需求。到了 IEPD 流程的後段,往往只需對初始模型做一些小而關鍵的調整,就能更好地對接 NIEM。但要記住:你的模型與 NIEM 模型之間,終究會存在差異。
受限於篇幅,本文無法完整講解 UML 建模,因此只聚焦 NIEM 特有的要領。一如預期,NIEM 型別以類別圖中的類別表示,屬性則對應類別的屬性(attribute)。
在我的案例中,我辨識出幾個需要交換的類別——例如 Theft、MotorVehicle、Bicycle、Victim、Witness 與 TheftLocation。圖 1 呈現了這些型別及其屬性。
圖 1. 帶有型別及其屬性的初始 UML 模型
查看原圖(大圖)
指定屬性的資料型別時,選用 XML Schema 的內建型別會很管用,因為屬性終究要在 XML 模式中呈現;而且採用共通的型別組,也更容易判斷既有的 NIEM 模型是否恰好符合需求。表 1 列出了最常用的一些 XML Schema 資料型別。
表 1. 常用 XML Schema 資料型別
有些屬性只接受一份列舉值的清單,也就是所謂的「代碼列表」。這些值可以用 UML 註解描述,或記錄在系統文件的其他地方。在我的範例中,為了讓模型保持清爽,我只把它們標成一個名為 code 的資料型別,並在下一步建立對應試算表時,再補上完整的有效值。
NIEM 模型善用泛型,你在合適時機也該跟進。在本案例中,MotorVehicle 與 Bicycle 都是「可能失竊的財產」的具體種類,於是我新增了一個更通用的 Property 類別,並讓 MotorVehicle 與 Bicycle 從它派生。如此一來,SerialNumber 這類共同屬性只需定義一次,關聯也能靠著讓 Property 直接關聯到 Theft 而變得單純。
Victim 與 Witness 看似同理,畢竟它們都只是「人」的更具體種類。但一個人擔任目擊者或受害者的身分是暫時的,因此更適合以「角色」來表達。本例中,同一個人在同一樁失竊案裡甚至能同時是受害者與目擊者——此時你會用兩個不同角色來指涉同一個人。我在模型中透過新增一個獨立的 Person 類別,並建立它到 Victim、Witness 的關聯來呈現這一點,並把這類關聯標記為「Role Of Person」,以凸顯它們是透過角色而非一般關聯相連。圖 2 展示了加入泛型與角色後的模型。
圖 2. 加入了泛型與角色的 UML 模型
查看原圖(大圖)
UML 有三種表達關係的方式:聚合(aggregation)、複合(composition)與關聯(association)。
聚合與複合通常表達「擁有」關係,即一個類別從屬於另一個類別。在本案例中,一個 Person「擁有」一個 PersonName——若沒有對應的 person,PersonName 便毫無意義。聚合與複合在 NIEM 中受到同等對待,最終的 XML 結構裡,附屬類別會被嵌套在其他類別之中,例如一個 Person 元素內含一個 PersonName 元素。
反之,關聯存在於兩個各自獨立、不依賴對方即可存在的類別之間。本案例中,Theft 與 TheftLocation 就是這樣的兩個獨立類別。要在模型裡表達它們的關聯,你可以直接用泛型 UML 關聯;若關聯本身還帶有額外屬性,則可另外新增一個獨立的關聯類別。無論哪種做法,在最終的 NIEM XML 結構中,這些類別都會呈現為明確的元素,並由一個獨立的關聯元素透過參照把它們串起——本例中即為 Theft 與 TheftLocation。我在這裡用複合來表達 Person–PersonName,其餘類別則以簡單的 UML 關聯互連。圖 3 展示了加入關係後的模型。
圖 3. 加入了關係的 UML 模型
查看原圖(大圖)
每則 XML 訊息都必須有一個根。通常一则 XML 交換都有明確的關注點或目的,本例中便是失竊報告本身。於是我在模型裡新增了一個 TheftReport 類別與一個 TheftReportDate 屬性,並在 TheftReport 與 Theft 之間建立聚合關聯,表示這份報告涵蓋了一批失竊案件。
圖 4 呈現了完成後的 UML 模型。它不必完美——事實上,在整個 IEPD 開發過程中反覆迭代、逐步調整結構與命名以更好地貼合 NIEM,本就是常態。
圖 4. 完成的 UML 模型
查看原圖(大圖)
本文從宏觀角度勾勒了創建 NIEM IEPD 的完整步驟,並深入剖析了第一步——建模。這一步的產物,是一份可供後續開發沿用的 UML 模型工作草案。只要你在建模時就善用 NIEM 的專屬概念(如角色與 XML Schema 資料型別),後續每一步都會輕鬆許多。
系列下一篇將接續第 2、3 步:映射與子集劃分。你將學會如何建立一份把 UML 模型映射到 NIEM 的元件對應範本,並據此生成一個與對應相符的 NIEM 模型子集。