Tableau Prep 命令列參考

可以透過主應用程式 (Tableau Prep.exe) 或命令列介面 (tableau-prep-cli.bat),使用命令列與 Tableau Prep 互動。

  • Tableau Prep.exe:用於設定應用程式初始化自身的方式。例如,安裝、啟用、授權、設定使用者資料目錄或疑難排解電子層。

  • Tableau-prep-cli.bat:用於執行流程。例如,在不開啟視覺介面的情況下傳遞認證、參數和重新整理資料輸出。

本文件按可用的公用程式分開介紹 Tableau Prep 支援並可供客戶使用的所有命令列語法選項。

本文件不包含 Tableau 開發人員與支援人員使用的其他受支援命令列語法。

Tableau Prep 應用程式

可以從 Tableau Prep.exe 應用程式的命令列執行以下動作。

安裝

以管理員身分從電腦命令列執行安裝程式 .exe 檔安裝 Tableau Prep。有關詳情,請參閱「從命令列安裝」(連結在新視窗開啟)

請注意:此選項僅適用於 Windows。

語法描述
tableau_<product_installer_name>.exe /option1 /option2 PROPERTY1 PROPERTY2

請以管理員身分從 .exe 檔案所在的目錄執行該指令,或指定電腦上 .exe 檔案的完整路徑。請勿從共用目錄執行。有關支援的安裝程式選項清單,請參閱安裝程式選項(連結在新視窗開啟)。有關支援的安裝程式屬性的清單,請參閱安裝程式屬性(連結在新視窗開啟)

  • tableau_<product_installer_name>.exe 是要安裝之產品及版本的 Tableau 安裝程式。

  • option1, option2 等是希望安裝過程執行的方式。

  • PROPERTY1, PROPERTY2 等允許指定安裝程式在安裝過程中應該進行的設定設定。

範例:

tableauPrepBuilder-64bit-2026-2-0.exe /quiet /norestart ACCEPTEULA=1 CRASHDUMP="0" SENDTELEMETRY="0"

此命令會在無提示模式下安裝 Tableau 版本 2026.2(不顯示提示、UI 或授權對話方塊)。它會在不重新啟動的情況下完成安裝、接受終端使用者授權合約 (EULA),並將錯誤報告和使用情況報告設定為關閉。

啟用、授權和註冊

使用這些命令檢查授權、在安裝期間或安裝後啟用產品,以及註冊產品。有關詳細資訊,請參閱啟用 Tableau Desktop 和 Tableau Prep Builder(連結在新視窗開啟)

語法描述
--activate <key>

使用提供的產品金鑰啟用產品。成功時以代碼 0 結束。否則結束時會顯示錯誤代碼。也接受單破折號 (-activate)。

若要在安裝過程中啟用產品,請新增一條包含安裝程式選項 ACTIVATE_KEY「<key>」的命令列,並在引號中輸入產品金鑰。

--register

註冊產品。也接受單破折號 (-register)。若要透過命令列註冊 Tableau,需要在將執行 Tableau Prep Builder 的每台電腦上預先填充登錄檔 (Windows) 或 .plist (Mac) 值。

對於 Windows,可以透過新增包含安裝程式選項 REGISTER=“1” 的單一命令列在安裝期間註冊產品。

有關詳情,請參閱註冊 Tableau Desktop 和 Tableau Prep Builder(連結在新視窗開啟)

--check-license 如果未獲得授權,則顯示啟用 UI。
--refresh

使用授權目前維護期的到期日期更新授權,並停止到期訊息。成功時以代碼 0 結束。也接受單破折號 (-refresh)。

Windows:使用 --refresh 選項和產品金鑰執行 tableau.exe。

MacOS:在 /Applications 路徑中對 Tableau 物件執行 -refresh 選項。

--return <key>

停用提供的產品金鑰,以便可以重複使用。也接受單破折號 (-return)。

Windows:使用 -return 選項和產品金鑰執行 tableau.exe。

MacOS:在 /Applications 路徑中對 Tableau 物件執行 -return 選項。

設定和儲存

使用這些命令設定檔案設定和存放庫位置。

語法描述
--settings-file <file location>

從指定檔案載入應用程式設定設定。可以多次指定以支援分層設定,例如擁有每個人都使用的全域 Proxy 伺服器設定以及用於流程的特定資料庫設定時。

.json 檔範例:

{
 "connection-sources":[
  {
	"endpoint":"prod-db-server.company.com",
	"username":"service_account_admin",
	"password":"secure_password_123"
	}
 ]
}

範例命令:

Windows: "C:\Program Files\Tableau\Tableau Prep Builder 2026.2\Tableau Prep Builder.exe" --settings-file "C:\ProgramData\Tableau\global-proxy-config.json" --settings-file "C:\Users\jsmith\AppData\Roaming\Tableau\db-config.json"

MacOS: /Applications/Tableau\ Prep\ Builder\ 2026.2.app/Contents/MacOS/Tableau\ Prep\ Builder --settings-file "/Library/Tableau/global-proxy-config.json" --settings-file "/Users/jsmith/Library/Application Support/Tableau/db-config.json"

--repository-location <file path>

設定存放庫目錄。預設情況下,在安裝期間,Tableau Prep 會在「文件」資料夾中建立一個名為「我的 Tableau Prep 存放庫」的資料夾。此資料夾包含流程、資料來源、連線以及記錄檔的資料夾和一個暫存快取。在伺服器或自動化環境中,可以使用此命令指定替代存放庫位置,並將流程執行指向該位置。

範例:

Windows: "C:\Program Files\Tableau\Tableau Prep Builder 2026.2\Tableau Prep Builder.exe" --repository-location "D:\Tableau_Data\My_Prep_Repo"

MacOS: /Applications/Tableau\ Prep\ Builder\ 2026.2.app/Contents/MacOS/Tableau\ Prep\ Builder --repository-location "/Users/jsmith/Documents/My Tableau Prep Repository"

--user-data-directory <location>

用於儲存電子應用程式資料的目錄。

--repository-location 管理業務資產(記錄和資料),而 --user-data-directory 管理應用程式的內部引擎。

如果在多個處理序需要隔離應用程式狀態的高並行環境中執行 Tableau Prep Builder,或者在對周邊伺服器上的持續性工作階段鎖定錯誤進行疑難排解時,請以管理員身分使用此旗標。

附註:執行命令時,它會自動建立 --user-data-directory 中指定的資料夾。但是,執行指令碼的使用者帳戶必須具有該父目錄的「寫入」權限。

範例:

Windows: "C:\Program Files\Tableau\Tableau Prep Builder 2026.2\Tableau Prep Builder.exe" --user-data-directory "D:\Tableau_Data\Prep_AppData"

MacOS: /Applications/Tableau\ Prep\ Builder\ 2026.2.app/Contents/MacOS/Tableau\ Prep\ Builder --user-data-directory "/Users/jsmith/Library/Application Support/Tableau Prep"

開啟檔案

使用這些命令開啟 .tfl 和 .tflx Tableau Prep 流程檔案。

語法描述
--tfl<file>

開啟指定的 .tfl 流程檔案。如果檔案路徑包含空格,請使用雙引號。

範例:

Windows: "C:\Program Files\Tableau\Tableau Prep Builder 2026.2\Tableau Prep Builder.exe" -tfl "C:\Users\jsmith\Documents\My Flows\Clean_Sales_Data.tfl"

MacOS: /Applications/Tableau\ Prep\ Builder\ 2026.2.app/Contents/MacOS/Tableau\ Prep\ Builder -tfl "/Users/jsmith/Documents/My Flows/Clean_Sales_Data.tfl"

--tflx<file>

開啟指定的 .tflx 封裝流程檔案。

範例:

Windows:"C:\Program Files\Tableau\Tableau Prep Builder 2026.2\Tableau Prep Builder.exe" --tflx "C:\Users\jsmith\Desktop\Quarterly_Report.tflx"

MacOS: /Applications/Tableau\ Prep\ Builder\ 2026.2.app/Contents/MacOS/Tableau\ Prep\ Builder --tflx "/Users/jsmith/Desktop/Quarterly_Report.tflx"

Tableau Prep 命令列應用程式

可以使用 Tableau Prep 命令列介面 (tableau-prep-cli.bat) 執行以下命令。

重新整理流程輸出

使用這些選項從命令列執行流程以重新整理流程輸出。此方法可讓您一次僅執行一個流程。有關詳情和限制,請參閱透過命令列重新整理輸出檔案(連結在新視窗開啟)

語法描述
-c, --connections <path>

包含資料來源和伺服器認證的 .json 檔路徑。

如果使用遠端連線,Tableau Prep Builder 將使用流程檔案和 credentials .json 檔案中的資訊來執行流程。有關詳情,請參閱 .json 檔要求的認證(連結在新視窗開啟)

如果連線至 Snowflake 資料庫,請務必包含任何特定參數,例如角色、倉儲,有時還包括 OAuth 權杖或外部瀏覽器驗證。

.json 設定檔案範例 - Snowflake:

{
 "connection-sources":[
  {
	"endpoint":"company_account.snowflakecomputing.com",
	"username":"SVC_TABLEAU_PREP",
	"password":"EncryptedPassword123",
	"attributes":{
	 "warehouse": "DATA_LOAD_WH",
	 "role": "TRANSFORM_ROLE"
	}
  }
 ]
}						

範例:

Windows: "\[Tableau Prep Builder install location]\Tableau Prep Builder <version>\scripts"\tableau-prep-cli.bat -c "path\to\[your credential file name].json" -t "path\to\[your flow file name].tfl"

MacOS: /Applications/Tableau\ Prep\ Builder\ [Tableau Prep Builder version].app/Contents/scripts/./tableau-prep-cli -c path/to/[your credential file name].json -t path/to/[your flow file name].tfl

- p, - - parameters

覆寫流程中預設參數值的 .json 檔案的路徑。該檔案獨立於 credentials.json 檔案,包含參數名稱和值。

有關詳情,請參閱.json 檔要求的認證(連結在新視窗開啟)中的「執行包含參數值的流程」。

範例:

Windows: "\[Tableau Prep Builder install location]\Tableau Prep Builder <version>\scripts"\tableau-prep-cli.bat -t "path\to\[your flow file name].tfl" -p|--parameters parameters.override.json

MacOS: /Applications/Tableau\ Prep\ Builder\ [Tableau Prep Builder version].app/Contents/scripts/./tableau-prep-cli -t path/to/[your flow file name].tfl -p|--parameters parameters.override.json

-t,--tflFile <file path>Tableau Prep 流程檔案的路徑。
-inc, --incrementalRefresh

如果伺服器上沒有啟用 Tableau Prep Conductor 來安排流程執行,可以使用此命令透過增量重新整理來執行流程。有關詳情,請參閱在啟用累加式重新整理的情況下執行流程。

範例:

Windows: "\[Tableau Prep Builder install location]\Tableau Prep Builder <version>\scripts"\tableau-prep-cli.bat --incrementalRefresh -t "path\to\[your flow file name].tfl"

MacOS: /Applications/Tableau\ Prep\ Builder\ [Tableau Prep Builder version].app/Contents/scripts/./tableau-prep-cli --incrementalRefresh -t path/to/[your flow file name].tfl

其他命令

使用這些命令列印 Tableau Prep 版本、開啟偵錯模式以偵錯流程過程、停用 SSL 驗證等。

語法描述
--version輸出目前版本的 Tableau Prep Builder CLI 並立即終止該程序。
-d, --debug

啟用偵錯模式。在存放庫資料夾中產生詳細記錄以進行疑難排解。記錄檔存放位置:My Tableau Prep Builder Repository\Command Line Repository\Logs

範例:

Windows: "\[Tableau Prep Builder install location]\Tableau Prep Builder <version>\scripts"\tableau-prep-cli.bat --debug -t "[your flow file name].tfl"

MacOS: /Applications/Tableau\ Prep\ Builder\ [Tableau Prep Builder version].app/Contents/scripts/./tableau-prep-cli --debug -t “[your flow file name]”.tfl

-dsv, --disableSslValidation

停用 SSL 憑證驗證(對某些內部伺服器環境很有用)。在 MacOS 上使用命令列執行流程時,會出現一個對話方塊,要求提供金輪鏈使用者和密碼。

從 Tableau Prep Builder 2019.3.2 版開始,您可以輸入這個額外參數來停用此鑰匙圈對話方塊。

範例:

MacOS: /Applications/Tableau\ Prep\ Builder\ [Tableau Prep Builder version].app/Contents/scripts/./tableau-prep-cli -dsv -c path/to/[your credential file name].json -t path/to/[your flow file name].tfl

-h, --help)

顯示命令列選項的說明功能表。

感謝您的意見反應!已成功提交您的意見回饋。謝謝!