全部產品
Search
文件中心

:使用工作空間參數

更新時間:Jun 19, 2024

DataWorks在原有任務層級調度參數基礎上,新增工作空間層級的調度參數,如果同一個工作空間中的多個參數需配置為相同值,可以使用工作空間參數。工作空間參數可配置為脫敏展示,以保護您的敏感性資料;同時,在標準模式工作空間下,生產環境和開發環境工作空間參數的取值可以不同。

相關介紹

調度參數是DataWorks任務調度時使用的參數,可根據您配置的參數取值規則,在每次任務運行時自動替換為真實的取值。更多調度參數的介紹及使用,詳情請參見調度參數

前提條件

  • 已建立工作空間。工作空間參數需在指定的工作空間內使用。建立工作空間,詳情請參見建立並管理工作空間

  • 已添加使用者至指定工作空間並授予空間管理員角色許可權。僅工作空間管理員角色可建立工作空間參數。授權詳情請參見增加空間成員並管理成員角色許可權

  • 已購買專業版及以上版本DataWorks產品。僅專業版及以上版本DataWorks支援使用工作空間參數。購買詳情請參見購買或升級DataWorks版本

使用限制

  • 僅獨享調度資源群組支援該功能,公用調度資源群組不支援。

  • 2024年01月01日之後購買的獨享調度資源群組可正常使用該功能;2024年01月01日之前購買的獨享調度資源群組,需聯絡技術支援人員升級才能正常使用該功能。

建立工作空間參數

  1. 進入工作空間參數建立入口。

    1. 進入營運中心頁面。

      登入DataWorks控制台,切換至目標地區後,單擊左側導覽列的資料建模與開發 > 營運中心,在下拉框中選擇對應工作空間後單擊進入營運中心

    2. 在營運中心左側導航單擊調度設定 > 工作空間參數,進入工作空間參數建立頁面。

  2. 建立工作空間參數。

    1. 在工作空間參數頁面,單擊建立工作空間參數,根據業務需要配置參數資訊。

      說明

      如您有大量全域參數需要建立,也可單擊批量建立工作空間參數,大量建立參數。

      配置項

      描述

      參數名稱

      自訂參數名稱,預設以workspace.固定格式開頭。參數名稱必須唯一。

      責任人

      設定工作空間參數的負責人。

      說明
      • 空間管理員可以指定工作空間中的任意一個成員作為參數的責任人。

      • 空間管理員可以修改、刪除所有工作空間參數。

      如您需執行相關參數管理操作,可添加使用者至工作空間並授予相應角色許可權,詳情請參見增加空間成員並管理成員角色許可權

      適用工作空間

      設定當前工作空間參數可用於哪個工作空間。配置完成後,後續此處配置的工作空間中的任務均可使用本次新增的工作空間參數。

      說明
      • 列表僅展示當前登入帳號作為空白間管理員的工作空間。

      • 每個工作空間參數僅支援選擇用於某一個工作空間中。

      參數類型與參數值

      用於定義當前工作空間參數後續在任務使用中的實際替換值,支援的參數類型及取值如下:

      • 常量(明文):參數實際賦值為所有使用者可見的常量。例如,123。

      • 常量(密文):參數實際賦值為脫敏展示(預設為******)的常量。常用於較敏感的資料使用。例如,輸入123則會顯示為******。

      • 變數:參數的實際賦值會根據您配置的變數動態替換為相應值。

        例如,參數值可配置為擷取任務的定時調度時間$[yyyy-mm-dd],擷取任務啟動並執行業務日期${yyyy-mm-dd},更多賦值格式可參考調度參數支援的格式

      說明
      • 參數值支援配置為部分特殊字元,具體請以實際介面提示為準。

      • 不支援在一個參數賦值中引用另一個工作空間參數。

      另外,若您使用的是標準模式的工作空間,則可根據需要配置同一個參數在開發環境和生產環境的取值不同。工作空間模式介紹,詳情請參見必讀:簡單模式和標準模式的區別

    2. 配置完成後,單擊確定,完成參數的建立。

使用工作空間參數

工作空間參數建立完成後,您需進入被授權的工作空間,在相應節點編輯頁面使用參數。工作空間參數的使用與調度參數相同,步驟如下:

  1. 先在節點任務代碼中定義變數。

  2. 進入節點編輯頁面的調度配置 > 調度參數地區,為變數賦值工作空間參數。

參數配置完成後您可預覽參數取值是否符合預期,並根據需要進行調整。更多調度參數的使用,詳情請參見配置並使用調度參數

說明
  • 你可根據實際需要建立合適的節點,詳情請參見DataWorks節點合集

  • 節點使用空間參數後需在節點編輯頁面工具列執行儲存、提交操作,提交後才認為參數被引用成功。

  • 2024年01月01日之後購買的獨享調度資源群組可正常使用該功能;2024年01月01日之前購買的獨享調度資源群組,需聯絡技術支援人員升級才能正常使用該功能。

image.png

管理工作空間參數

工作空間參數頁面,您可對工作空間參數執行如下管理操作:

說明
  • 僅擁有空間管理員角色的工作空間成員支援修改、刪除工作空間參數。

  • 僅擁有開發、營運、空間管理員角色的工作空間成員支援查看工作空間參數的引用任務及版本。

添加使用者至工作空間並授權相關角色許可權,詳情請參見增加空間成員並管理成員角色許可權

  • 查看參數您可查看參數詳情、適用工作空間、引用的任務等資訊,根據任務ID即可跳轉至相應任務進行開發操作。

  • 修改參數:

    • 僅支援修改參數的責任人、取值及描述資訊。參數每修改一次,都會產生一個新的版本。

    • 若工作空間參數已被其他任務引用,修改參數將影響該任務中工作空間參數的取值情況,請謹慎操作。

    • 修改後的參數配置,其生效時間最晚不超過10分鐘。

  • 對比及復原參數:您可查看參數歷史版本,並根據需要進行版本內容對比,復原參數至所需版本。

  • 刪除參數:

    • 若工作空間參數已被其他任務引用,則無法刪除。

    • 刪除參數將導致對應任務運行失敗,請謹慎操作。

    • 刪除操作在工作空間參數頁面立即生效,刪除後您將無法在空間參數列表中找到該參數;但刪除參數的10分鐘內,引用該參數的任務,運行時可能仍可擷取到該參數的賦值情況。