Tableau データ抽出コマンド ライン ユーティリティを使用すると、抽出更新タスクを自動化できます。これは Tableau Desktop に付属のコマンド ライン ユーティリティです。これを使用することで、パブリッシュされた抽出データ ソースを更新したり、データをファイルからデータ ソースに追加したりできます。

Tableau データ抽出コマンドライン ユーティリティの使用要件には、次のような条件が含まれています。

  • Windows に搭載されている Tableau Desktop で使用可能であり、Windows システムでのみ実行可能です。

  • Tableau Desktop のトライアル版では使用できません。

  • OAuth を使用しない抽出データ ソースに使用できます。

  • 単一接続データ ソースの更新にのみ使用できます。マルチ接続データ ソースには使用できません。

重要! Tableau データ抽出コマンド ライン ユーティリティは 2022 年 10 月に非推奨になり、多要素認証(新しいウィンドウでリンクが開く)が要件になります。Tableau Cloud が直接アクセスできないデータ ソースまたは仮想接続データを更新するには、Tableau Bridge を使用してください。詳細については、「Bridge 更新スケジュールの設定」(新しいウィンドウでリンクが開く)を参照してください。

スクリプトを使用して更新ジョブを開始するには、tabcmd (refreshextracts(新しいウィンドウでリンクが開く)) または REST API (抽出更新タスクの実行(新しいウィンドウでリンクが開く)) を使用します。

ユーティリティを実行する前に

抽出の更新が Tableau 10.4 以前で作成された抽出 (つまり、.tde 抽出) で実行されると、抽出は自動的に .hyper 抽出にアップグレードされます。.hyper 抽出にアップグレードする利点は多数ありますが、Tableau Desktop の以前のバージョンでは抽出を開けなくなります。

詳細については、.hyper 形式への抽出のアップグレードを参照してください。

ユーティリティの実行

  1. 管理者としてコマンド プロンプトを開き、Tableau Desktop の bin ディレクトリに変更します。例:

    cd C:\Program Files\Tableau\Tableau 2022.4\bin

  2. 以下の表で説明するパラメーターを追加して、次のいずれかのコマンドを使用します。

    • tableau refreshextract

    • tableau addfiletoextract

注: ユーティリティを実行する場合は、コマンド ラインまたはスクリプトで、tableau.exeではなく、必ず tableau を指定します。

注: トラブルシューティングを行うには、\My Tableau Repository\Logs フォルダー内にある tableaucom.txt ファイルでログを確認します。

: マルチサイト環境では、コマンドを適用するサイトを指定します。

tableau refreshextract コマンドの構文およびパラメーター

Tableau Server または Tableau Cloud の抽出を更新するには、tableau refreshextract を使用します。抽出を更新すると、前の更新以降、データ ソースに加えられた変更によって既存の抽出が更新されます。

このコマンドのヘルプを参照するには、Windows コマンド プロンプトで次のコマンドを入力します。

tableau help refreshextract

パラメーターの使用

  • すべてのオプションにはダブル ハイフンを使用する完全形式があります (--server など)。

  • また、シングル ハイフンを使用する短い形式を持つオプションもあります (-s など)。

  • オプションの値に空白が含まれる場合は、引用符で囲みます。

  • 更新されるソースは、.tde ではなく元のデータ ソースでなければなりません。

tableau refreshextract コマンド オプション

短い形式 完全形式 説明
  --source-username <user name>

データ ソース接続に対する有効なユーザー名。

このオプションは --source-password と共に使用するか、

--original-file をユーザー名およびパスワード オプションの代わりに使用します。

: データ ソースが埋め込み認証資格情報を使用してパブリッシュされた場合あっても、パブリッシュされた抽出を更新する時にユーザー名とパスワードを提供する必要があります。

  --source-password "<password>"

データ ソース ユーザーのパスワード。

 

--original-file <path and file name>

または

--original-file <path and folder name>

サーバー上でリフレッシュされるデータ ソースのパスおよびファイル名。例: --original-file c:\folder\file.csv

マルチファイル データ ソースを更新するには、データ ファイルを含むフォルダーへのパスを渡します。例: --original-file c:\folder

ファイルがネットワーク共有上にある場合は、パスに UNC 形式を使用します。\\server\path\filename.csv

  --force-full-refresh

データ ソースが増分更新されるよう設定されている場合、このオプションを使用して完全な抽出の更新を強制的に実行します。このオプションを含ませない場合は、増分更新が実行されます。増分更新をサポートしていないデータ ソースもあります。

-s <server http address> --server <URL>

データがパブリッシュされる Tableau Server の URL。

Tableau Cloud の場合、https://online.tableau.com と指定します。

-t <site id> --site <siteid>

複数サイト環境では、コマンドが適用されるサイトを指定します。Tableau Cloud では、ユーザー名が複数のサイトに関係している場合にこの引数を使用します。Tableau Server では、サイトを指定しない場合、既定サイトが使用されます。

サイト ID はサイト名とは無関係であり、ブラウザーでサイトを表示する際に URL に表示されます。たとえば、Tableau Cloud にサインインした後に表示されるページの URL が次の場合、

https://online.tableau.com/t/vernazza/views

サイト ID はvernazza です。

  --datasource <datasource>

Tableau Server または Tableau Cloud にパブリッシュされているデータ ソースの名前。

  --project <projectname>

データ ソースが属するプロジェクト。このオプションを含めない場合、既定のプロジェクトが使用されます。

指定するプロジェクトがプロジェクト階層内でネストされている子プロジェクトの場合、このパラメーターを --parent-project-path パラメーターとともに使用する必要があります。

  --parent-project-path path/to/project

データ ソースのパブリッシュ先のプロジェクトがプロジェクト階層の最上位レベルにない場合、このパラメーターを --project パラメーターとともに使用し、ネストされたプロジェクトのパスを指定します。

階層でプロジェクト レベルを区切るには、フォワード スラッシュ文字 (/) を使用します。プロジェクト名にフォワード スラッシュ文字またはバック スラッシュ文字が入るインスタンスを避けるには、バックスラッシュ (\) を使用します。

たとえば、最上位レベルのマーケティングで、プロジェクト Social、プロジェクト名が Sandbox の場合は次のとおりです。

--project Sandbox --parent-project-path Marketing/Social

-u <user name> --username <username>

Tableau Server または Tableau Cloud の有効なユーザー。

-p "<password>" --password "<password>"

Tableau Server または Tableau Cloud の特定のユーザーのパスワード。

  --proxy-username <username>

プロキシ サーバー用のユーザー名。

  --proxy-password "<password>"

プロキシ サーバーのパスワード。

-c "<path and file name>" --config-file "<path and file name>"

コマンドの構成オプションを含むファイルのパスとファイル名情報。パスは常に二重引用符で囲みます。詳細については、後述の構成ファイルの使用を参照してください。

tableau refreshextract コマンドの例

次のコマンドは、Tableau Cloud へパブリッシュされた CurrentYrOverYrStats という名前の抽出を更新します。このコマンドは次を指定します。

  • Tableau Cloud ユーザーおよびパスワード。
  • Tableau Cloud サイトおよびプロジェクト名。
  • ホストされているデータ ソースへサインインするためのデータ ソース、ユーザー名およびパスワード。この場合データ ソースは、クラウドベースのデータ ソース プロバイダー (たとえば、Salesforce.com など) によってホストされているデータ ソースです。

C:\Program Files\Tableau\Tableau 2022.4\bin>tableau refreshextract --server https://online.tableau.com --username email@domain.com --password "OurServerPwd" --site vernazza --project "New Animations" --datasource "CurrentYrOverYrStats" --source-username database_user@hosted_datasource_provider.com --source-password "db_password"

ファイルベースのデータ ソースの抽出を更新するには、抽出を作成した元のファイルへのパスを提供します。ファイルがネットワーク共有上にある場合は、マッピングされたドライブの代わりに UNC 形式を使用します。

C:\Program Files\Tableau\Tableau 2022.4\bin>tableau refreshextract --server https://online.tableau.com --username email@domain.com --password "OurServerPwd" --site vernazza --project "New Animations" --datasource "CurrentYrOverYrStats" --original-file "\\server\path\filename.csv"

tableau addfiletoextract の構文

Tableau Server または Tableau Cloud へパブリッシュされた抽出にファイルの内容を追加するには、tableau addfiletoextract を使用します。このコマンドを使用して 2 つのファイルを組み合わせます。

最後に行った変更が適用された既存の抽出の更新のみを行う場合は、代わりに refreshextract コマンドを使用します。既存の抽出を更新するために addfiletoextract を使用すると、代わりにデータが複製されます。

このコマンドのヘルプを参照するには、Windows コマンド プロンプトで次のコマンドを入力します。

tableau help addfiletoextract

すべてのオプションにはダブル ハイフンを使用する完全形式があります (--server など)。また、シングル ハイフンを使用する短い形式を持つオプションもあります (-s など)。オプションの値に空白が含まれる場合は、引用符で囲みます。

tableau addfiletoextract コマンド オプション

短い形式 完全形式 説明
  --file <path and file name>

追加するデータを含むデータ ファイルのパスとファイル名情報。このファイルは、Excel または Access 形式、Tableau データ抽出、または区切りテキスト ファイルの場合があります。ファイルをパスワードで保護することはできません。ファイルがネットワーク共有の場合は、UNC 形式を使用します。たとえば、\\server\path\filename.csv

-s <server http address> --server <URL>

データがパブリッシュされる Tableau Server の URL。

Tableau Cloud の場合、https://online.tableau.com と指定します。

-t <site id> --site <site id>

複数サイト環境では、コマンドが適用されるサイトを指定します。Tableau Cloud では、ユーザー名が複数のサイトに関係している場合、この引数を含める必要があります。Tableau Server では、サイトを指定しない場合、既定サイトが使用されます。

  --datasource <datasource>

Tableau Server または Tableau Cloud にパブリッシュされているデータ ソースの名前。

  --project <projectname>

データ ソースが属するプロジェクト。このオプションを含めない場合、既定のプロジェクトが使用されます。

指定するプロジェクトがプロジェクト階層内でネストされている子プロジェクトの場合、このパラメーターを --parent-project-path パラメーターとともに使用する必要があります。

  --parent-project-path path/to/project

データ ソースのパブリッシュ先のプロジェクトがプロジェクト階層の最上位レベルにない場合、このパラメーターを --project パラメーターとともに使用し、ネストされたプロジェクトのパスを指定します。

階層でプロジェクト レベルを区切るには、フォワード スラッシュ文字 (/) を使用します。プロジェクト名にフォワード スラッシュ文字またはバック スラッシュ文字が入るインスタンスを避けるには、バックスラッシュ (\) を使用します。

たとえば、最上位レベルのマーケティングで、プロジェクト Social、プロジェクト名が Sandbox の場合は次のとおりです。

--project Sandbox --parent-project-path Marketing/Social

-u <username> --username <username>

Tableau Server または Tableau Cloud の有効なユーザー。

-p "<password>" --password "<password>"

Tableau Server または Tableau Cloud の特定のユーザーのパスワード。

  --proxy-username <username>

プロキシ サーバー用のユーザー名。

  --proxy-password "<password>"

プロキシ サーバーのパスワード。

-c "<path and filename>" --config-file "<path and filename>"

コマンドの構成オプションを含むファイルのパスとファイル名情報。パスは常に二重引用符で囲みます。詳細については、後述の構成ファイルの使用を参照してください。

tableau addfiletoextract コマンドの例

C:\Program Files\Tableau\Tableau 2022.4\bin>tableau addfiletoextract --server https://online.tableau.com --username email@domain.com --password "OurServerPwd" --site vernazza --project "New Animations" --datasource "CurrentYrOverYrStats" --file "C:\Users\user2\Documents\DataUploadFiles\AprMay.csv"

構成ファイルの使用

tableau refreshextract または tableau addfiletoextract のいずれかで使用することができる config (構成) ファイルを作成するために、ノートパッドや Text Edit などのプレーン テキスト エディターを使用することができます。構成ファイルは、同じデータ ソースを長時間定期的に更新することが予想される場合に役立ちます。コマンドを実行するたびに同じオプションを入力する代わりに、構成ファイルを指定します。構成ファイルは、コマンド ラインにユーザー名とパスワードを表示しないという利点もあります。

構成ファイルの作成

たとえば、config.txt という名前のファイルを作成し、Documents フォルダーに保存したとします。そして、ファイル内で次に示すようなパラメーター情報を含ませました。

ホストされているデータ ソースからの抽出で、Tableau Cloud にパブリッシュされ、サーバーhttps://online.tableau.com の場合:

server=https://online.tableau.com
site=vernazza
username=email@domain.com
password=OurPassword
project=New Animations
datasource=CurrentYrOverYrStats
source-username=database_user@hosted_datasource_provider.com
source-password=db_password

コマンド ラインからの構成ファイルの参照

構成ファイルを作成後、tableau refreshextract または tableau addfiletoextract コマンドを実行します。この際、コマンド ラインで使用する唯一のオプションとして構成ファイルを指定し、構成ファイルのパスを二重引用符で囲みます。構文は、次のとおりです。

tableau refreshextract --config-file "<path>"

たとえば、構成ファイルの作成セクションのサンプル内で指定された抽出を更新するには、次のコマンドを実行します (Tableau Desktop のバージョンの bin ディレクトリで作業を行っていることを確認してください)。

C:\Program Files\Tableau\Tableau 2022.4\bin>tableau refreshextract --config-file "C:\Users\user1\Documents\config.txt"

構成ファイルの構文の違い

構成ファイル内でオプションを指定する構文は、コマンド ラインで使用する構文とは次のような点において異なります。

  • オプション名はダッシュやハイフンからは始まりません。
  • オプション名とオプション値を区切るには、等号 (スペースなし) を使用します。
  • スペースを含んでいる場合であっても(前に示したサンプル内の project オプションの場合など)、値の前後に引用符は必要ありません (または許可されていません)。

Windows タスク スケジューラを使用した抽出更新

Windows タスク スケジューラを Tableau データ抽出コマンド ライン ユーティリティと共に使用すると、企業のファイアウォール内のTableau Cloudデータ ソースを自動で定期的に更新することができます。タスクが 1 日、1 週、または 1 月に 1 回、あるいは特定のシステム イベント後に発生するよう設定することができます。たとえば、コンピューター起動時にタスクを実行します。

詳細については、Microsoft TechNet ライブラリの「タスク スケジューラの操作方法」(新しいウィンドウでリンクが開く)ページを参照してください。

ありがとうございます!