KBOS插件開(kāi)發(fā)入門教程

1、 BOS插件開(kāi)發(fā)入門教程本文主要針對(duì)初學(xué)者，介紹BOS插件開(kāi)發(fā)與制作的基本流程與步驟，為入門所用。以一個(gè)簡(jiǎn)單的插件開(kāi)發(fā)需求為例：比如想在新開(kāi)發(fā)的BOS單據(jù)上，增加一個(gè)自定義菜單按鈕，按鈕標(biāo)題為“My BOS MenuBarButton”，位置放在編輯菜單下的駁回審核按鈕之后，在工具欄上的退出按鈕之前；當(dāng)點(diǎn)擊該自定義按鈕時(shí)彈出提示框“Hello,This Is My First BOS Bill InterFace!”。針對(duì)此需求，讓我們一起看看如何一步一步通過(guò)BOS插件來(lái)實(shí)現(xiàn)：【第一步】：由于插件是基于VB語(yǔ)言開(kāi)發(fā)，首先需要在裝有金蝶K3的環(huán)境下安裝Microsoft Visual Basic

2、 6.0（簡(jiǎn)稱VB6.0）開(kāi)發(fā)工具。附開(kāi)發(fā)工具下載地址：【第二步】：安裝好VB6.0之后，在開(kāi)始菜單中找到VB6.0的快捷方式，打開(kāi)VB之后將出現(xiàn)以下界面（如圖1）：圖1在此界面一定要選擇“ActiveX DLL”，再點(diǎn)擊“打開(kāi)”按鈕，然后會(huì)進(jìn)入以下工作界面（如圖2）： 圖2注意界面右上方的“插件開(kāi)發(fā)向?qū)А卑粹o。有的環(huán)境可能會(huì)出現(xiàn)打開(kāi)VB6.0后并沒(méi)有“金蝶 k/3-BOS”菜單的問(wèn)題，解決方法如下：找到K3安裝目錄下的ADDIN文件夾，將此文件夾下的兩個(gè)DLL文件（K3BOSPLUGINSADDIN.dll和K3GLParaConsolePlugin.dll），在CMD命令行中用RegSvr

3、32命令進(jìn)行注冊(cè)。例如：K3安裝目錄為C:Program FilesKingdeeK3ERP，那么在cmd中輸入命令就為：regsvr32 "C:Program FilesKingdeeK3ERPADDINK3BOSPLUGINSADDIN.dll"regsvr32 "C:Program FilesKingdeeK3ERPADDINK3GLParaConsolePlugin.dll"回車提示注冊(cè)成功之后，再重新打開(kāi)VB就會(huì)出現(xiàn)“金蝶 k/3-BOS”菜單，如果還沒(méi)出現(xiàn)需要再重啟下電腦解決。（備注：如果是WIN7環(huán)境，運(yùn)行cmd.exe需要以管理員身份運(yùn)行

4、，方可成功注冊(cè)組件）圖3【第三步】：插件向?qū)Ы缑娌僮鼽c(diǎn)擊VB右上方的“插件開(kāi)發(fā)向?qū)А卑粹o，將會(huì)出現(xiàn)以下界面（如圖4）：圖4在以上界面，我們可以看到有4個(gè)選項(xiàng)供選擇，具體含義如下：Ø 金蝶 K/3-BOS 客戶端插件：在金蝶K3客戶端運(yùn)行，針對(duì)K3客戶端業(yè)務(wù)邏輯的擴(kuò)展處理，僅適用于BOS新單。比如更改單據(jù)菜單按鈕外觀及位置、增加自定義按鈕菜單功能、單據(jù)字段數(shù)據(jù)更改、單據(jù)保存前的特殊校驗(yàn)、序時(shí)薄實(shí)現(xiàn)動(dòng)態(tài)過(guò)濾、下推前的邏輯控制、審核或者駁回操作前的特殊判斷等等客戶端的邏輯擴(kuò)展，都有可能用到客戶端插件Ø 金蝶 K/3-BOS 中間層插件：在金蝶K3中間層運(yùn)行，針對(duì)K3中間層業(yè)務(wù)邏輯

5、的擴(kuò)展處理，僅適用于BOS新單。特別涉及到需要在中間層進(jìn)行一些特殊業(yè)務(wù)處理，需要同BOS單據(jù)的中間層保存、刪除、審核或駁回等操作的事務(wù)保持在同一事務(wù)里進(jìn)行控制時(shí)，就會(huì)用到中間層插件。Ø 金蝶 K/3 工業(yè)單據(jù)客戶端插件：在金蝶K3客戶端運(yùn)行，針對(duì)K3客戶端業(yè)務(wù)邏輯的擴(kuò)展處理，僅適用于K3老單。Ø 金蝶 K/3 工業(yè)單據(jù)中間層插件：在金蝶K3中間層運(yùn)行，針對(duì)K3中間層業(yè)務(wù)邏輯的擴(kuò)展處理，僅適用于K3老單。案例要求是在單據(jù)上增加按鈕，是對(duì)BOS單據(jù)客戶端運(yùn)行時(shí)的擴(kuò)展處理，所以此處我們選擇“金蝶 K/3-BOS 客戶端插件”，點(diǎn)擊確定后將進(jìn)入以下界面（如圖5）： 圖5界面上有四種

6、插件類型供我們選擇，不同插件類型的說(shuō)明如下：Ø 金蝶 K/3-BOS 客戶端單據(jù)插件：針對(duì)BOS單據(jù)新增、修改及查看等場(chǎng)景下的業(yè)務(wù)邏輯的擴(kuò)展處理。Ø 金蝶 K/3-BOS 客戶端序時(shí)薄插件：針對(duì)BOS單據(jù)序時(shí)薄維護(hù)等場(chǎng)景下的業(yè)務(wù)邏輯的擴(kuò)展處理。Ø 金蝶 K/3-BOS 基礎(chǔ)資料序時(shí)薄插件：針對(duì)BOS基礎(chǔ)資料序時(shí)薄維護(hù)場(chǎng)景下的業(yè)務(wù)邏輯的擴(kuò)展處理Ø 金蝶 K/3-BOS 審批流插件：針對(duì)BOS單據(jù)運(yùn)行審批流相關(guān)的業(yè)務(wù)邏輯的擴(kuò)展處理。此處我們選擇“金蝶 K/3-BOS 客戶端單據(jù)插件”，在單據(jù)界面上增加自定義按鈕，點(diǎn)擊“下一步”將出現(xiàn)以下界面（如圖6）：圖6選

7、擇“新增菜單或工具欄”，點(diǎn)擊“下一步”將出現(xiàn)以下界面（如圖7）：圖7點(diǎn)擊“新增”按鈕，出現(xiàn)以下界面（如圖8）：圖8在彈出的菜單編輯界面，增加自定義按鈕，定義按鈕標(biāo)題、在菜單欄及工具欄上的位置。定義完成之后點(diǎn)擊“確定”按鈕，然后點(diǎn)擊“下一步”，將進(jìn)入以下界面（如圖9）：圖9在圖9界面選擇你想要實(shí)現(xiàn)的插件接口事件，這些插件接口事件是K3系統(tǒng)在單據(jù)運(yùn)行時(shí)的不同時(shí)機(jī)拋出來(lái)供插件開(kāi)發(fā)者進(jìn)行插件編碼處理的。具體事件的觸發(fā)時(shí)點(diǎn)及參數(shù)，可以參考界面右邊的說(shuō)明。詳細(xì)的插件接口事件說(shuō)明及示例，可參考BOS插件開(kāi)發(fā)手冊(cè)，在K3安裝目錄K3ERP下搜索文件：K3BOSAdd.pdf，該P(yáng)DF文檔即為插件開(kāi)發(fā)手冊(cè)。當(dāng)然

8、在不了解這些插件接口事件的情況下，可以不用選擇，直接點(diǎn)擊“下一步”，最后再點(diǎn)擊“完成”按鈕，進(jìn)入以下界面（如圖10）：圖10【第四步】：編寫代碼圖10的界面就是我們編寫插件代碼的工作界面，在右上方選擇不同的插件事件進(jìn)行編碼處理，實(shí)現(xiàn)特殊的業(yè)務(wù)邏輯處理。比如案例要求實(shí)現(xiàn)點(diǎn)擊自定義按鈕時(shí)彈出提示框，那么我們就選擇MenuBarClick事件（所有BOS單據(jù)菜單按鈕單擊時(shí)都會(huì)拋出給插件進(jìn)行捕獲處理），在此事件里根據(jù)按鈕的名稱捕獲到自定義按鈕的單擊操作，然后編寫代碼實(shí)現(xiàn)單擊操作的功能。那么此功能的插件代碼編寫應(yīng)該如下：Private Sub m_BillInterface_MenuBarClick(B

9、yVal BOSTool As K3ClassEvents.BOSTool, Cancel As Boolean) Select Case BOSTool.ToolName Case "Test" '此處添加處理Test 菜單對(duì)象的 Click 事件 MsgBox "Hello,This Is My First BOS Bill InterFace!" Case Else End SelectEnd Sub圖11-備注：按鈕名稱BOSTool.ToolName是菜單按鈕的唯一標(biāo)識(shí)，在向?qū)Ы缑嫘略霭粹o時(shí)已經(jīng)定義好了，請(qǐng)看圖8 中的名稱(Test)。

10、如果想捕獲系統(tǒng)內(nèi)置菜單按鈕的名稱來(lái)進(jìn)行插件處理，可進(jìn)入BOS集成開(kāi)發(fā)工具，找到對(duì)應(yīng)的BOS單據(jù)，右鍵選擇“操作管理”進(jìn)行查看某個(gè)菜單按鈕的“操作代碼”，即為按鈕的標(biāo)識(shí)名稱?！镜谖宀健浚壕幾g生成DLL文件將圖11生成的VB工程文件進(jìn)行保存，保存成功后，點(diǎn)擊“文件”(File)菜單下的“生成”(Make)按鈕，選擇文件生成的路徑，編譯生成相應(yīng)的DLL文件。圖12圖13備注：此處演示用并沒(méi)有更改工程名及類名，建議實(shí)際開(kāi)發(fā)時(shí)更改成有意義的名稱，命名中不要出現(xiàn)中文字符。另外可將文件中多余的類Class1去掉?！镜诹健浚翰寮旖覤OS單據(jù)進(jìn)入BOS集成開(kāi)發(fā)工具，找到需要進(jìn)行插件開(kāi)發(fā)的BOS單據(jù)，在整單屬

11、性欄找到“插件”圖14點(diǎn)擊“插件”后，出現(xiàn)以下界面：圖15我們可以看到，圖15界面有很多欄位，需要根據(jù)你開(kāi)發(fā)的插件類型來(lái)進(jìn)行選擇，可參考圖5向?qū)Ы缑孢x擇的插件類型來(lái)決定。類型與欄位對(duì)應(yīng)關(guān)系如下：金蝶 K/3-BOS 客戶端單據(jù)插件 單據(jù)事件處理組件名金蝶 K/3-BOS 客戶端序時(shí)薄插件 序時(shí)薄事件處理組件名金蝶 K/3-BOS 基礎(chǔ)資料序時(shí)薄插件 基礎(chǔ)資料序時(shí)薄事件處理組件名金蝶 K/3-BOS 審批流插件 審批流事件處理組件名圖5中我們選擇的是“金蝶 K/3-BOS 客戶端單據(jù)插件”，故此處點(diǎn)擊“單據(jù)事件處理組件名”欄位后的按鈕，點(diǎn)擊后彈出界面如下：圖16點(diǎn)擊圖中的瀏覽按鈕，在彈出的文件瀏

12、覽窗口中找到【第五步】編譯生成的DLL文件，如下圖所示：圖17點(diǎn)擊上圖中的打開(kāi)按鈕，將出現(xiàn)以下界面（如圖18）：圖18在圖18中勾選上你要掛接插件的工程名.類名，即插件的VB工程里的工程名及類名，如下圖紅色標(biāo)記所示：圖19在圖18中我們勾選上Project1.BOS_BillEvent_PlugIns，然后點(diǎn)擊“確定”按鈕，然后可以看到單據(jù)事件處理組件名出現(xiàn)了我們插件的工程名.類名，如下圖所示：圖20點(diǎn)擊圖20中的“確定”按鈕，最后再點(diǎn)擊BOS集成開(kāi)發(fā)工具的保存按鈕，保存成功后即完成了插件與BOS單據(jù)進(jìn)行掛接的操作。圖21進(jìn)行單據(jù)測(cè)試，便可以看到我們開(kāi)發(fā)的BOS插件的功能效果，如下圖：圖22圖23注意：最后將插件DLL文件部署到客戶的正式環(huán)境中時(shí)有兩種方式：l 第一種：如果開(kāi)發(fā)的是客戶端插件，在K3客戶端較少的情況下，可通過(guò)手工COPY第四步中編譯生成的DLL文件(Project1.dll)到各個(gè)K3客戶端，然后在客戶端機(jī)器上，用Regsvr32命令按照類似于圖3中注冊(cè)組件的方式進(jìn)行手工注冊(cè)插件DLL文件。如果是中間層插件的話，直接在K3中間層服務(wù)器環(huán)境下注冊(cè)部署即可。l 第二種：通過(guò)BOS集成開(kāi)發(fā)工具的發(fā)布部署功能，將您開(kāi)發(fā)的插件制作成安裝