Tableau Prep ヘルプ

Tableau Prep Builder でのみサポートされます。

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

注: ログインベースのライセンス管理 (LBLM) を使用している場合は、Tableau Prep を定期的に開くようにしてください。そうしなければ、リースが期限切れになるため、コマンド ラインを介して実行されるフローが失敗する可能性があります。管理者に連絡して、リース期間を最長に変更することもできます。詳細については、「ログインベースのライセンス管理」(新しいウィンドウでリンクが開く)を参照してください。

コネクタの制限:

• JDBC または ODBC コネクタ: これらのコネクタを含むフローは、バージョン 2019.2.3 以降のコマンド ラインから実行できます。
• クラウド コネクタ: Google BigQuery などのクラウド コネクタを含むフローは、コマンド ラインからは実行できません。代わりに、手動でフローを実行するか、Tableau Prep Conductor を使用して Tableau Server や Tableau Cloud のスケジュールに基づいてフローを実行します。詳細については、フロー データを最新に維持するを参照してください。
• シングル サインオン認証: シングル サインオン認証を使用する場合、コマンド ラインからのフローの実行はサポートされていません。代わりに、Tableau Prep Builder からフローを実行できます。
• 多要素認証: Tableau Prep のコマンド ライン インターフェイス (CLI) は、Tableau の多要素認証 (MFA) をサポートしません。詳細については、Tableau ナレッジ ベースのこの記事(新しいウィンドウでリンクが開く)を参照してください。

Windows マシンでは、Windows タスク スケジューラを使用して、このプロセスのスケジュールを設定できます。Microsoft オンライン ヘルプの「Task Scheduler」(新しいウィンドウでリンクが開く)を参照してください。

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

フローを実行する前に

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

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

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

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

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

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

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

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

• パブリッシュされたデータ ソースに接続する場合は、ホスト名、contentUrl、ポート (http の場合は 80、https の場合は 443) を入力接続に含めます。ホスト名は Tableau フロー ファイル (.tfl) 内で一致する接続を検索する際に必要となります。contentUrl とポートは、サーバーへの接続を確立するために使用します。

• Tableau Cloud に接続する場合は、接続先のポッドの入力接続にポート (80 または 443) を含め、サーバー接続 URl には対応するポッド プレフィックスと online.tableau.com を必ず含めてください。Tableau Cloud の詳細については、Tableau Cloud ヘルプの「Tableau Cloud への Tableau Bridge 接続」(新しいウィンドウでリンクが開く)を参照してください。
• (バージョン 2021.4.1 以降) フローにパラメーターを含める場合は、パラメーター オーバーライド .json ファイルを作成してコマンド ラインに含め、パラメーター値を現在の既定値から変更できます。詳細については、パラメーター値を含むフローの実行を参照してください。

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

{
    "Parameter 1": Value 1,
    "Number Parameter": 40,
    "Boolean Parameter": True
}				

 "\[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

/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

{
 "tableauServerConnections":[
   {
    "serverUrl":"https://my.server",
    "contentUrl": "mysite",
    "port":443,
    "username": "jsmith",
    "password": "passw0rd$"
   }
 ]
}				

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

{
 "extensions": [
    {
	  "extensionName": "rSupport",
	  "regular": {
		"host": "localhost",
		"port": "9000",
		"username": "jsmith"
	},
	"sensitive": {	
	  "password": "pwd"	
	}
   },
   {
	"extensionName": "pythonSupport",
	"regular": {
	  "host": "localhost",
	  "port": "9000"
	},
	"sensitive": {
	}
   }
 ],										
 "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"
   }
 ]
}			

{
 "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"
  }
 ]
}			

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

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

{ 
  "inputConnections":[
    {
     "hostname":"mysql.example.lan",
     "port":1234,
     "username": "jsmith",				
     "password": "passw0rd"
  }
], 
  "extensions":[
    {
     "extensionName":"rSupport",
     "credentials":{
     "password":"pwd",
    }
  },
   {
	"extensionName" : "pythonSupport",
	"credentials": {
	"password": "pwd"
	}
   } 
  ]
}

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

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

• 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

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

増分更新を有効にしてフローを実行

Tableau Prep Builder バージョン 2020.2.1 以降、およびバージョン 2020.4 以降の Web でサポートされています。フロー出力を Microsoft Excel に書き込む場合、増分更新は現在サポートされていません。

サーバーで 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 を含めます。

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	

構文例

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

• Tableau Prep Builder バージョン: 2022.1.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 2022.1.1\scripts"\tableau-prep-cli.bat -t "\C:\Users\jsmith\Documents\My Tableau Prep Builder Repository\Flows\Flow1.tfl"

Mac

/Applications/Tableau\ Prep\ Builder\ 2022.1.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 2022.1.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\ 2022.1.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 2022.1.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\ 2022.1.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 2022.1.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\ 2022.1.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