題注：
發表這篇解決方案，屬于非盈利目的。主要是為了讓大家了解一種接口技術解決方案文檔的編寫格式以及讓大家評審在我的這個技術解決方案中的不足之處，以便大家指出并加以改進。
轉載，下載或與各種形式使用這篇文章，必須注明文章的作者，出處。
其他未盡事宜，以國家法律規定的為準！
作者：南瘋
|
文檔編號：
|
T-JKJS
|
|
文檔版本：
|
0.01
|
|
項目編號：
|
XX-DX- PECS
|
《XX電信工程外部協作系統》
Project Exterior Cooperation System
施工單位接口技術解決方案
|
編寫人：
|
南瘋
|
日期：
|
2006-10-30
|
|
審核人：
|
|
日期：
|
|
|
批準人：
|
|
日期：
|
|
XXXXXX信息科技股份有限公司
|
地址：
|
XXXXXXX
|
郵編：XXXXXX
|
|
電話：
|
XXXXXXXX
|
傳真：XXXXXX
|
|
網站：
|
XXXXXXXXX
|
|
版本號
|
批準人
|
修改人
|
修改日期
|
修改記錄
|
|
0.01
|
|
南瘋
|
2006-10-30
|
第一次創建
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
0.02詳細修改記錄：
1 引言.... 5
1.1 編寫目的... 5
1.2 覆蓋范圍... 5
1.3 預期讀者與閱讀建議... 5
1.4 文檔約定... 5
1.5 術語與縮略語... 5
1.6 參考文獻... 6
2 概述.... 7
3 接口方式.... 8
4 接口安全.... 9
4.1 接口認證... 9
4.2 數據安全... 10
5 事務處理.... 10
6 性能考慮.... 11
7 容錯處理.... 12
8 數據格式.... 12
8.1 約定... 13
8.2 施工系統向外協系統發送請求... 13
8.2.1 請求查詢一個業務數據... 14
8.2.2 新增一條記錄，得到記錄的鍵值... 17
8.2.3 修改一條記錄... 19
8.2.4 刪除一條記錄... 21
8.2.5 文檔上傳... 23
8.2.6 一條記錄中一個文檔字段上傳多個文件... 25
8.2.7 補充上傳文檔... 26
8.2.8 在記錄中刪除一個文檔... 27
8.2.9 獲得文檔的基本信息... 28
8.2.10 獲得文檔的所有兄弟信息... 31
8.2.11 獲得文檔的所有父親信息... 32
8.2.12 下載一個文檔... 32
8.2.13 獲得字典... 34
8.3 外協系統向施工系統發送請求... 35
8.3.1發送變更后的數據... 36
8.3.2發送變更后的字典... 38
8.3.3文檔發送請求... 40
9 信息數據項.... 40
9.1 數據表... 40
9.2 字段信息... 42
9.3 字典類型... 42
10 網頁地址.... 44
11 Web Service接口.... 44
11.1 接口命名規范... 44
11.2 輸入參數... 44
11.3 輸出參數... 45
11.4 外協系統提供的其他接口... 45
12 附錄：待定問題.... 45
本文檔為XX電信工程外部協作系統（以下簡稱外協系統）與電信工程施工單位內部系統（以下簡稱施工系統）接口技術解決方案，以此作為外協系統與施工系統實施接口的技術方案依據和項目設計標準。
XX電信工程外部協作系統項目組
施工系統接口開發技術組
XX電信企業信息化部
XX電信工程建設部
XXXX公司開發人員
施工系統開發人員
粗體正文表示強調內容
紅色正文表示未完成或需要今后考慮的內容
藍色正文表示待討論內容
1.5 術語與縮略語
|
術語、縮略語
|
定 義
|
|
外協系統
|
XX電信工程外部協作系統
|
|
施工系統
|
電信工程施工單位內部系統
|
|
PECS
|
XX電信工程外部協作系統英文簡稱
|
|
|
|
|
|
|
(XXXX)
建設XX電信工程外部協作系統的目標，是在工程項目的管理、建設、使用和實施單位之間搭建起數據交換和協同工作的信息平臺，延伸與拓展工程建設管理信息化的應用范圍，實現通信工程建設過程的信息化管理，促進工程項目的管理部門、建設部門、實施部門和使用部門之間業務流程協調有序地開展，實現工程項目設計、施工、監理管理功能，將相關的設計、施工、監理單位納入到工程建設管理中，完善工程項目建設過程管理體系，通過信息化推動管理的規范化，在信息化的應用過程中不斷探索市場環境下工程建設管理的新思路和新方法。
根據工程部業務工作的實際情況，項目首先滿足工程建設管理中應用最廣泛、問題最突出的基本需求。
項目功能需求包括：
Ø 建立工程外部協作系統與MSS等系統的接口；
Ø 建立設計協作服務、監理協作服務、施工協作服務模塊，為郵電設計院、電話監理公司和電信工程公司提供工程部所需的協作服務，保證工程建設實施流程的開展；
Ø 在建立工程協作服務模塊的基礎上，建立工程外部協作系統與郵電設計院、電話監理公司、電信工程公司信息系統的接口，實現工程部與三家實施單位的信息交互與業務協作；
本技術解決方案就是針對實現工程建設部與三家實施單位信息交互與業務協作接口中施工單位接口的技術解決方案的組成部分。
在接口的調用過程中，存在施工系統調用外協系統接口的情況，這時候，施工系統作為客戶端，外協系統作為服務端；也存在外協系統調用施工系統的情況，這時候，外協系統作為客戶端，施工系統作為服務端。本方案中，除了特殊另外說明外，不考慮外協系統和施工系統角色換位的問題。如果一方發起了調用，那么它就是客戶端，另一方就是服務端。反之亦然。
u 工程外協系統與施工系統之間的接口采用Web Service接口形式來進行業務數據的交互。
u 接口數據傳輸采用XML數據交換格式，utf-8編碼。
u 在外協系統中提供Web Service的API接口。提供由施工系統調用獲得信息；并且提供施工系統提交信息的API接口。
u 同樣，在施工系統中提供Web Service的API接口。提供由外協系統提交信息的API接口。
u 考慮到工程外協中的數據信息不僅包括了XX電信工程公司的數據而且還包含了其他的施工單位的數據信息。而這些單位也各有其各自工程應用系統。這樣，外協系統對各個施工單位系統所提供的接口API及其參數信息、格式均是統一的。同時，也要求各個施工單位所提供的接口API及其參數、格式等也必須要求統一。外協系統與施工系統屬于一對多的關系。
u 外協系統要求能夠有目的，信息有過濾的把業務信息通過接口正確的發送給相應施工系統接口。非相關的信息不要發送給對應的施工系統。
u 施工系統建立用戶映像對照表、字典對照表、單位對照表等數據映像，傳遞給外協的數據使用的是映像中轉換后的外協系統能夠識別數據；同時，接收到的數據也根據對照表轉換成各自能夠解釋的數據格式。
u 數據初始化的時候，由施工系統主動調用外協系統的接口，以獲得用戶信息、字典信息、單位信息、項目信息等基礎信息。以后，一旦發生數據的變動，由外協系統主動往施工系統發送信息。
u 外協系統不主動請求施工系統獲得數據，但是外協系統會主動請求施工系統發送數據。
u 施工系統主動請求外協系統獲得數據，也會主動請求外協系統發送數據。