コマンド ラインからフロー出力ファイルを更新

Tableau Prep Builder からフローを実行する代わりに、コマンド ラインからフローを実行してフロー出力を更新できます。この方法を使用して、一度に 1 つのフローを実行できます。このオプションは、Tableau Prep Builder がインストール済みの Windows または Mac の両マシンで利用できます。

コネクタの制限:

  • JDBC や ODBC コネクタ: これらのコネクタを含むフローは、バージョン 2019.2.3 以降のコマンド ラインから実行できます。
  • クラウド コネクタ: Google BigQuery などのクラウド コネクタを含むフローは、コマンド ラインからは実行できません。代わりに、手動でフローを実行するか、Tableau Prep Conductor を使用して Tableau ServerTableau Online のスケジュールに基づいてフローを実行します。詳細については、フロー データを最新に維持するを参照してください。

Windows マシンでは、Windows タスク スケジューラを使用して、このプロセスのスケジュールを設定できます。Microsoft オンライン ヘルプの「Task Scheduler」(Link opens in a new window)を参照してください。

コマンド ラインからフローを実行する際、Tableau Prep Builder により、Tableau Prep Builder で指定した出力ステップの設定を使用したフローのすべての出力が更新されます。出力場所の指定方法に関する詳細は、データ抽出とデータ ソースの作成とパブリッシュ(Link opens in a new window)を参照してください。書き込みオプション (バージョン 2020.2.1 以降) の設定の詳細については、書き込みオプションの構成を参照してください。

フローを実行する前に

コマンド ラインからフローを実行するには、フローを実行しているマシンの管理者権限と、次の情報が必要です。

  • Tableau Prep Builder のインストール パス。

  • データベースに接続し、出力ファイルをサーバーまたはデータベースにパブリッシュしている場合は (バージョン 2020.3.1 以降)、必要なすべての認証資格情報を含む .json 認証資格情報ファイル。

  • Tableau Flow (.tfl) ファイルが置かれているパス。

認証資格情報 .json ファイルの要件

注: フロー接続後の出力先がローカル ファイルの場合や、Windows 認証 (SSPI) を使用するネットワーク共有上に保管されているファイルか入力ファイルの場合は、認証資格情報の .json ファイルは不要です。Windows 認証の詳細については、Microsoft オンライン ヘルプの「SSPI Model (SSPI モデル)」(Link opens in a new window) (英語) を参照してください。

Tableau Prep Builder は、フロー ファイルと認証資格情報の .json ファイルからの情報を使用して、リモート接続がある場合にフローを実行します。たとえば、リモート接続のデータベース名と、出力ファイル用のプロジェクト名はフローからの情報で、サーバー名とサインイン用の認証資格情報は、認証資格情報の .json ファイルからの情報です。

  • ファイルを再利用する予定がある場合、Tableau Prep Builder のインストール プロセスによって上書きされないフォルダにファイルを配置してください。
  • データベース ファイルやパブリッシュされたデータ ソースに接続するフロー、サーバーに出力をパブリッシュするフロー、またはデータベースに出力をパブリッシュするフローを実行している場合は (バージョン 2020.3.1 以降)、これらの場所への接続に必要な認証資格情報を含む .json ファイルが必要です。
  • フローで指定された認証資格情報と .json ファイルに含まれる認証資格情報が一致する必要があります。一致しない場合は、フローの実行に失敗します。
  • プロセスを実行すると、ホスト名、ポート、ユーザー名が使用され、一致する接続が Tableau フロー ファイル (.tfl) で検索され、プロセスの実行前に更新されます。接続に必要でない場合は、ポート ID とサイト ID は任意です。
  • パブリッシュされたデータ ソースに接続する場合は、ホスト名、contentUrl、ポート (http の場合は 80、https の場合は 443) を入力接続に含めます。ホスト名は Tableau フロー ファイル (.tfl) 内で一致する接続を検索する際に必要となります。contentUrl とポートは、サーバーへの接続を確立するために使用します。

  • Tableau Online に接続する場合は、接続先のポッドの入力接続にポート (80 や 443) を含めます。Tableau Online の詳細については、Tableau Online ヘルプの「Tableau Online への Tableau Bridge 接続」(Link opens in a new window)を参照してください。

Tableau Prep Builder のバージョンによっては、認証資格情報の書式設定が異なる場合があります。以下のタブをクリックして、お使いの Tableau Prep Builder バージョンの認証資格情報の書式設定を確認してください。

接続に応じて、サーバーまたはデータベースの認証資格情報、またはその両方を含めます。フローが同じサーバーまたはデータベースに接続して出力される場合は、.json ファイルに 1 つのブロックを含めるだけで済みます。異なる認証資格情報を使用するサーバーまたはデータベースに接続する場合は、コンマ区切りの配列を使用します。

サーバー接続 データベース接続

接続ブロック名: "tableauServerConnections"

配列に次のデータを含めます。

  • hostname (サーバー名)
  • contentUrl (パブリッシュされたデータ ソース)
  • siteName。これは Tableau Server または Tableau Online にサインインしたときに URL の /site/ の後ろに表示されます
  • port (ポート ID)
  • username
  • password

接続ブロック名: "databaseConnections"

配列に次のデータを含めます。

  • hostname (サーバー名)
  • port (ポート ID)
  • username
  • password

このセクションでは、認証資格情報の .json 要件を使用して作成できる認証資格情報ファイルの例をいくつか示します。

サーバー接続への接続

次の例は、同じ認証資格情報を使用するサーバー接続に接続して出力する .json 認証資格情報ファイルを示しています。

{
"tableauServerConnections":[
  {
    "hostname":"https://my-server",
    "contentUrl": "my-testing-site",
    "port":443,
    "siteName": "FinanceTeam"
    "username": "jsmith"
    "password": "passw0rd$"
  }
]
}				

サーバー接続とデータベース接続への接続

次の例は、サーバー接続に接続してデータベース接続に出力する .json 認証資格情報ファイルを示しています。

{
"tableauServerConnections":[
  {
    "hostname":"https://my-server",
    "contentUrl": "my-testing-site",
    "port":443,
    "siteName": "FinanceTeam"
    "username": "jsmith"
    "password": "passw0rd$"
  }
],
"databaseConnections":[
  {
    "hostname":"example123.redshift.amazonaws.com",
    "port":"5439",
    "username":"jsmith",
    "password":"p@s$w0rd!"
  }
]
}

異なるデータベース接続への接続と出力

次の例は、異なるデータベース接続に接続して出力する .json 認証資格情報ファイルを示しています。

{
"databaseConnections":[
  {
    "hostname":"example123.redshift.amazonaws.com",
    "port": "5439",
    "username": "jsmith"
    "password": "p@s$w0rd!"
  },
  {
    "hostname":"mysql.mydb.tsi.lan",
    "port": "3306",
    "username": "jsmith"
    "password": "mspa$$w0rd"
   }
]
}			

入力接続と出力接続の配列を入力します。

: Tableau Prep Builder バージョン 2018.2.2 から 2018.3.1 までを使用している場合は、入力または出力でリモート接続しない場合でも、"inputConnections" 配列と "outputConnections" 配列を常に含めるようにします。これらの配列を空白のままにします。Tableau Prep Builder バージョン 2018.3.2 以降を使用している場合、空白の配列を含める必要はありません。

入力接続 出力接続
  • hostname (サーバー名)
  • contentUrl (パブリッシュされたデータ ソース)
  • siteName。これは Tableau Server または Tableau Online にサインインしたときに URL の /site/ の後ろに表示されます
  • port (ポート ID)
  • username
  • password
  • serverUrl
  • contentUrl (サイト ID。これは Tableau Server または Tableau Online にサインインしたときに URL の /site/ の後ろに表示される情報です)
  • username
  • password

このセクションでは、認証資格情報の .json 要件を使用して作成できる認証資格情報ファイルの 2 つの異なる例を示します。

パブリッシュされたデータ ソースへの接続

この例では、パブリッシュされたデータ ソースに接続し、サイト ID を含むサーバーにデータを出力する .json 認証資格情報ファイルを示します。

: inputConnection や outputConnection で既定のサイトが使用されている場合は、ContentUrl を空白に設定します。例: "contentUrl": ""

{
"inputConnections":[
  {
    "username": "jsmith",
    "contentUrl": "my-testing-site",
    "hostname":"https://my-server",
    "port":443,
    "password": "passw0rd$"
  }
],
"outputConnections":[
  {
    "serverUrl":"https://my-server",
    "contentUrl":"my-testing-site",
    "username":"jsmith",
    "password":"passw0rd$"
  }
]
}

2 つのデータベースへの接続

このサンプル フローでは、MySQL と Oracle に接続して、サイト ID を含むサーバーにデータを出力する .json 認証資格情報ファイルを示します。

{
"inputConnections":[
  {
    "username": "jsmith",
    "hostname":"mysql.example.lan",
    "port":1234,
    "password": "passw0rd"
  },
  {
    "username": "jsmith",
    "hostname":"Oracle.example.lan",
    "port":5678,
    "password": "passw0rd" 
  }
],
"outputConnections":[
  {
    "serverUrl":"http://MyServer",
    "contentUrl":"FinanceTeam",
    "username":"jsmith",
    "password":"passw0rd$"
  }
]
}

認証資格情報ファイルの作成に関するヒント

フロー実行時のエラーを防ぐには、認証資格情報ファイルが次のガイドラインを満たしている必要があります。

  • Tableau Prep Builder バージョン 2018.2.2 から 2018.3.1 までを使用している場合は、入力または出力でリモート接続しない場合でも、"inputConnections" 配列と "outputConnections" 配列を常に含めるようにします。これらの配列を空白のままにします。

    Tableau Prep Builder バージョン 2018.3.2 以降を使用している場合、空白の配列を含める必要はありません。

    • リモートの入力接続がない場合は、.json ファイルの冒頭に次の構文を含めます。

      {
      "inputConnections":[
        ],
    • リモートの出力接続がない場合は、.json ファイルの末尾に次の構文を含めます。

    • "outputConnections":[
        ]
      }
  • 入力接続用のポート ID がないか、またはサーバー名の一部としてポートが指定されていませんか?

    接続用のポート ID がない場合は、.json ファイルの "port":xxxx, 参照を含めないようにします。これは、"port": "" の場合も同じです。ポート ID がサーバー名に含まれている場合は、ホスト名にポート ID を含めます。例: "hostname": "mssql.example.lan,1234"

  • "serverUrl": を参照するときに、アドレスの最後に "/" を含めないようにします。たとえば、"serverUrl": "http://server" のようにします。"serverUrl": "http://server/" とはしません。

  • 入力用または出力用の接続が複数ある場合は、接続ごとの認証資格情報をファイルに含めるようにします。

  • パブリッシュされたデータ ソースに接続する場合は、入力接続に必ずホスト名と contentUrl を含めてください。

フローの実行

重要: 以下の例には、"Tableau Prep" バージョン 2019.1.2 から "Tableau Prep Builder" への名称の変更が含まれます。本製品の以前のバージョンを使用している場合、代わりに "Tableau Prep" を使用してください。

  1. 管理者としてコマンド プロンプトやターミナル コマンド プロンプト (MacOS) を開きます。

  2. 以下に示す構文を使用して、次のいずれかのコマンドを実行します。

    • ローカル ファイルまたはネットワーク共有上に保管されているファイルに接続し、ローカル ファイルやネットワーク共有上に保管されているファイルにパブリッシュするか、Windows 認証を使用するフローはでは次のように実行します。

      : ネットワーク共有上に保管されているファイルに接続するかこのファイルに出力する場合、パスに UNC 形式を使用します: \\server\path\file name。パスワード保護は利用できません。

      Windows

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

      Mac

                                          /Applications/Tableau\ Prep\ Builder\ [Tableau Prep Builder version].app/Contents/scripts/./tableau-prep-cli -t path/to/[your flow file name].tfl
                                      
    • データベースに接続するかサーバーにパブリッシュするフローでは次のように実行します。

      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"
                                      

      Mac

                                          /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
                                      
    • フロー ファイルまたは認証資格情報ファイルがネットワーク共有上に保管されている (パス: \\server\path\file name に UNC 形式を使用) 場合は次のように実行します。

      Windows

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

      Mac: 検索でネットワーク共有を /Volumes にマップし永続的にしてから、/Volumes/.../[your file] を使用してパスを次のように指定します。

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

よくあるエラーと解決策については、コマンド ラインを使用してフローを実行する際の一般的なエラーを参照してください。

増分更新を有効にしてフローを実行する (バージョン 2020.2.1 以降)

サーバーで Tableau Prep Conductor を有効にせずにフローの実行をスケジュールしている場合は、コマンド ラインから増分更新を使用してフローを実行できます。次の例に示すように、--incrementalRefresh パラメーターをコマンド ラインに含めます。

Windows

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

Mac

                    /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 Builder は次の処理を行います。

  • 増分更新が有効になっているフロー内のすべての入力では、増分更新を使用して、対応するすべての出力が実行されます。
  • フロー内の入力で増分更新が有効になっていない場合、すべての出力は、完全更新を使用して実行されます。メッセージによって更新方法の詳細が示されます。
  • フロー内の一部の入力で増分更新が有効になっている場合、対応する出力は、増分更新を使用して実行されます。他の出力は、完全更新を使用して実行され、メッセージにより更新方法の詳細が示されます。

増分更新を使用するためにフローを構成する方法の詳細については、増分更新を使用したフロー データの更新を参照してください。増分更新を使用したフロー データの更新

コマンドオプション

オプションのヘルプを見たい場合はコマンドラインで -h を含めます。

コマンドオプション 説明 メモ
-c , --connections <arg> ログイン情報ファイルへの接続パスです。 認証資格情報ファイルが置かれている場所へのパスが必要です。
-d, --debug フロープロセスのデバッグを行います。 このオプションを含めることで、フローの更新時に発生する問題のデバッグに役立つ詳細情報が表示されます。ログ ファイルは次の場所に保管されます。My Tableau Prep Builder Repository\Command Line Repository\Logs
-dsv, --disableSslValidation SSL 検証の無効化 (MacOS) MacOS でコマンド ラインを使用してフローを実行すると、キーチェーンのユーザーとパスワードを要求するダイアログが表示されることがあります。Tableau Prep Builder バージョン 2019.3.2 以降では、次のような追加パラメーターを渡してこのキーチェーン ダイアログを無効にすることができます。例: /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 構文オプションのヘルプを表示します。

ヘルプ オプションあるいは構文エラーには次のような情報が表示されます。

usage: tableau-prep-cli [-c <arg>] [-d]  [-h] [-t <arg>]
-c,--connections <arg>        Path to a file with all connection information
-d,--debug                    This option is for debugging
-dsv,--disableSslValidation   Disable SSL validation
-h,--help                     Print usage message
-inc,--incrementalRefresh     Run incremental refresh for all outputs that are configured to support it
-t,--tflFile <arg>            The Tableau Prep Builder flow file	
-inc, --incrementalRefresh 増分更新を使用するように構成したすべての出力で増分更新を実行します。

増分更新を使用するように構成したすべての入力で増分更新を実行するには、このオプションを含めます。増分更新を使用すると、Tableau Prep Builder は、フロー内のすべての行ではなく、新しい行のみを取得して処理できます。

インプット ステップでの増分更新の構成設定によって、徐々に実行できるフロー出力が決まります。他のすべての出力は、完全更新を使用して実行され、メッセージにより更新方法の詳細が示されます。

増分更新を使用したフローの実行の詳細については、増分更新を使用したフロー データの更新を参照してください。

-t, --tflFile <arg> .tfl フローファイルです .tfl フロー ファイルが置かれている場所へのパスが必要です。

構文例

以下のコマンド ラインは、下記の条件でフローを実行する場合の 4 種類の例を示したものです。

  • Tableau Prep Builder のバージョン: 2020.3.1

    重要: 以下の例には、Tableau Prep バージョン 2019.1.2 から Tableau Prep Builder への名称の変更が含まれます。本製品の以前のバージョンを使用している場合、代わりに "Tableau Prep" を使用してください。

  • フロー名: Flow1.tfl

  • フローの格納場所: C:\Users\jsmith\Documents\My Tableau Prep Builder Repository\Flows

  • 資格認証情報ファイル名: Flow 1.json

  • 資格認証情報ファイルの格納場所: C:\Users\jsmith\Desktop\Flow credentials

  • ネットワーク共有上の資格認証情報ファイルの格納場所: \tsi.lan\files\Flow credentials

フローの接続先とパブリッシュ先がローカル ファイルの場合

Windows

                    "\Program Files\Tableau\Tableau Prep Builder 2020.3.1\scripts"\tableau-prep-cli.bat -t "\C:\Users\jsmith\Documents\My Tableau Prep Builder Repository\Flows\Flow1.tfl"
                

Mac

                    /Applications/Tableau\ Prep\ Builder\ 2020.3.1.app/Contents/scripts/./tableau-prep-cli -t /Users/jsmith/Documents/My\ Tableau\ Prep\ Builder\ Repository/Flows.Flow1.tfl
                

フローの接続先とパブリッシュ先がローカル ファイルであり、増分更新に短い形式を使用する場合

Windows

                    "\Program Files\Tableau\Tableau Prep Builder 2020.3.1\scripts"\tableau-prep-cli.bat -inc -t "\C:\Users\jsmith\Documents\My Tableau Prep Builder Repository\Flows\Flow1.tfl"
                

Mac

                    /Applications/Tableau\ Prep\ Builder\ 2020.3.1.app/Contents/scripts/./tableau-prep-cli -inc -t /Users/jsmith/Documents/My\ Tableau\ Prep\ Builder\ Repository/Flows.Flow1.tfl
                

フローの接続先がデータベースでパブリッシュ先がサーバーの場合

Windows

                    "\Program Files\Tableau\Tableau Prep Builder 2020.3.1\scripts"\tableau-prep-cli.bat -c "\C:\Users\jsmith\Desktop\Flow credentials\Flow1.json" -t "\C:\Users\jsmith\Documents\My Tableau Prep Builder Repository\Flows\Flow1.tfl"
                

Mac

                    /Applications/Tableau\ Prep\ Builder\ 2020.3.1.app/Contents/scripts/./tableau-prep-cli -c /Users/jsmith/Desktop/Flow\ credentials/Flow1.json -t /Users/jsmith/Documents/My\ Tableau\ Prep\ Builder\ Repository/Flows.Flow1.tfl
                

フローのパブリッシュ先がサーバーで認証資格情報ファイルがネットワーク共有上に保管されている場合

Windows

                    "\Program Files\Tableau\Tableau Prep Builder 2020.3.1\scripts"\tableau-prep-cli.bat -c "\\tsi.lan\files\Flow credentials\Flow1.json" -t "\C:\Users\jsmith\Documents\My Tableau Prep Builder Repository\Flows\Flow1.tfl"
                

Mac

                    /Applications/Tableau\ Prep\ Builder\ 2020.3.1.app/Contents/scripts/./tableau-prep-cli -c /Volumes/files/Flow\ credentials/Flow1.json -t /Users/jsmith/Documents/My\ Tableau\ Prep\ Builder\ Repository/Flows.Flow1.tfl
                
ありがとうございます! フィードバックの送信中にエラが発生しました。もう一度やり直すか、メッセージをお送りください