U8API開發(fā)手冊(cè)(C#版)_第1頁(yè)
U8API開發(fā)手冊(cè)(C#版)_第2頁(yè)
U8API開發(fā)手冊(cè)(C#版)_第3頁(yè)
U8API開發(fā)手冊(cè)(C#版)_第4頁(yè)
U8API開發(fā)手冊(cè)(C#版)_第5頁(yè)
已閱讀5頁(yè),還剩26頁(yè)未讀, 繼續(xù)免費(fèi)閱讀

下載本文檔

版權(quán)說(shuō)明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請(qǐng)進(jìn)行舉報(bào)或認(rèn)領(lǐng)

文檔簡(jiǎn)介

1、.U8API開發(fā)手冊(cè)作者:商平鋒版權(quán)所有:用友軟件股份有限公司1.簡(jiǎn)介U8API是為U8客戶化應(yīng)用開發(fā)提供的一套標(biāo)準(zhǔn)化的U8ERP業(yè)務(wù)編程接口。是U8UAP二次開發(fā)體系的重要組成部分。它包括一整套涵蓋U8ERP采購(gòu)、銷售、庫(kù)存、制造(規(guī)劃中)、財(cái)務(wù)(規(guī)劃中)、基本檔案(規(guī)劃中)等業(yè)務(wù)模塊的API接口資源。U8API的推出為U8標(biāo)準(zhǔn)產(chǎn)品更好的適應(yīng)用戶的個(gè)性化需求,更好的實(shí)現(xiàn)客戶化交付提供了有力支持。U8API按照U8ERP業(yè)務(wù)產(chǎn)品模塊進(jìn)行分類,并以U8主要業(yè)務(wù)實(shí)體(單據(jù)、檔案、憑證)作為操作對(duì)象,提供了常用的基本操作。比如:對(duì)于庫(kù)存的收發(fā)單據(jù),提供“新增”、“審核”、“棄審”、“刪除”、“裝載”

2、、“修改”六個(gè)API接口。目前,U8API提供了供應(yīng)鏈采購(gòu)、銷售、庫(kù)存三個(gè)產(chǎn)品的所有單據(jù)的增刪改、審核/棄審等API接口,后續(xù)版本會(huì)逐步將制造、財(cái)務(wù)、基本檔案等模塊的API納入進(jìn)來(lái)。U8API通過(guò)“U8API資源管理器”對(duì)U8范圍內(nèi)所有API進(jìn)行集中統(tǒng)一分類管理,形成了一套完整的U8API資源庫(kù)。U8API的使用者可以使用“U8API資源管理器”瀏覽、查看API及其接口定義,并可輔助進(jìn)行代碼生成(目前支持C#和VB語(yǔ)言);API的開發(fā)者可以通過(guò)此工具發(fā)布、注冊(cè)API,所有業(yè)務(wù)API都必須在“U8API資源管理器”中進(jìn)行注冊(cè)。U8API還提供了一套運(yùn)行時(shí)調(diào)用框架U8APIBroker。它是所有U

3、8API的調(diào)用代理,用戶要使用某個(gè)API只需調(diào)用U8APIBroker即可,無(wú)需直接訪問(wèn)真正的API。U8APIBroker作為一個(gè)服務(wù)代理中間件,起到了隔離API的提供者與使用者的作用,降低了耦合依賴關(guān)系。U8API與U8EAI接口從功能上看比較相識(shí),但它們的特性有差別。U8API采用傳統(tǒng)的編程模型,更靠近底層,業(yè)務(wù)邏輯粒度更細(xì),而且還需要或依賴一些特定的上下文環(huán)境,比如:login、事務(wù)等;而U8EAI接口則是完全松耦合的,采用XML和請(qǐng)求/響應(yīng)的消息傳遞模式,且業(yè)務(wù)粒度比較粗放。這些特性的差別決定了它們的應(yīng)用領(lǐng)域不同,U8API更適合于U8內(nèi)部的功能擴(kuò)展和客戶個(gè)性化開發(fā),而U8EAI則適

4、合外部系統(tǒng)與U8之間以業(yè)務(wù)數(shù)據(jù)交換為特征的應(yīng)用集成開發(fā)。2.API應(yīng)用2.1. API總體應(yīng)用過(guò)程2.1.1 API瀏覽查找在“開始”-“程序”-“用友ERP-U8”-“UAP”目錄下找到“U8API資源管理器”,單擊,登錄,進(jìn)入“U8API資源管理器”。在左側(cè) “U8API” 樹形節(jié)點(diǎn)下,找到某某模塊,如“庫(kù)存管理”模塊(可以看到下面列有很多個(gè)單據(jù),如盤點(diǎn)單、采購(gòu)入庫(kù)單等),展開要操作的單據(jù),分兩個(gè)子節(jié)點(diǎn):“事件”和“服務(wù)接口”,在“服務(wù)接口”下可以看到該單據(jù)提供的API接口,如“添加新單據(jù)”、“審核單據(jù)”等。雙擊這些節(jié)點(diǎn)出現(xiàn)該API的詳細(xì)描述,如下圖2.1所示。在節(jié)點(diǎn)上右鍵單擊彈出“上下文

5、菜單”,在“代碼示例”菜單項(xiàng)上彈出下一級(jí)子菜單,單擊它們,如單擊“C#代碼示例”則可以看到調(diào)用該API的C#示例代碼,如下圖2.2所示。直接拷貝這些代碼,然后在集成開發(fā)環(huán)境(IDE)中編輯和編譯這些代碼,即能實(shí)現(xiàn)調(diào)用U8標(biāo)準(zhǔn)API。利用這些代碼示例時(shí),請(qǐng)按照其中每一步驟的提示說(shuō)明正確操作,如添加必要的引用、按照自動(dòng)生成的代碼填入正確的參數(shù)等。正確使用則可以調(diào)用成功,否則會(huì)返回詳細(xì)的錯(cuò)誤信息。以下代碼中均以C#為例,VB語(yǔ)言請(qǐng)具體查看對(duì)應(yīng)的VB代碼示例部分。圖2.1 接口描述圖 2.2 代碼示例2.1.2 API調(diào)用過(guò)程 組件引用針對(duì)兩種語(yǔ)言,需要引用不同的組件。(1) C#:%U8SOFT%I

6、nteropInterop.U8Login.dll、%U8SOFT%InteropInterop.MSXML2.dll、%U8SOFT%UFMOMU8APIFrameworkUFIDA.U8.U8APIFramework.dll、%U8SOFT%UFMOMU8APIFrameworkUFIDA.U8.MomServiceCommon.dll、%U8SOFT%UFMOMU8APIFrameworkUFIDA.U8.U8MOMAPIFramework.dll如下圖2.3、2.4、2.5所示。(2)VB:%U8SOFT%UFMOMU8APIFrameworkUFIDA.U8.U8APIFramewo

7、rk. tlb、%U8SOFT%UFMOMU8APIFrameworkUFIDA.U8.MomServiceCommon. tlb、%U8SOFT%UFMOMU8APIFrameworkUFIDA.U8.U8MOMAPIFramework. tlb、添加Microsoft XML v3.0引用如下圖2.6、2.7所示。其中,%U8SOFT%表示U8-872的安裝目錄。圖 2.3 添加對(duì)U8Login.dll引用圖 2.4 添加對(duì)Interop.MSXML2.dll引用圖 2.5 添加對(duì)U8API框架類庫(kù)引用(.dll)圖2.6 添加對(duì)U8API框架類庫(kù)引用(.tlb)圖2.7 添加Micros

8、oft XML v3.0引用 API調(diào)用添加必要的引用后,可以直接利用自動(dòng)生成的代碼示例(支持C#和VB兩種語(yǔ)言),結(jié)合API接口詳細(xì)描述,填入必要的參數(shù)值,就可以調(diào)用U8 API??傮w上,對(duì)U8 API的調(diào)用分成七個(gè)步驟:1) 構(gòu)造u8login對(duì)象并登陸;2) 構(gòu)造環(huán)境上下文對(duì)象,傳入login,并按需設(shè)置其它上下文參數(shù);3) 設(shè)置API地址標(biāo)識(shí)(Url)參數(shù);4) 構(gòu)造APIBroker;5) API參數(shù)賦值;6) 調(diào)用API;7) 獲取返回結(jié)果。詳細(xì)的API調(diào)用過(guò)程請(qǐng)看下文“API內(nèi)容”中各個(gè)模塊中介紹的“開發(fā)步驟”。下面重點(diǎn)介紹幾個(gè)關(guān)鍵要點(diǎn)和步驟:環(huán)境上下文、API地址、APIBro

9、ker、普通參數(shù)賦值、BO參數(shù)賦值。 環(huán)境上下文環(huán)境上下文指在調(diào)用U8API時(shí)需要初始化的調(diào)用環(huán)境,包括Login、事務(wù)、特殊的業(yè)務(wù)參數(shù)等。環(huán)境上下文被初始化后,相關(guān)的環(huán)境參數(shù)會(huì)被業(yè)務(wù)API使用。U8EnvContext envContext = new U8EnvContext();l Login需要將U8Login對(duì)象傳遞給環(huán)境上下文,U8Login對(duì)象必須已經(jīng)登錄過(guò)。envContext.U8Login = u8Login;l 事務(wù)如果需要由外部發(fā)起事務(wù),則可以發(fā)起事務(wù)的ADOConnection對(duì)象傳遞給環(huán)境上下文:ADODB.ConnectionClass conn = new Co

10、nnectionClass();envContext.BizDbConnection = conn;同時(shí)需要設(shè)置一個(gè)外部事務(wù)標(biāo)記:envContext.IsIndependenceTransaction = true;l 特殊業(yè)務(wù)參數(shù)特殊業(yè)務(wù)參數(shù)指調(diào)用某些API需要設(shè)置的特定上下文參數(shù),比如:銷售的API必須要設(shè)置如VoucherType上下文參數(shù),設(shè)置方法為:envContext.SetApiContext(VoucherType, 23); API地址API地址是指API在U8API系統(tǒng)中的唯一標(biāo)識(shí),也叫API的URI,調(diào)用API時(shí),需要通過(guò)API地址構(gòu)建一個(gè)代表此API的Broker對(duì)象

11、:U8ApiAddress myApiAddress = new U8ApiAddress(U8API/PurchaseOrder/VoucherSave); APIBrokerAPIBroker是所有U8API的調(diào)用代理接口。使用U8所有API都必須通過(guò)APIBroker間接調(diào)用。APIBroker作為一個(gè)服務(wù)代理中間件,起到了隔離API的提供者與使用者的作用,降低了耦合依賴關(guān)系。創(chuàng)建APIBroker必須傳入API地址和環(huán)境上下文:U8ApiBroker broker = new U8ApiBroker(myApiAddress, envContext); 普通參數(shù)賦值A(chǔ)PI參數(shù)分兩種類型

12、:BO參數(shù)和普通參數(shù)。普通參數(shù)是指非單據(jù)表頭表體類型的參數(shù),包括基本類型參數(shù)(String、Integer等)、知名對(duì)象參數(shù)(Connection、DOMDocument等)。普通參數(shù)的賦值采用如下方式:broker.AssignNormalValue(voucherState, 2); BO參數(shù)賦值BO參數(shù)即單據(jù)表頭或表體類型的參數(shù)。對(duì)BO參數(shù),支持兩種方式傳入,一種傳BO對(duì)象,另一種傳DOM對(duì)象。以下分別介紹:l 傳BO對(duì)象給BO表頭參數(shù)或表體參數(shù)賦值,推薦使用BO對(duì)象(BussinessObject)。例如: BusinessObject DomHead = broker.GetBoPa

13、ram(DomHead);DomHead.RowCount = 10; /設(shè)置行數(shù),不設(shè)置也可/給BO對(duì)象的字段賦值,值可以是真實(shí)類型,也可以是無(wú)類型字符串/以下代碼示例只設(shè)置第一行值。各字段定義詳見API服務(wù)接口定義/* 以下是必輸字段*/DomHead0poid = ; /主關(guān)鍵字段,int類型DomHead0dpodate = ; /日期,DateTime類型DomHead0cpoid = ; /訂單編號(hào),string類型/* 以下是非必輸字段*/DomHead0ipresent = ; /現(xiàn)存量,string類型DomHead0cmaketime = ; /制單時(shí)間,DateTime類

14、型DomHead0cmodifytime = ; /修改時(shí)間,DateTime類型在此種情況下U8 API框架會(huì)對(duì)BO對(duì)象各字段進(jìn)行參數(shù)校驗(yàn)。對(duì)字段進(jìn)行賦值時(shí),值可以是真實(shí)類型,也可以是無(wú)類型字符串。l 傳DOM對(duì)象給BO表頭參數(shù)或表體參數(shù)賦值,也支持直接傳入DOM對(duì)象(DOMDocument)。例如:MSXML2.DOMDocumentClass domHead = new MSXML2.DOMDocumentClass();domHead.load(domHead.xml);broker.AssignNormalValue(domHead, domHead);但是,在此種情況下U8 API

15、框架不會(huì)對(duì)DOM對(duì)象進(jìn)行參數(shù)驗(yàn)證。請(qǐng)?jiān)谑褂迷摲椒ㄖ?,確保DOM對(duì)象的正確性。2.1.3 API典型應(yīng)用場(chǎng)景 執(zhí)行單一操作單一操作指一項(xiàng)任務(wù)只需要一個(gè)API完成,比如:?jiǎn)螕?jù)新增、審核/棄審、刪除等單一操作。這是API調(diào)用最常見的場(chǎng)景,只需按照API的接口規(guī)范構(gòu)造參數(shù)直接調(diào)用即可。 執(zhí)行復(fù)合操作復(fù)合操作,即一項(xiàng)任務(wù)由多個(gè)API的協(xié)作來(lái)完成。比如,自定義的單據(jù)維護(hù)界面的主要邏輯,一般由以下四個(gè)步驟構(gòu)成:1) 加載單據(jù);2) 在編輯界面上顯示;3) 用戶修改單據(jù)字段;4) 提交保存。以上步驟需要進(jìn)行兩次API調(diào)用:1) 加載單據(jù)時(shí)候調(diào)用“加載API”,以獲取單據(jù)BO對(duì)象(或原始DOM對(duì)象)并在界面上

16、展現(xiàn);2) 用戶在修改單據(jù)時(shí)其實(shí)就是在修改BO對(duì)象,用戶保存單據(jù)時(shí)調(diào)用“保存API”,此時(shí)要將此BO對(duì)象傳給“保存API”(而不用構(gòu)造新的BO對(duì)象)。代碼示例:首先,登陸;/構(gòu)造u8login對(duì)象并登陸U8Login.clsLogin u8Login = new U8Login.clsLogin();String sSubId = AS;String sAccID = (default)001;String sYear = 2008;String sUserID = demo;String sPassword = ;String sDate = 2008-09-30;String sServe

17、r = localhost;String sSerial = ;if (!u8Login.Login(ref sSubId, ref sAccID, ref sYear, ref sUserID, ref sPassword, ref sDate, ref sServer, ref sSerial)Console.WriteLine(登陸失敗,原因: + u8Login.ShareString);Marshal.FinalReleaseComObject(u8Login);return;然后,通過(guò)LOAD接口獲取BO對(duì)象;/構(gòu)造環(huán)境上下文對(duì)象,傳入login,并按需設(shè)置其它上下文參數(shù)U8Env

18、Context envContext = new U8EnvContext();envContext.U8Login = u8Login;/設(shè)置上下文參數(shù)/設(shè)置API地址標(biāo)識(shí)(Url)U8ApiAddress myApiAddress = new U8ApiAddress(“裝載單據(jù)的地址標(biāo)識(shí)”);/構(gòu)造APIBrokerU8ApiBroker broker = new U8ApiBroker(myApiAddress, envContext);/API參數(shù)賦值broker.AssignNormalValue(參數(shù)名, 參數(shù)值);/調(diào)用LOAD接口APIif (!broker.Invoke()

19、/錯(cuò)誤處理Exception apiEx = broker.GetException();if (apiEx != null)if (apiEx is MomSysException)MomSysException sysEx = apiEx as MomSysException;Console.WriteLine(系統(tǒng)異常: + sysEx.Message);/todo:異常處理else if (apiEx is MomBizException)MomBizException bizEx = apiEx as MomBizException;Console.WriteLine(API異常:

20、+ bizEx.Message);/todo:異常處理/結(jié)束本次調(diào)用,釋放API資源broker.Release();return;/獲取表頭或表體的BO對(duì)象,如果要取原始的XMLDOM對(duì)象結(jié)果,請(qǐng)使用GetResult(參數(shù)名)BusinessObject DomRet = broker.GetBoParam(表頭或表體參數(shù)名);接著,BO對(duì)象經(jīng)用戶修改重新賦值,并傳遞給UPDATE接口提交保存;/修改獲取的BO對(duì)象,對(duì)需要更改的字段重新賦值DomRet0字段名 = 新的字段值;/重新構(gòu)造“新增或修改”API的地址標(biāo)識(shí)myApiAddress = new U8ApiAddress(新增或修改

21、”API的地址標(biāo)識(shí));/重新構(gòu)造APIBrokerbroker = new U8ApiBroker(myApiAddress, envContext);/表頭或表體參數(shù)賦值broker.SetBoParam(表頭或表體參數(shù)名, DomRet);/API參數(shù)賦值broker.AssignNormalValue(參數(shù)名, 參數(shù)值);/調(diào)用UPDATE接口APIif (!broker.Invoke()最后,獲取返回結(jié)果。/獲取普通返回值System.String result = broker.GetReturnValue() as System.String;/獲取out/inout參數(shù)值/結(jié)束本

22、次調(diào)用,釋放API資源broker.Release();2.2. API內(nèi)容2.2.1 采購(gòu)管理 功能介紹為了支持U8二次開發(fā)對(duì)業(yè)務(wù)單據(jù)的開發(fā),本功能提供了實(shí)現(xiàn)采購(gòu)業(yè)務(wù)單據(jù)各種操作功能的編程接口。使用采購(gòu)管理的API開發(fā)接口,可以對(duì)庫(kù)存管理中的采購(gòu)到貨單、采購(gòu)普通發(fā)票、采購(gòu)專用發(fā)票、采購(gòu)訂單、請(qǐng)購(gòu)單、采購(gòu)運(yùn)費(fèi)發(fā)票等單據(jù)進(jìn)行審核、棄審、獲?。ɑ蜓b載)、新增、修改、刪除。 使用環(huán)境必須安裝.NET FrameWork 2.0;必須安裝U8-872版本的采購(gòu)管理產(chǎn)品;必須安裝API適配器組件PUAPIConcrete.dll 接口說(shuō)明采購(gòu)管理二次開發(fā)接口說(shuō)明:n 審核單據(jù)-ConfirmPO方法參數(shù)

23、:domHead 單據(jù)表頭,DOM對(duì)象,必輸API上下文:VoucherType 單據(jù)類型,具體類型參看API上下文描述bPositive 紅藍(lán)標(biāo)識(shí):True,藍(lán)字 ;False,紅字sBillType 為空串 sBusType 業(yè)務(wù)類型:普通采購(gòu),直運(yùn)采購(gòu),受托代銷n 棄審單據(jù)- CancelconfirmPO方法參數(shù):domHead 單據(jù)表頭,DOM對(duì)象,必輸API上下文:VoucherType 單據(jù)類型,具體類型參看API上下文描述bPositive 紅藍(lán)標(biāo)識(shí):True,藍(lán)字 ;False,紅字sBillType 為空串 sBusType 業(yè)務(wù)類型:普通采購(gòu),直運(yùn)采購(gòu),受托代銷n 裝載單

24、據(jù)-Load方法參數(shù):DomHead 表頭DOM對(duì)象domBody 表體DOM對(duì)象strWhere 過(guò)濾條件串varVoucherID 單據(jù)主表IDstrLocateWhere 定位條件串API上下文:VoucherType 單據(jù)類型,具體類型參看API上下文描述bPositive 紅藍(lán)標(biāo)識(shí):True,藍(lán)字 ;False,紅字sBillType 為空串 sBusType 業(yè)務(wù)類型:普通采購(gòu),直運(yùn)采購(gòu),受托代銷n 刪除單據(jù)-Delete方法參數(shù):DomHead 表頭DOM對(duì)象domBody 表體DOM對(duì)象CurDom 返回DOM格式錯(cuò)誤信息API上下文:VoucherType 單據(jù)類型,具體類型

25、參看API上下文描述bPositive 紅藍(lán)標(biāo)識(shí):True,藍(lán)字 ;False,紅字sBillType 為空串 sBusType 業(yè)務(wù)類型:普通采購(gòu),直運(yùn)采購(gòu),受托代銷n 新增或修改新單據(jù)- VoucherSave方法參數(shù):DomHead 單據(jù)表頭,DOM對(duì)象,必輸 domBody 單據(jù)表體,DOM對(duì)象,必輸 VoucherState 保存狀態(tài),必輸。2增加;1修改 ;0非編輯curID 返回單據(jù)頭ID CurDom 返回DOM格式錯(cuò)誤信息UserMode 使用模式,0:CS;1:BSAPI上下文:VoucherType 單據(jù)類型,具體類型參看API上下文描述bPositive 紅藍(lán)標(biāo)識(shí):Tr

26、ue,藍(lán)字 ;False,紅字sBillType 為空串 sBusType 業(yè)務(wù)類型:普通采購(gòu),直運(yùn)采購(gòu),受托代銷 開發(fā)步驟實(shí)現(xiàn)采購(gòu)單據(jù)某一功能,主要有以下七個(gè)步驟:1 構(gòu)造u8login對(duì)象并登陸 聲明和創(chuàng)建u8login類對(duì)象前應(yīng)該先引用U8API類庫(kù)中的Interop.U8Login.dll,代碼示例如下:U8Login.clsLogin u8Login = new U8Login.clsLogin(); /聲明u8login對(duì)象String sSubId = AS; /登陸String sAccID = (default)001;String sYear = 2008;String s

27、UserID = demo;String sPassword = ;String sDate = 2008-09-30;String sServer = localhost;String sSerial = ;if(!u8Login.Login(ref sSubId, ref sAccID, ref sYear, ref sUserID, ref sPassword, ref sDate, ref sServer, ref sSerial)Console.WriteLine(登陸失敗,原因: + u8Login.ShareString);Marshal.FinalReleaseComObjec

28、t(u8Login);return; 如果當(dāng)前環(huán)境中有l(wèi)ogin對(duì)象則可以省去第一步。2 構(gòu)造環(huán)境上下文對(duì)象,傳入login,并按需設(shè)置其它上下文參數(shù) U8EnvContext envContext = new U8EnvContext();/構(gòu)造環(huán)境上下文對(duì)象envContext.U8Login = u8Login;/傳入login/設(shè)置上下文參數(shù)envContext.SetApiContext(VoucherType, new int(); /上下文數(shù)據(jù)類型:int,含義:?jiǎn)螕?jù)類型envContext.SetApiContext(bPositive, new bool(); /上下文數(shù)據(jù)類

29、型:bool,含義:紅藍(lán)標(biāo)識(shí):True,藍(lán)字envContext.SetApiContext(sBillType, new string(); /上下文數(shù)據(jù)類型:string,含義:為空串envContext.SetApiContext(sBusType, new string(); /上下文數(shù)據(jù)類型:string,含義:業(yè)務(wù)類型:普通采購(gòu),直運(yùn)采購(gòu),受托代銷如果是外部事務(wù),則需要傳遞ADO.Connection對(duì)象,并將IsIndependenceTransaction設(shè)置為true: envContext.BizDbConnection = new ADO.Connection(); en

30、vContext.IsIndependenceTransaction = true;3 設(shè)置API地址標(biāo)識(shí)(Url)參數(shù)/如當(dāng)前API“新增或修改”的地址標(biāo)識(shí)為:U8API/PurchaseOrder/VoucherSaveU8ApiAddress myApiAddress = new U8ApiAddress(U8API/PurchaseOrder/VoucherSave);4 構(gòu)造APIBrokerU8ApiBroker broker = new U8ApiBroker(myApiAddress, envContext);5 API對(duì)象參數(shù)賦值1) 給BO表頭參數(shù)DomHead和表體參數(shù)d

31、omBody賦值有兩種方法,如下:方法一是直接傳入MSXML2.DOMDocumentClass對(duì)象,代碼如下MSXML2.DOMDocumentClass domHead = new MSXML2.DOMDocumentClass();domHead.load(domHead.xml);broker.AssignNormalValue(domHead, domHead);方法二是構(gòu)造BusinessObject對(duì)象,具體方法如下:/首先通過(guò)GetBoParam方法獲取表頭表體參數(shù)BusinessObject DomHead = broker.GetBoParam(DomHead);DomHe

32、ad.RowCount = 10; /設(shè)置行數(shù)/其中,給BO對(duì)象的字段賦值,值可以是真實(shí)類型,也可以是無(wú)類型字符串/以下代碼示例只設(shè)置第一行值。各字段定義詳見API服務(wù)接口定義注意:設(shè)置行數(shù)為某個(gè)值,行數(shù)并不限定為該最大值,可以一直順序添加至任意行,但有一個(gè)規(guī)則:例如當(dāng)設(shè)置為10時(shí),可以對(duì)第0、1、9行賦值,當(dāng)對(duì)第10行賦值時(shí)候,則會(huì)順序添加一個(gè)新行,但此時(shí)是不能對(duì)第11行賦值的,當(dāng)添加一個(gè)新行(第10行)后,又可以對(duì)第11行進(jìn)行賦值。/* 以下是必輸字段 */DomHead0poid = ; /主關(guān)鍵字段,int類型DomHead0dpodate = ; /日期,DateTime類型DomH

33、ead0cpoid = ; /訂單編號(hào),string類型DomHead0cvenabbname = ; /供貨單位,string類型DomHead0cexch_name = ; /幣種,string類型DomHead0nflat = ; /匯率,double類型/* 以下是非必輸字段 */DomHead0ipresent = ; /現(xiàn)存量,string類型DomHead0cmaketime = ; /制單時(shí)間,DateTime類型DomHead0cmodifytime = ; /修改時(shí)間,DateTime類型DomHead0caudittime = ; /審核時(shí)間,DateTime類型DomH

34、ead0cauditdate = ; /審核日期,DateTime類型DomHead0cmodifydate = ; /修改日期,DateTime類型2) 給普通參數(shù)賦值例如,/給普通參數(shù)VoucherState(參數(shù)名)賦值。此參數(shù)的數(shù)據(jù)類型為int,此參數(shù)按值傳遞,具體請(qǐng)參考服務(wù)接口定義broker.AssignNormalValue(VoucherState, new int();注意:所有參數(shù)名不限大小寫。3) 給“OUT型”參數(shù)賦值為方便用戶使用U8API,如果參數(shù)數(shù)據(jù)類型為一般值類型,如String、Integer、Long、Single、Double、Boolean、Date,則

35、不必傳入一個(gè)參數(shù)變量(傳入也可);否則,則必須一個(gè)參數(shù)變量。如:/該參數(shù)curID為OUT型參數(shù),由于其數(shù)據(jù)類型為string,為一般值類型,因此不必傳入一個(gè)參數(shù)變量。在API調(diào)用返回時(shí),可以通過(guò)GetResult(curID)獲取其值/該參數(shù)CurDom為OUT型參數(shù),由于其數(shù)據(jù)類型為MSXML2.IXMLDOMDocument2,非一般值類型,因此必須傳入一個(gè)參數(shù)變量。在API調(diào)用返回時(shí),可以直接使用該參數(shù)MSXML2.IXMLDOMDocument2 CurDom = new MSXML2.IXMLDOMDocument2();broker.AssignNormalValue(CurDo

36、m, CurDom);當(dāng)不傳入一個(gè)參數(shù)變量時(shí),在API調(diào)用返回時(shí),可以通過(guò)GetResult(參數(shù)名)獲取其值;當(dāng)不必傳入一個(gè)參數(shù)變量時(shí),在API調(diào)用返回時(shí),可以直接引用該參數(shù)。4) 給“INOUT型”參數(shù)賦值對(duì)“INOUT型”型參數(shù),則不論是否是一般值類型,都需要傳入?yún)?shù)變量。其他與“OUT型”參數(shù)一樣。6 調(diào)用API /示例調(diào)用如下:if (!broker.Invoke()/錯(cuò)誤處理Exception apiEx = broker.GetException();if (apiEx != null)if (apiEx is MomSysException)MomSysException sy

37、sEx = apiEx as MomSysException;Console.WriteLine(系統(tǒng)異常: + sysEx.Message);/todo:異常處理else if (apiEx is MomBizException)MomBizException bizEx = apiEx as MomBizException;Console.WriteLine(API異常: + bizEx.Message);/todo:異常處理/結(jié)束本次調(diào)用,釋放API資源broker.Release();return; 注意:對(duì)調(diào)用失敗,可以獲取出錯(cuò)信息,如果是API框架的原因,則報(bào)告MomSysExce

38、ption異常,如果是業(yè)務(wù)組件的原因,則報(bào)告MomBizException異常。7 獲取返回結(jié)果1) 獲取BO對(duì)象在“裝載單據(jù)”時(shí),通過(guò)GetBoParam方法獲取表頭或表體參數(shù)BusinessObject DomHeadRet = broker.GetBoParam(DomHead);Console.WriteLine(BO對(duì)象行數(shù)為: + DomHeadRet.RowCount); /獲取BO對(duì)象的行數(shù)注意:如果要取原始的XMLDOM對(duì)象結(jié)果,請(qǐng)使用GetResult(DomHead) as MSXML2.DOMDocumentMSXML2.DOMDocument DomHeadRet =

39、 broker. GetResult(DomHead) as MSXML2.DOMDocument;以上獲取的行數(shù)是BO對(duì)象的實(shí)際行數(shù)。/獲取BO對(duì)象各字段的值。以下代碼示例只取第一行。字段定義詳見API服務(wù)接口定義/* 以下是必輸字段 */int poid = Convert.ToInt32(DomHeadRet0poid); /主關(guān)鍵字段,int類型DateTime dpodate = Convert.ToDateTime(DomHeadRet0dpodate); /日期,DateTime類型string cpoid = Convert.ToString(DomHeadRet0cpoid)

40、; /訂單編號(hào),string類型/* 以下是非必輸字段 */string ipresent = Convert.ToString(DomHeadRet0ipresent); /現(xiàn)存量,string類型DateTime cmaketime = Convert.ToDateTime(DomHeadRet0cmaketime); /制單時(shí)間,DateTime類型2) 獲取普通返回值 代碼如下:/獲取普通返回值。此返回值數(shù)據(jù)類型為System.String,此參數(shù)按值傳遞,具體請(qǐng)參考服務(wù)接口定義System.String result = broker.GetReturnValue() as Syst

41、em.String;3) 獲取普通“OUT型”或“INOUT型”返回值如前所述,對(duì)普通“OUT型”或“INOUT型”參數(shù),如果是一般值類型,則通過(guò)GetResult方法獲取其返回值,否則直接使用該引用。如,/獲取普通OUT參數(shù)curID。此返回值數(shù)據(jù)類型為string,在使用該參數(shù)之前,請(qǐng)判斷是否為空string curIDRet = broker.GetResult(curID) as string;/獲取普通OUT參數(shù)CurDom。此返回值數(shù)據(jù)類型為MSXML2.IXMLDOMDocument2,前面已定義該參數(shù),請(qǐng)直接使用2.2.2 銷售管理 功能介紹為了支持U8二次開發(fā)對(duì)業(yè)務(wù)單據(jù)的開發(fā)

42、,本功能提供了實(shí)現(xiàn)銷售業(yè)務(wù)單據(jù)各種操作功能的編程接口。使用銷售管理API開發(fā)接口,可以完成銷售管理的銷售報(bào)價(jià)單、銷售訂單、銷售發(fā)貨單、銷售退貨單、銷售普通發(fā)票、銷售專用發(fā)票、委托代銷發(fā)貨單、委托代銷結(jié)算單、銷售調(diào)撥單等單據(jù)的審核、棄審、獲取、新增、修改、刪除。 使用環(huán)境必須安裝.NET FrameWork 2.0;必須安裝U8-872版本的銷售管理產(chǎn)品;必須安裝API適配器組件SAAPIConcrete.dll; 接口說(shuō)明銷售管理二次開發(fā)接口及參數(shù)說(shuō)明:n 審核或棄審單據(jù)-Audit方法參數(shù):domHead 單據(jù)表頭,DOM對(duì)象,必輸 bVerify 審核/棄審標(biāo)志,必輸。true表審核;fa

43、lse表?xiàng)墝?API上下文:VoucherType 單據(jù)類型,必輸。具體類型參看API上下文描述n 刪除單據(jù)-Delete方法參數(shù):domHead 單據(jù)表頭,DOM對(duì)象,必輸 API上下文:VoucherType 單據(jù)類型,必輸。具體類型參看API上下文描述n 裝載單據(jù)-Load方法參數(shù):domHead 單據(jù)表頭,DOM對(duì)象,必輸 domBody 單據(jù)表體,DOM對(duì)象,必輸 VouchID 需要裝載的單據(jù)號(hào),可選 blnAuth 是否控制權(quán)限:trueAPI上下文:VoucherType 單據(jù)類型,必輸。具體類型參看API上下文描述n 新增或修改單據(jù)-Save方法參數(shù):domHead 單據(jù)表頭

44、,DOM對(duì)象,必輸 domBody 單據(jù)表體,DOM對(duì)象,必輸 VoucherState 保存狀態(tài),必輸。0增加;1修改 VNewID 單據(jù)的id,可選 DomConfig ATO,PTO選配配置,必輸,可設(shè)置為nothing API上下文:VoucherType 單據(jù)類型,必輸。具體類型參看API上下文描述 開發(fā)步驟實(shí)現(xiàn)銷售單據(jù)某一功能,主要有以下七個(gè)步驟:1 構(gòu)造u8login對(duì)象并登陸 聲明和創(chuàng)建u8login類對(duì)象前應(yīng)該先引用U8API類庫(kù)中的Interop.U8Login.dll,代碼示例如下:U8Login.clsLogin u8Login = new U8Login.clsLog

45、in(); /聲明u8login對(duì)象String sSubId = AS; /登陸String sAccID = (default)001;String sYear = 2008;String sUserID = demo;String sPassword = ;String sDate = 2008-09-30;String sServer = localhost;String sSerial = ;if(!u8Login.Login(ref sSubId, ref sAccID, ref sYear, ref sUserID, ref sPassword, ref sDate, ref s

46、Server, ref sSerial)Console.WriteLine(登陸失敗,原因: + u8Login.ShareString);Marshal.FinalReleaseComObject(u8Login);return;如果當(dāng)前環(huán)境中有l(wèi)ogin對(duì)象則可以省去第一步。2 構(gòu)造環(huán)境上下文對(duì)象,傳入login,并按需設(shè)置其它上下文參數(shù) U8EnvContext envContext = new U8EnvContext();/構(gòu)造環(huán)境上下文對(duì)象envContext.U8Login = u8Login;/傳入login/設(shè)置上下文參數(shù)envContext.SetApiContext(Vo

47、ucherType, new int(); /上下文數(shù)據(jù)類型:int,含義:?jiǎn)螕?jù)類型如果是外部事務(wù),則需要傳遞ADO.Connection對(duì)象,并將IsIndependenceTransaction設(shè)置為true: envContext.BizDbConnection = new ADO.Connection(); envContext.IsIndependenceTransaction = true;3 設(shè)置API地址標(biāo)識(shí)(Url)參數(shù)/如當(dāng)前API“新增或修改”的地址標(biāo)識(shí)為:U8API/SaleOrder/SaveU8ApiAddress myApiAddress = new U8ApiA

48、ddress(U8API/SaleOrder/Save);4 構(gòu)造APIBrokerU8ApiBroker broker = new U8ApiBroker(myApiAddress, envContext);5 API對(duì)象參數(shù)賦值1) 給BO表頭參數(shù)DomHead和表體參數(shù)domBody賦值有兩種方法,如下:方法一是直接傳入MSXML2.DOMDocumentClass對(duì)象,代碼如下MSXML2.DOMDocumentClass domHead = new MSXML2.DOMDocumentClass();domHead.load(domHead.xml);broker.AssignNor

49、malValue(domHead, domHead);方法二是構(gòu)造BusinessObject對(duì)象,具體方法如下:/首先通過(guò)GetBoParam方法獲取表頭表體參數(shù)BusinessObject DomHead = broker.GetBoParam(DomHead);DomHead.RowCount = 10; /設(shè)置行數(shù)/其中,給BO對(duì)象的字段賦值,值可以是真實(shí)類型,也可以是無(wú)類型字符串/以下代碼示例只設(shè)置第一行值。各字段定義詳見API服務(wù)接口定義注意:設(shè)置行數(shù)為某個(gè)值,行數(shù)并不限定為該最大值,可以一直順序添加至任意行,但有一個(gè)規(guī)則:例如當(dāng)設(shè)置為10時(shí),可以對(duì)第0、1、9行賦值,當(dāng)對(duì)第10行

50、賦值時(shí)候,則會(huì)順序添加一個(gè)新行,但此時(shí)是不能對(duì)第11行賦值的,當(dāng)添加一個(gè)新行(第10行)后,又可以對(duì)第11行進(jìn)行賦值。/* 以下是必輸字段 */domHead0id = ; /主關(guān)鍵字段,int類型domHead0csocode = ; /訂 單 號(hào),string類型domHead0ddate = ; /訂單日期,DateTime類型domHead0cbustype = ; /業(yè)務(wù)類型,string類型/* 以下是非必輸字段 */domHead0fstockquanO = ; /現(xiàn)存件數(shù),double類型domHead0fcanusequanO = ; /可用件數(shù),double類型domHead0dpredatebt = ; /預(yù)發(fā)貨日期,DateTime類型domHead0dpremodatebt = ; /預(yù)完工日期,DateTime類型domHead0dpredatebt = ; /預(yù)發(fā)貨日期,DateTime類型2)

溫馨提示

  • 1. 本站所有資源如無(wú)特殊說(shuō)明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請(qǐng)下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請(qǐng)聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁(yè)內(nèi)容里面會(huì)有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫(kù)網(wǎng)僅提供信息存儲(chǔ)空間,僅對(duì)用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對(duì)用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對(duì)任何下載內(nèi)容負(fù)責(zé)。
  • 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請(qǐng)與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時(shí)也不承擔(dān)用戶因使用這些下載資源對(duì)自己和他人造成任何形式的傷害或損失。

最新文檔

評(píng)論

0/150

提交評(píng)論