在DataWorks開放平臺,成功注冊、上線并啟用擴展程序后,在該擴展程序所生效的工作空間中,使用頁面部分功能(即觸發擴展點事件)時,DataWorks會將事件消息發送至您的擴展程序,根據擴展程序返回的結果,您可以決定該操作是否生效。本文將為您介紹數據開發DataStudio中支持的擴展點事件,以及使用擴展點觸發擴展程序的操作過程。
前提條件
已開啟消息訂閱操作,詳情請參見開啟消息訂閱。
已完成擴展程序的開發部署操作,詳情請參見開發部署擴展程序:函數計算方式。
背景信息
啟動擴展程序。
您可以在工作空間頁面查看擴展程序,并控制是否需要在當前工作空間啟用該擴展程序校驗。
數據開發支持的擴展點事件。
DataWorks的數據開發模塊,支持擴展點事件包括文件發布前置事件、文件提交前置事件、表提交前置事件等。擴展點事件的概念和詳細列表請參見支持的擴展點事件列表。
DataWorks支持對擴展點事件進行消息通知,通過擴展程序來自動化校驗并響應,擴展點觸發過程詳情請參見支持的擴展點事件。
使用限制
擴展程序啟用后,實際數據開發過程中,擴展事件被觸發后的消息通知與響應有以下限制。
系統內置擴展程序啟用后,暫時僅支持對ODPS SQL類的節點生效。
即啟用后,僅ODPS SQL類節點中相應擴展點事件被觸發時,流程會被阻斷,通過內置擴展程序對對應的邏輯進行校驗并返回校驗結果。非ODPS SQL節點對應的事件被觸發后,流程會被阻斷,但是內置擴展程序不會校驗邏輯是否符合預期,直接返回校驗成功。
擴展點事件中,表發布前置事件和表提交前置事件暫時僅支持MaxCompute表提交與發布時觸發并進行檢測。
有內部節點的組合類節點,例如:創建并使用PAI Studio節點、do-while節點邏輯原理介紹、for-each節點邏輯原理介紹在觸發檢查時,需要內部節點都檢查通過才可繼續進行下一步操作。
能力概述
數據開發模塊支持您的本地服務接收以下擴展點事件的消息。此外,還支持將本地程序注冊為DataWorks擴展程序,通過擴展程序接收擴展點事件消息。實現擴展程序對擴展點事件的自定義邏輯處理,并通過回調UpdateIDEEventResultAPI將處理結果返回至平臺,實現DataWorks上的流程管控。支持的擴展點如下:
文件操作:運行文件、提交文件、發布文件、刪除文件。
表操作:提交表、發布表。
說明數據開發表操作擴展事件僅支持對MaxCompute表的觸發與檢測。
支持的擴展點事件
DataWorks數據開發中,目前支持對以下的擴展點事件進行消息通知,通過擴展程序實現校驗并響應。
DataStudio-運行文件
DataStudio-提交文件
DataStudio-發布文件
DataStudio-刪除文件
DataStudio-提交表
DataStudio-發布表
相關文檔
啟用擴展程序,詳情請參見:應用擴展程序。
數據開發更多擴展點事件,詳情請參見:支持的擴展點事件列表。
文件變更事件的消息實體格式,詳情請參見:文件變更事件(提交、發布、運行、刪除、代碼評審)。
表變更事件的消息實體格式,詳情請參見:表變更事件(提交表至開發環境、發布表至生產環境)。