項目接口需求及設計說明文檔(模板).doc

客戶化開發(fā)需求規(guī)格說明書媒訊集團EAS項目CTC與EAS接口需求及設計說明書文檔作者：創(chuàng)建日期：2013-05-10確認日期：當前版本：1.0拷貝數(shù)量：1審批簽字:客戶方：實施方：文檔控制修改記錄日期作者版本參考版本備注目錄1.概述41.1讀者41.2圖例41.3目的4二、業(yè)務現(xiàn)狀5三、概要設計53.1接口通訊方式53.2通訊內容定義53.3媒訊CTC系統(tǒng)提供接口使用范例53.4金蝶EAS提供接口使用范例53.5媒訊CTC系統(tǒng)提供接口服務地址73.6金蝶EAS提供接口服務地址73.7接口需求7四、詳細設計84.1XX EAS接口81. 概述金蝶與用戶及用戶業(yè)務系統(tǒng)方通過多次討論，制定了接口開發(fā)需求設計說明書，作為雙方后續(xù)開發(fā)指引。1.1讀者本文讀者對象為業(yè)務管理人員、系統(tǒng)設計、開發(fā)人員、測試人員。1.2圖例本文中如未進行特殊說明，各圖標代表的含義如下：表示一個活動；表示動態(tài)的業(yè)務數(shù)據(jù)，如系統(tǒng)單據(jù)；表示流程走向；表示條件判斷、流程分支；表示靜態(tài)的業(yè)務數(shù)據(jù)，如基礎資料；表示系統(tǒng)外一個手工處理活動；表示系統(tǒng)外手工填制的單據(jù)；表示當前系統(tǒng)之外的活動；表示當前系統(tǒng)之外產(chǎn)生的業(yè)務數(shù)據(jù)。1.3目的本文檔是媒訊CTC系統(tǒng)與EAS系統(tǒng)接口的需求及設計方案相關文檔，可用于指導開發(fā)、測試工作和作為驗收相關依據(jù)文檔。二、業(yè)務現(xiàn)狀待補充三、概要設計3.1接口通訊方式金蝶EAS與媒訊CTC系統(tǒng)之間通訊采用WebService方式進行數(shù)據(jù)傳輸。3.2通訊內容定義對于記錄型的大對象，在通訊時，采用String型的xml格式的參數(shù)進行傳遞。對于其他非記錄型的對象，在通訊時，可采用非xml格式的參數(shù)進行傳遞，也可使用多個參數(shù)。具體格式，請參照每個接口的通訊用例說明。3.3媒訊CTC系統(tǒng)提供接口使用范例待補充。3.4金蝶EAS提供接口使用范例3.4.1規(guī)范說明EAS通過webService接口與異構系統(tǒng)通信。EAS WebService全部是使用java編寫的，其接口描述符合WSDL國際標準，其數(shù)據(jù)描述符合XSD 國際標準。本次提供的接口除系統(tǒng)登錄接口外，其他接口都需要調用登錄接口，以便將登陸的SessionId信息放入到 SOAP 的 HEADER 報文中。3.4.2使用示例金蝶在EAS上發(fā)布WebService服務，提供wsdl文件供客戶端下載，其他業(yè)務系統(tǒng)根據(jù)下載的wsdl文件，產(chǎn)生客戶端。建議使用Axis2來生成客戶端代理。下面是登錄接口調用參數(shù)說明：接口地址http:/ip:port/ormrpc/services/EASLogin方法名稱login參數(shù)列表參數(shù)名稱別名類型備注userNameEAS用戶名StringEAS系統(tǒng)一個非異常的賬戶的用戶名Password密碼String用戶名對應的密碼slnName都為easdataCenterName數(shù)據(jù)中心idStringEAS對應的數(shù)據(jù)中心Language語言String默認為L2即可dbType數(shù)據(jù)庫類型int0 sql server1 oracle2 db2相關對象描述不需要任何對象類型的數(shù)據(jù)錯誤列表錯誤代碼錯誤概述詳細說明概要邏輯說明無調用者說明無其他說明無以下是Java客戶端調用Java webservices接口的調用代碼示例:public class Demo public static void main(String args) throws Exception Demo demo = new Demo(); demo.login();/* * EAS登錄 * login方法的參數(shù)分別代表為: * java.lang.String userName 用戶名, * java.lang.String password 密碼, * java.lang.String slnName eas, * java.lang.String dcName 數(shù)據(jù)中心代碼, * java.lang.String language 語言，簡體中文為L2, * int dbType 0 sql server 1 oracle 2 db2 * throws Exception */private void login() throws Exception String EASLogin_address =http:/IP:6888/ormrpc/services/EASLogin; URL url = new URL(EASLogin_address);EASLoginProxy proxy=new EASLoginProxyServiceLocator().getEASLogin(url); WSContext ctx = proxy.login(user, pwd, eas, 001, L2, 1);if(ws != null& ws.getSessionId() !=null)System.out.println(登錄成功);elseSystem.out.println(登錄失敗);3.5媒訊CTC系統(tǒng)提供接口服務地址待三地方補充。3.6金蝶EAS提供接口服務地址測試環(huán)境：09:6888/ormrpc/services正式環(huán)境：:6888/ormrpc/services建議把IP地址和端口做成一個可配置參數(shù)。3.7接口需求3.7.1接口概況本次集成業(yè)務所涉及的接口如下表所示:序號接口名稱數(shù)據(jù)發(fā)送方數(shù)據(jù)接收方接口提供者接口調用者3.7.2接口說明接口處理過程說明：其他邏輯控制說明：3.7.3其他要求四、詳細設計4.1XX EAS接口4.1.1設計說明此接口由EAS端(提供者)開發(fā)，供媒訊CTC系統(tǒng) (調用者)調用。4.1.2通訊