全部產品
Search
文件中心

DataWorks:應用擴充程式

更新時間:Sep 24, 2024

完成擴充程式的開發、部署與註冊後,您需要通過測試、審批、上線流程後,擴充程式責任人之外的其他管理員可在管理中心啟用該擴充程式。本文為您介紹如何測試並上線使用擴充程式。

背景資訊

擴充程式從註冊完成到上線,需要經歷以下流程對擴充程式進行測試與審核,通過此流程後,擴充程式才可供各空間管理員或租戶級管理員在管理中心中啟用。

前提條件

開放平台側

開放平台管理員租用戶系統管理員可通過以下步驟完成擴充程式的測試、審核與上線操作。

步驟一:進入開放平台擴充頁

在開放平台擴充頁面可查看登入完成的擴充程式。

  1. 進入開放平台頁面。

    登入DataWorks控制台,切換至目標地區後,單擊左側導覽列的開放平台,進入開放平台的開發人員後台頁面。

  2. 查看擴充程式詳情。

    在開發人員後台頁面中單擊擴充程式,進入擴充程式頁面。找到目標需要發布上線的擴充程式,單擊操作列的詳情,即可查看該擴充程式配置的詳情資訊。

步驟二:測試擴充程式

擴充程式註冊完成後,將預設處於測試狀態,此狀態下,擴充程式無需進行上線操作,便可在以下特定情境中生效以便您測試擴充程式。

  • 戶級擴充事件

    擴充程式負責人可前往管理中心啟用擴充程式,該擴充程式僅對當前擴充程式負責人,詳情請參見步驟二:啟用擴充程式

    例如:一個測試中狀態、用於處理資料下載卡點校正的擴充程式,當擴充程式負責人在管理中心啟用後,擴充程式負責人執行資料下載操作將觸發擴充程式卡點直至擴充程式返回校正結果。

  • 空間級擴充事件

    若擴充程式處理的擴充點事件為空間級擴充點事件,那麼該擴充點會在您註冊擴充程式時指定的工作空間內生效。查看擴充程式測試空間,詳情可參見查看擴充程式詳情

請針對擴充程式處理的事件類型,在擴充程式上線前,通過上述途徑測試DataWorks發送訊息、擴充程式接收訊息並進行訊息審核與回調完整鏈路。

步驟三:上線擴充程式

當擴充程式測試無誤後,請參考步驟一,前往開放平台擴充程式詳情頁面,單擊擴充程式操作列的提交按鈕,將擴充程式提交至DataWorks平台審核,待審核通過後,點擊擴充程式操作列的上線按鈕,上線擴充程式。

說明

提交擴充程式審核後,DataWorks平台將在T+3工作日內完成審核。若審核未通過,您可以將滑鼠懸浮至審核未通過的警示提示表徵圖查看未通過原因,根據提示整改擴充程式後重新提交審核。

步驟四:管理擴充程式狀態

開放平台開發人員後台 > 擴充程式的擴充程式列表的操作列,對擴充程式進行查看詳情編輯提交、上線、禁用刪除等操作。狀態列則會向您展示擴充程式的不同狀態:

  • 測試中:新註冊的擴充程式預設為測試中,已上線的擴充程式下線後也會變為測試中的狀態,測試中的擴充程式僅測試空間可使用。

  • 審核中:測試中的擴充程式點擊提交後,將處於審核中的狀態,經平台審批通過的擴充程式狀態將變更為審核通過,審批通過後擴充程式才可以進行上線操作。若平台審批未通過,該擴充程式的狀態將變更為審核未通過

  • 已上線:在擴充程式的操作列,單擊上線後,擴充程式狀態變為已上線,上線後,所有擴充程式適用的工作空間都可以使用擴充程式(空間管理員可在工作空間配置介面查看並啟用該擴充程式)。

  • 已禁用:在擴充程式的操作列,單擊禁用後,擴充程式狀態變為已禁用,此時該擴充程式失效,啟用此擴充程式的工作空間的觸發事件流程直接通過,不會觸發檢查或阻斷。

  • 已到期:當DataWorks企業版版本到期後,擴充程式狀態會變更為已到期狀態,此狀態的擴充程式失效,與已禁用狀態類似。

管理中心側

空間管理員可在管理中心內的擴充程式頁中開啟所屬空間的空間級擴充點事件的擴充程式,租用戶系統管理員可通過管理中心內的擴充程式頁處理組戶級擴充點事件的擴充程式。

步驟一:進入管理中心擴充程式頁

  1. 進入管理中心頁面。

    登入DataWorks控制台,切換至目標地區後,單擊左側導覽列的管理中心,在下拉框中選擇對應工作空間後單擊進入管理中心

  2. 查看可啟用的擴充程式。

    在管理中心單擊左側菜單內的擴充程式,進入擴充程式頁面,該頁面展示可啟用的擴充程式。

步驟二:啟用擴充程式

您可在管理中心>擴充程式頁面啟用擴充程式。不同層級的擴充程式開啟後,針對的卡點範圍不同,具體如下:

  • 租戶級擴充點阿里雲主帳號,擁有AliyunDataWorksFullAccess許可權的子帳號以及租用戶系統管理員可以開啟。在擴充程式開啟後,所有空間針對該擴充點的操作均會卡點,直至擴充程式返回校正結果。

  • 空間級擴充點空間管理員可以開啟,開啟空間級擴充程式需要指定擴充程式生效的空間範圍後,才可以進行開啟,開啟後的空間下針對該擴充點的操作均會卡點,直至擴充程式返回校正結果。

說明
  • 若此處沒有找到您需要的擴充程式,請前往開放平台 > 擴充程式頁面查看該擴充程式是否已上線。

  • 若您擴充程式在配置時有配置選項配置,您可在管理中心 > 擴充程式操作列單擊設定按鈕進行配置。

具體模組側

空間管理員租用戶系統管理員通過上述操作在空間或租戶下開啟擴充程式卡點校正的情況下,開發或營運等人員在空間或租戶下對擴充點執行操作變更時,操作將被阻塞,直至擴充程式返回校正結果。具體攔截情境樣本,您可參考如下文檔。