Tableau Prep コマンド ライン リファレンス

Tableau Prep の操作は、メイン アプリケーション (Tableau Prep.exe) またはコマンド ライン インターフェイス (tableau-prep-cli.bat ) でコマンド ラインを実行して行うことができます。

  • Tableau Prep.exe: アプリケーションの初期化方法を構成するために使用します。たとえば、インストール、有効化、ライセンス発行、ユーザー データ ディレクトリの設定、または Electron シェルのトラブルシューティングなどです。

  • 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) またはプロパティ リスト (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>

指定されたファイルからアプリケーションの構成設定を読み込みます。すべてのユーザーが使用するグローバル プロキシ サーバー構成や、フローに使用する特定のデータベース構成がある場合など、階層化された構成に対応できるように複数回指定できます。

.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>

Electron アプリケーションデータの保存に使用されるディレクトリ。

--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) を使用して実行できます。

フロー出力の更新

このオプションを使用して、コマンド ラインからフローを実行し、フロー出力を更新します。この方法では、一度に 1 つのフローのみを実行できます。詳細と制限事項については、「コマンド ラインからフロー出力ファイルを更新(新しいウィンドウでリンクが開く)」を参照してください。

構文 説明
-c, --connections <path>

データ ソースおよびサーバーの認証資格情報を含む.json ファイルへのパス。

リモート接続がある場合、Tableau Prep Builder は、フロー ファイルと認証資格情報の .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

デバッグ モードを有効にします。リポジトリ フォルダーに詳細なログを生成して、トラブルシューティングを行います。ログ ファイルは次の場所に保管されます: マイ Tableau Prep Builder リポジトリ\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

コマンドライン オプションのヘルプ メニューを表示します。

フィードバックをお送りいただき、ありがとうございます。フィードバックは正常に送信されました。ありがとうございます!