項(xiàng)目接口需求及設(shè)計(jì)說明文檔(模板)可編輯

客戶化開發(fā)需求規(guī)格說明書客戶化開發(fā)需求規(guī)格說明書媒訊集團(tuán)EAS項(xiàng)目CTC與EAS接口需求及設(shè)計(jì)說明書文檔作者： 創(chuàng)建日期： 2013-05-10確認(rèn)日期： 當(dāng)前版本： 1.0拷貝數(shù)量： 1審批簽字:客戶方：實(shí)施方：PAGE3文檔控制 修改記錄日期作者版本參考版本備注目錄TOC\o"1-3"\h\u1. 概述 41.1讀者 41.2圖例 41.3目的 4二、業(yè)務(wù)現(xiàn)狀 5三、概要設(shè)計(jì) 53.1接口通訊方式 53.2通訊內(nèi)容定義 53.3媒訊CTC系統(tǒng)提供接口使用范例 53.4金蝶EAS提供接口使用范例 53.5媒訊CTC系統(tǒng)提供接口服務(wù)地址 73.6金蝶EAS提供接口服務(wù)地址 73.7接口需求 7四、詳細(xì)設(shè)計(jì) 84.1XXEAS接口 8概述金蝶與用戶及用戶業(yè)務(wù)系統(tǒng)方通過多次討論，制定了接口開發(fā)需求設(shè)計(jì)說明書，作為雙方后續(xù)開發(fā)指引。1.1讀者本文讀者對象為業(yè)務(wù)管理人員、系統(tǒng)設(shè)計(jì)、開發(fā)人員、測試人員。1.2圖例本文中如未進(jìn)行特殊說明，各圖標(biāo)代表的含義如下：表示一個活動；表示動態(tài)的業(yè)務(wù)數(shù)據(jù)，如系統(tǒng)單據(jù)；表示流程走向；表示條件判斷、流程分支；表示靜態(tài)的業(yè)務(wù)數(shù)據(jù)，如基礎(chǔ)資料；表示系統(tǒng)外一個手工處理活動；表示系統(tǒng)外手工填制的單據(jù)；表示當(dāng)前系統(tǒng)之外的活動；表示當(dāng)前系統(tǒng)之外產(chǎn)生的業(yè)務(wù)數(shù)據(jù)。1.3目的本文檔是媒訊CTC系統(tǒng)與EAS系統(tǒng)接口的需求及設(shè)計(jì)方案相關(guān)文檔，可用于指導(dǎo)開發(fā)、測試工作和作為驗(yàn)收相關(guān)依據(jù)文檔。二、業(yè)務(wù)現(xiàn)狀待補(bǔ)充三、概要設(shè)計(jì)3.1接口通訊方式金蝶EAS與媒訊CTC系統(tǒng)之間通訊采用WebService方式進(jìn)行數(shù)據(jù)傳輸。3.2通訊內(nèi)容定義對于記錄型的大對象，在通訊時，采用String型的xml格式的參數(shù)進(jìn)行傳遞。對于其他非記錄型的對象，在通訊時，可采用非xml格式的參數(shù)進(jìn)行傳遞，也可使用多個參數(shù)。具體格式，請參照每個接口的通訊用例說明。3.3媒訊CTC系統(tǒng)提供接口使用范例待補(bǔ)充。3.4金蝶EAS提供接口使用范例3.4.1規(guī)范說明EAS通過webService接口與異構(gòu)系統(tǒng)通信。EASWebService全部是使用java編寫的，其接口描述符合WSDL國際標(biāo)準(zhǔn)，其數(shù)據(jù)描述符合XSD國際標(biāo)準(zhǔn)。本次提供的接口除系統(tǒng)登錄接口外，其他接口都需要調(diào)用登錄接口，以便將登陸的SessionId信息放入到SOAP的HEADER報文中。3.4.2使用示例金蝶在EAS上發(fā)布WebService服務(wù)，提供wsdl文件供客戶端下載，其他業(yè)務(wù)系統(tǒng)根據(jù)下載的wsdl文件，產(chǎn)生客戶端。建議使用Axis2來生成客戶端代理。下面是登錄接口調(diào)用參數(shù)說明：接口地址http://ip:port/ormrpc/services/EASLogin方法名稱login參數(shù)列表參數(shù)名稱別名類型備注userNameEAS用戶名StringEAS系統(tǒng)一個非異常的賬戶的用戶名Password密碼String用戶名對應(yīng)的密碼slnName都為easdataCenterName數(shù)據(jù)中心idStringEAS對應(yīng)的數(shù)據(jù)中心Language語言String默認(rèn)為L2即可dbType數(shù)據(jù)庫類型int0sqlserver1oracle2db2相關(guān)對象描述不需要任何對象類型的數(shù)據(jù)錯誤列表錯誤代碼錯誤概述詳細(xì)說明概要邏輯說明無調(diào)用者說明無其他說明無以下是Java客戶端調(diào)用Javawebservices接口的調(diào)用代碼示例:publicclassDemo{publicstaticvoidmain(String[]args)throwsException{Demodemo=newDemo();demo.login();}/***EAS登錄*login方法的參數(shù)分別代表為:*java.lang.StringuserName用戶名,*java.lang.Stringpassword密碼,*java.lang.StringslnNameeas,*java.lang.StringdcName數(shù)據(jù)中心代碼,*java.lang.Stringlanguage語言，簡體中文為L2,*intdbType0sqlserver1oracle2db2*@throwsException*/privatevoidlogin()throwsException{StringEASLogin_address="http://IP:6888/ormrpc/services/EASLogin";URLurl=newURL(EASLogin_address);EASLoginProxyproxy=newEASLoginProxyServiceLocator().getEASLogin(url);WSContextctx=proxy.login("user","pwd","eas","001","L2",1);if(ws!=null&&ws.getSessionId()!=null){ System.out.println("登錄成功"); } else { System.out.println("登錄失敗"); }}}3.5媒訊CTC系統(tǒng)提供接口服務(wù)地址待三地方補(bǔ)充。3.6金蝶EAS提供接口服務(wù)地址測試環(huán)境：HYPERLINK09:6888/ormrpc/services正式環(huán)境：:6888/ormrpc/services建議把IP地址和端口做成一個可配置參數(shù)。3.7接口需求3.7.1接口概況本次集成業(yè)務(wù)所涉及的接口如下表所示:序號接口名稱數(shù)據(jù)發(fā)送方數(shù)據(jù)接收方接口提供者接口調(diào)用者3.7.2接口說明接口處理過程說明：其他邏輯控制說明：3.7.3其他要求四、詳細(xì)設(shè)計(jì)4.1XXEAS接口4.1.1設(shè)計(jì)說明此接口由EAS端(提供者)開發(fā)，供媒訊CTC系統(tǒng)(調(diào)用者)調(diào)用。4.1.2通訊內(nèi)容接口地址方法名稱參數(shù)列表參數(shù)名稱別名類型備注返回值對象描述bill錯誤列表錯誤代碼錯誤概述概要說明調(diào)用者說明其他說明4.1.3通訊用例--xmlData格式例子<ComplaintBill><bill><number>201220383</numbe