在流程中建立和使用參數

套用到： Tableau Prep

在 Tableau Prep Builder 版本 2021.4.1 及更新版本以及 Web 版 Tableau Cloud 和 Tableau Server 版本 2021.4.0 及更新版本中支援

附註：除非特別說明，否則本主題中的內容適用於在 Tableau Prep Builder 中和 Web 上製作流程。有關在 Web 上製作流程的詳情，請參閱 Tableau Server(連結在新視窗開啟) 和 Tableau Cloud(連結在新視窗開啟) 說明中的 Web 版 Tableau Prep。

若經常使用具有相同架構的不同資料重複使用流程，則可以建立使用者參數並將其套用於流程，以輕鬆地在情境之間轉換。參數是全域預留位置值，例如數字、文字值或布林值，可以取代流程中的常數值。

現在可以構建一個流程，並使用參數來執行具有不同資料集的流程，而不是構建和維護多個流程。例如，可以為不同的銷售區域建立參數，然後將參數值套用到輸入檔案路徑，以僅使用該區域的資料執行流程。

從 Tableau Prep Builder 和 Tableau Cloud 版本 2023.2 開始，還可以在檔案或已發佈的資料來源輸出名稱中新增系統參數，以便在每次執行流程時自動新增時間戳記。

可以在哪裡套用參數？

參數可套用於檔案名稱、路徑、資料表名稱、篩選條件運算式和計算欄位，具體取決於步驟類型。從版本 2022.1.1 開始，甚至可以在使用 REST API 執行流程時包含參數覆寫值。有關詳情，請參閱 Tableau REST API 說明中的流程方法(連結在新視窗開啟)。

您可以將系統參數（版本 2023.2 及更高版本）應用於文件和已發佈資料來源輸出類型的輸出名稱。

下表列出了可以為每個步驟類型套用參數的位置。

步驟類型參數位置
輸入

使用者參數：

  • 連線到檔案：在檔案名稱或檔案路徑中使用參數
  • 連線到資料庫：對資料表名稱使用參數和在自訂 SQL 中使用參數
  • 運算式編輯器：篩選器
輸出

使用者或系統參數：

  • 輸出到檔案：在檔案名稱或檔案路徑中使用者參數，並從版本 2022.1.1 開始，即 Microsoft Excel 工作表名稱。在檔案名中套用系統參數。
  • 輸出到伺服器：在已發佈資料來源名稱中使用參數
  • 匯出到資料庫：使用者表名稱參數並從版本 2022.1.1 開始，在 SQL 指令碼中執行於將流程匯出寫入資料庫之前或之後。
清理、新列、樞紐、聯結、聯集

使用者參數：

  • 運算式編輯器：篩選器和計算欄位值
彙總

使用者參數：

  • 運算式編輯器：篩選器
指令碼

使用者參數：

  • 運算式編輯器：篩選器和計算欄位值
預測

使用者參數：

  • 運算式編輯器：篩選器和計算欄位值

 

建立使用者參數

使用者參數是針對使用它們的具體流程。從頂部功能表建立參數，然後定義適用於這些參數的值。還可以定義接受所有值的參數，這意味著任何流程使用者在執行流程時都可以輸入任何值。

可以將流程參數值設為必需或可選。執行流程時，系統會提示使用者輸入參數值。必須先輸入必需的參數值，然後使用者才能執行流程。可以輸入可選參數值，也可以接受當前（預設）值。然後將參數值套用於使用該參數的任何地方的流程執行。

附註：要在 Tableau Server 或 Tableau Cloud 上執行或排程包含參數的流程，管理員必須在伺服器上啟用流程參數設定。有關詳情，請參閱 Tableau Server(連結在新視窗開啟) 或 Tableau Cloud(連結在新視窗開啟) 說明中的在 Web 上建立流程並與之互動。

  1. 從頂部功能表中，按一下參數 圖示，然後按一下建立參數。

  2. 在建立參數對話方塊中，輸入名稱和描述（可選）。參數名稱必須是唯一的。這是新增參數時顯示在使用者介面中的值。

    如果包含描述，使用者可以在參數清單中查看暫留資訊（從版本 2022.1.1 開始）以及使用參數的位置。

  3. 選取以下資料類型之一。參數值必須與選取的資料類型相符。

    • 數字（整數或小數）
    • 字串
    • 布林值

  4. 指定允許值。這些是使用者可以在參數中輸入的值。

    • 全部：此選項允許使用者為參數輸入任何值，即使在執行流程時也是如此。

      附註：將此選項用於可在輸入和輸出步驟中使用的參數可能存在安全風險。例如，允許輸入任何值的自訂 SQL 查詢可能會將資料資產暴露給 SQL 插入攻擊。

    • 清單：輸入使用者在套用參數時可以選擇的值清單。要輸入多個值，請在每次輸入後按 Enter。
  5. （可選）選取執行時需要選取（在以前的版本中為在執行時提示值）。這可讓該參數成為必需項。使用者在執行或排程流程時需要輸入值。

  6. 輸入目前值。這是必需值，用作參數的預設值。

    • 全部：輸入值。
    • 清單：Tableau 會使用清單中的第一個值。使用下拉選項進行變更。
    • 布林值：選取 True 或 False。
  7. 按一下確定儲存參數。

變更使用者參數預設值

建立使用者參數時，必須指定當前（預設）值。如果流程中包含參數，則此值用於：

  • 執行在輸入步驟中定義的自訂 SQL 查詢。
  • 填寫執行時未指定的可選參數。
  • 將參數取代為已儲存步驟中的靜態值（版本 2022.1.1 及更新版本）。
  • 使用打包資料集發佈流程時，將參數取代為檔案路徑中的靜態值。

您可以隨時變更值。在頂端功能表中，可以編輯參數或使用參數清單上的設定按鈕。在流程中，可以在套用參數的任何位置使用設定按鈕。執行此動作時，會在使用該參數的任何地方重設參數的當前（預設）值，即使在自訂 SQL 查詢中也是如此。

編輯使用者參數

  1. 在頂端功能表中，按一下參數圖示。
  2. 按一下「編輯參數」。

  3. 在「編輯參數」對話方塊中，進行任何變更，然後按一下「確定」。

重設使用者參數預設值

要快速重設參數預設值，請使用設定按鈕。該按鈕顯示一個計數，指示流程中使用該參數的位置編號。

要突出顯示流程中使用參數的步驟，請按一下參數對話方塊上的在流程中查看。若僅有一個位置使用了參數，您可直接進入該步驟，並開啟設定檔窗格。

  1. 執行以下操作之一：

    • 在頂端功能表中，按一下參數圖示。使用此選項可重設流程中任何位置使用的參數值，或用於篩選器和計算欄位時的參數值。

    • 按一下在流程中套用的參數。可以將此選項用於檔案名稱、檔案路徑、表名稱、自訂 SQL 以及前後 SQL 指令碼中使用的參數。

  2. 選取或輸入參數值。

  3. 按一下「設定」以套用變更。

將參數套用於流程

建立使用者參數後，可以將它們套用到整個流程中的不同位置，具體取決於步驟類型。當流程執行時，參數值將套用於該流程執行以產生特定資料情境的匯出。

執行該流程時會自動生成系統參數（版本 2023.2 及更高版本）。只需將其套用到您的輸出步驟名稱，每次執行該流程時，參數都會隨流程執行開始日期或時間動態更新。

將參數套用於輸入步驟

在輸入步驟中，或使用自訂 SQL 時，可以使用使用者參數來取代檔案名稱、檔案路徑區段、資料庫表名稱。

檔案名稱或檔案路徑

在 Web 上編輯或製作流程時，此選項不可用。

可以在檔案路徑中包含使用者參數，但有一些例外。從版本 2022.1.1 開始，還可以查看參數值的預覽。

例外

  • 從版本 2022.1.1 開始，可以在 Web 上安排和執行在輸入檔案路徑中包含參數的流程。如果使用早期版本，請在 Tableau Prep Builder 中或從命令列執行流程。

  • 要在將流發佈到 Web 時在檔案路徑中包含參數，需要直接檔案連線。否則，使用當前值將參數轉換為靜態值。

    附註：直接檔案連線要求檔案位置包含在組織的允許清單中。有關詳情，請參閱 Tableau Server 說明中的安全清單輸入和輸出位置(連結在新視窗開啟)。

將使用者參數套用於檔案名稱或路徑

  1. 在檔案路徑的設定索引標籤中，將游標置於要新增參數的位置。

  2. 按一下參數 圖示，並選取參數。

  3. 查看參數值的預覽。當前（預設）值顯示在預覽中。執行流程時，系統會提示選取或輸入參數值。或輸入參數值。

資料庫資料表

在資料表名稱中使用參數時，整個資料表名稱必須為該參數。目前不支援對資料表名稱的部分使用參數。

附註：尚不支援對 Google BigQuery 輸入連線中的資料表名稱使用參數。

  1. 在資料表欄位的設定索引標籤中，按一下下拉功能表。

  2. 選取使用參數，然後從清單中選取參數。

自訂 SQL

  1. 在「連線」窗格中，按一下「自訂 SQL」。

  2. 在「自訂 SQL」中，在文字方塊中鍵入或貼上查詢。

  3. 按一下參數 圖示，並選取參數。

  4. 按一下執行，以執行查詢。執行流程之前，系統不會提示輸入參數值。相反地，查詢最初將使用參數的當前值執行。

    注意：如果該參數在流程中的其他位置使用並且當前值已重設，則該變更可能會影響查詢。

將使用者參數套用於輸出步驟

在輸出步驟中，可以在以下位置套用該參數：

  • 檔案名
  • 檔案路徑的區段
  • 已發佈資料來源名稱
  • 資料庫表名稱
  • Microsoft Excel 工作表名稱（版本 2022.1.1 及更新版本）
  • 在將流程匯出資料寫入資料庫之前或之後執行的自訂 SQL 指令碼（版本 2022.1.1 及更新版本）

檔案名稱或檔案路徑

在 Web 上建立或編輯流程時，此匯出選項不可用

  1. 在輸出窗格中，從將輸出儲存到下拉清單中選取檔案。

  2. 在名稱或位置欄位中，按一下參數 圖示並選擇參數。

    對於檔案路徑，將游標放在要新增參數的位置。

    執行流程時，系統會提示輸入參數值。

已發佈資料來源名稱

  1. 在輸出窗格中，從將輸出儲存到下拉清單中選取已發佈資料來源。

  2. 在名稱欄位中，按一下參數 圖示並選取參數。

    執行流程時，系統會提示輸入參數值。

資料庫表和自訂 SQL 前後

  1. 在輸出索引標籤中，從將輸出儲存到下拉清單中選取資料庫資料表。

  2. 在資料表欄位中，選取使用參數，然後從清單中選取參數。

  3. （可選）按一下自訂 SQL索引標籤。從版本 2022.1.1 開始，可以輸入帶有參數的 SQL 指令碼，在資料寫入表之前和之後執行。要包含參數，請按一下插入參數，然後選取參數。

    有關在將匯出寫入資料庫時使用 SQL 指令碼的更多資訊，請參閱將流程輸出資料儲存到外部資料庫。

    注意：SQL 指令碼中使用的參數必須手動刪除。有關詳細資訊，請參閱手動刪除使用者參數。

    執行流程時，系統會提示輸入參數值。

在輸出步驟中套用系統參數

在匯出步驟中，可以在以下位置套用系統參數：

  • 檔案名
  • 已發佈資料來源名稱

檔案名

在 Web 上建立或編輯流程時，此匯出選項不可用

  1. 在輸出窗格中，從將輸出儲存到下拉清單中選取檔案。

  2. 在「名稱」欄位，按一下 圖示，並從以下執行日期或執行時間參數中選擇。您可以組合多個系統參數建立您需要的任何時間戳記。

    執行日期

    • 日期：年-月-日、年月日、日-月-年
    • 月：月份名稱、月份編號
    • 週數
    • 季度編號
    • 年數

    執行

    • 年-月-日_小時-分鐘-秒（24 小時）
    • 年月日_小時分鐘秒（24 小時）

    執行該流程時，Tableau Prep 使用您的本地時區或伺服器時區套用該流程開始執行時間。

已發佈資料來源名稱

  1. 在輸出窗格中，從將輸出儲存到下拉清單中選取已發佈資料來源。

  2. 在「名稱」欄位，按一下 圖示，並從以下執行日期或執行時間參數中選擇。您可以組合多個系統參數建立您需要的任何時間戳記。

    執行日期

    • 日期：年-月-日、年月日、日-月-年
    • 月：月份名稱、月份編號
    • 週數
    • 季度編號
    • 年數

    執行

    • 年-月-日_小時-分鐘-秒（24 小時）
    • 年月日_小時分鐘秒（24 小時）

    執行該流程時，Tableau Prep 使用您的本地時區或伺服器時區套用該流程開始執行時間。

將使用者參數套用於篩選條件計算

使用使用者參數篩選整個流程中的資料。在輸入步驟中篩選資料集或在步驟或欄位值層級套用篩選器參數。例如，使用篩選器參數只輸入特定區域的資料，或將步驟中的資料篩選到特定部門。

注意：從版本 2022.1 開始，存在具有相同名稱和資料類型的相同參數時，可以使用複製和貼上在其他流程中重複使用帶有參數的篩選器計算。

  1. 從設定檔窗格上的輸入步驟或工具列中，按一下篩選器值。要將參數篩選器新增到欄位，從更多選項功能表中選取篩選器 > 計算。

  2. 在新增篩選器計算編輯器中，輸入參數名稱以從清單中選取（參數顯示為紫色），然後按一下儲存，以儲存篩選器。

    執行流程時，系統會提示輸入參數值。

將使用者參數套用於計算欄位

使用使用者參數取代在整個流程中使用的計算中的常數值。可以在步驟或欄位值層級套用計算參數。

注意：從版本 2022.1 開始，存在具有相同名稱和資料類型的相同參數時，可以使用複製和貼上在其他流程中重複使用帶有參數的計算。

  1. 從設定檔窗格的工具列中，按一下建立計算欄位。要將參數新增到欄位上的計算中，從更多選項功能表中選取建立計算欄位 > 自訂計算。

  2. 在新增欄位計算編輯器中輸入計算，並輸入參數名稱以從清單中選擇它，然後按一下儲存以儲存計算。

    執行流程時，系統會提示輸入參數值。

刪除使用者參數

要刪除不再需要的參數，請按一下「編輯參數」對話方塊中的「刪除參數」。這將刪除整個流程中使用的參數的任何執行個體，並將其取代為參數的當前值。此動作無法復原。

注意：刪除流程中參數的選項因版本而異。對於 2022.1 及更新版本，請使用以下說明。對先前版本使用手動刪除使用者參數，並刪除在將匯出寫入資料庫之前或之後執行的自訂 SQL 指令碼中使用的參數。

  1. 從頂端功能表中，按一下參數 圖示下拉式功能表，然後按一下要刪除參數的「編輯參數」。

  2. 在「編輯參數」對話方塊中，按一下「刪除參數」。

  3. 在確認對話中，再次按一下刪除參數。可以按一下在流程中查看以突出顯示步驟並在刪除參數之前調查參數的使用位置。

手動刪除使用者參數

適用於版本 2021.4.4 及更早版本以及自訂 SQl 指令碼前後使用的參數

在可以從參數清單中使用者刪除參數前，必須首先從您的流程中找到並刪除所有參數執行個體，「變更」窗格中的參數也不例外。

  1. 從頂端功能表中，按一下參數圖示下拉式功能表。

  2. 對於要刪除的參數，按一下在流程中檢視，以查找流程中使用該參數的所有執行個體。

    若該參數未在流程中的任何位置使用，請跳至步驟 4。

  3. 對於使用參數的每個步驟，移除參數，包括刪除變更窗格中列出的任何變更。
  4. 從頂端功能表中，按一下參數圖示下拉式功能表，對於要刪除的參數，按一下編輯參數 。

  5. 在「編輯參數」對話方塊中，按一下「刪除參數」。

    該參數將取代為參數的當前值。

執行具有參數的流程

執行包含參數的流程與執行不包含參數的流程相同，只是在執行時或在將流程新增到排程時提示輸入使用者參數值 Tableau Server 或 Tableau Cloud。

執行該流程時會自動套用系統參數。

如果使用者參數被標記為必需，使用者必須輸入一個值才能執行該流程。如果參數是可選的，使用者可以輸入一個值或預設接受參數的當前值。

必需參數是在執行時需要選取（在以前的版本中為在執行時提示值）核取方塊選取的參數。

若使用命令列介面執行流程，並想覆寫目前（預設）參數值，請建立參數覆寫 .json 檔案，並在命令列中包含 -p --parameters 語法。有關詳細資訊，請參閱透過命令列重新整理流程輸出檔案。

手動執行流程

從 Tableau Prep Builder 中執行流程，或在 Tableau Server 或 Tableau Cloud 中手動執行流程時，按一下執行時，參數對話方塊會開啟。

  1. 輸入或選取使用者參數值。如果流程中有可選參數，可以在此時輸入值或接受當前（預設）參數值。
  2. 按一下執行流程，以執行流程。

有關執行流程的詳情，請參閱將流程發佈至 Tableau Server 或 Tableau Cloud。

按排程執行流程

排程流程在 Tableau Server 或 Tableau Cloud 上執行流程時，需要在排程流程時輸入所有必需的使用者參數值。

  1. 在新建工作或已連結工作索引標籤上的設定參數區段，輸入或選取參數值。若流程中有可選參數，可以此時輸入值或將該欄位留空以使用目前（預設）參數值。

    新建工作

    已連結工作

  2. 按一下建立工作，以排程流程。

有關排程流程工作的詳情，請參閱 Tableau Server(連結在新視窗開啟) 說明中的《排程流程工作》。

返回頂端
感謝您的意見反應！已成功提交您的意見回饋。謝謝！