查看 Application Integration 支援的連接器

變數

變數是整合元素,可在整合作業、觸發條件和邊之間儲存及傳輸資料。

  • 變數可在設計時以靜態方式定義,或在執行階段動態傳遞至整合項目。
  • 變數可參照整合作業中的其他變數。
  • 變數可供所有工作全域存取,或供特定工作在本機存取。

變數類型

Application Integration 支援四種變數類型:

整合變數

整合變數類似於程式設計語言中使用的變數。在執行整合作業的過程中,您可以讀取及寫入變數中的資料。

整合變數可用於下列情況:

  • 做為整合作業的輸入內容 (輸入變數)。
  • 會以整合作業的輸出內容 (輸出變數) 形式傳回。
  • 用於在執行整合作業期間保留暫時狀態。

變數的值不必在整合中以靜態方式定義。變數值可透過觸發條件傳遞至整合項目。不過,如果變數是在整合中以靜態方式定義,且同一個變數以動態方式透過觸發事件提供,則動態值指派會覆寫靜態指派。

支援的資料類型

整合變數支援下列資料類型:

  • 字串和字串陣列
  • 整數和整數陣列
  • 雙項與雙項陣列
  • 布林值和布林值陣列
  • JSON

工作變數

工作變數工作的預先定義自動產生變數。如果工作有輸出內容,則所有這類輸出內容都會顯示在工作變數中。您無法刪除或編輯工作變數。舉例來說,對於「呼叫 REST 端點」工作,回應主體會儲存在 responseBody 變數中。

設定變數

設定變數可讓您將整合作業的設定外部化。您可以使用設定變數,設定整合作業的各個層面,例如連接器詳細資料、驗證詳細資料,或是根據開發環境 (品質確保、測試環境或實際工作環境) 的網址端點。您不必先手動更新整合項目,再將整合項目上傳至新環境。應用程式整合功能可讓您在發布整合時輸入設定變數的值。

如要查看及編輯整合中定義的設定變數,請按一下「變數」窗格中的 variable_add 「整合設定變數」。如要瞭解如何建立及使用設定變數,請參閱「為整合作業建構 CICD」教學課程。

系統變數

建立整合項目時,系統會自動產生系統變數。您可以在整合工作中使用這些變數,並用於錯誤處理。整合項目包含下列系統產生的變數:

  • ErrorInfo:執行作業失敗時,您可以使用 ErrorInfo 變數存取錯誤詳細資料:
    {
      "ErrorInfo": {
      "message": String,
      "code": Number
      }
    }
    

    目前,您可以建立名為 ErrorMessage整合變數來存取錯誤訊息。不過,建議您使用系統產生的 ErrorInfo.message 變數存取錯誤訊息。

  • ExecutionMode:根據觸發事件的執行模式。有效值為 SYNCASYNC
  • ExecutionId:整合項目的執行 ID。
  • IntegrationName:整合項目名稱。
  • Region:整合的區域。
  • ProjectId:包含整合項目的專案 ID。

查看變數

您可以使用「變數」窗格,在整合中建立、編輯、查看、複製及刪除變數。「Variables」窗格也會顯示整合作業中的變數參照總數。

如要查看「變數」窗格,請按一下設計工具導覽列中的 (切換面板)。

下圖為「變數」窗格範例版面配置:

整合設計工具 var 整合設計工具 var

查看及編輯設定變數

如要查看整合中定義的設定變數,請按一下「變數」窗格中的 variable_add 「整合設定變數」。這會顯示「設定變數」窗格,列出整合中定義的所有設定變數。只要按一下「Value」欄位,即可編輯設定變數的值。

下圖顯示「設定變數」窗格範例版面配置:

整合設定變數 整合設定變數

建立變數

如要建立變數,請執行下列步驟:

  1. 在整合服務編輯器導覽列中,按一下 (切換面板),即可顯示「變數」窗格。
  2. 點選「+建立」
  3. 在「Create Variable」窗格中執行下列操作:
    1. 名稱:輸入變數名稱。
    2. 變數類型:選擇變數類型。
    3. 資料類型 說明
      整合作業中的本機變數。
      整合的設定變數 整合中的設定變數
      整合作業輸入內容 在執行期間,系統會將變數提供為執行觸發事件的輸入內容。
      整合作業的輸出內容 執行作業結束時,變數的最終值應輸出至整合項目的呼叫端。
      整合作業的輸入和輸出 在執行時,系統會將變數做為輸入內容提供給已執行的觸發事件,並將最終值輸出至整合項目的呼叫端。
    4. 資料類型:選擇變數的資料類型。您可以透過變數名稱旁的圖示,識別變數的資料類型。
      資料類型 範例
      字串 Alex
      Integer 30
      Double 30.5
      布林值 true
      JSON { "employee":{"name":"Alex", "age":30, "city":"Mountain View"} }
      字串陣列 Alex, Kai, Raha
      整數陣列 30, 25, 22
      雙陣列 30.5, 25.34, 22.134
      布林值陣列 true, false, false

      如要瞭解支援的資料類型,請參閱「支援的資料類型」。

    5. 預設值:輸入變數的預設值。這是選填欄位。
    6. 結構定義:選取變數的 JSON 結構定義。
      • 從 JSON 酬載示例推斷:根據 JSON 酬載示例產生 JSON 結構定義。系統會在產生結構定義後捨棄酬載示例。只儲存產生的結構定義。
      • 輸入 JSON 結構定義:手動輸入整個 JSON 結構定義。
      • 根據預設值推斷:使用提供的預設值產生 JSON 結構定義。
      • None:沒有 JSON 結構定義。
    7. 在記錄中遮蓋變數 (預先發布):選取這個選項,即可在整合作業記錄中遮蓋變數。如要為變數啟用遮罩功能,您必須為整合項目和地區啟用遮罩變數。如要瞭解如何為整合和區域啟用遮罩功能,請參閱「編輯整合」和「編輯區域」相關說明。

      如要瞭解遮罩功能,請參閱「遮蓋記錄中的機密資料」。

  4. 按一下 [建立]。

在整合中使用變數

執行整合作業時,系統會將執行階段資料傳遞為變數,這些變數是為整合或工作宣告的。執行作業開始後,輸入資料會轉換為稱為「Event」的記憶體內物件。

建立 Event 物件後,系統會使用整合定義建立工作內部圖表。系統會根據您的設定,將傳入的變數值傳遞至工作。在整合執行期間,任務會讀取資料並將資料寫回 Event 物件,以供後續任務使用,或用於形成整合作業的輸出資料。

變數參照

整合中的任務、觸發事件和邊緣會使用變數參照讀取及寫入變數。變數參照的格式為 $paramKey$,其中 paramKey 是變數的名稱。例如,邊緣條件可能如下所示:

NOT ($isNameUnique$ = false OR $numAccounts$ > 1)

在這個範例中,isNameUnique 是資料類型 boolean 的變數,numAccounts 則是資料類型 integer 的參數。

配額與限制

如要進一步瞭解配額和限制,請參閱「配額與限制」。

後續步驟