Business Analyst レポート テンプレートのインポート (Import Business Analyst Report Template) (Business Analyst)

Business Analyst ライセンスで利用できます。

サマリー

ローカルにインストールされた ArcGIS Business Analyst データセットを使用してローカルで実行できるようにオンライン レポートをインポートします。

このツールは、[カタログ] ウィンドウから対話型のテンプレートのインポート ワークフローを実行するためのベースとなるエンジンです。 このツールは、Python スクリプトを介したテンプレートのインポートやプログラムによるデータ パスの変更といった、より高度な自動化タスクを実行する場合に適しています。

テンプレートのインポート ワークフローでは、このツールをバックグラウンドで実行して、その情報をジオプロセシング履歴に追加します。

使用法

  • レポート テンプレート ID はポータル アイテム ID になります。

  • すべての Business Analyst レポートには、英数字の一意のレポート テンプレート ID が含まれます。 レポート テンプレート ID を見つけるには、[カタログ] ウィンドウの [ポータル] タブをクリックして、[マイ コンテンツ] ボタンをクリックします。 レポート テンプレート フォルダーで、レポート テンプレートの上にポインターを置きます。 レポート テンプレート ID が [名前] の値としてリストされます。 [パス] の URL はレポート テンプレート ID を含んでおり、ポータルまたは ArcGIS Online のアイテム ページに接続します。

  • 出力フォルダーには、ローカルでレポートを実行するために必要なすべてのリソースが含まれます。

  • [データセット ID] パラメーターはローカル Esri データセットの ID を参照します。

  • [構成] パラメーターは、ローカルに保存されるか、参照される関連の Statistical Data Collection (SDCX) を定義するオプション パラメーターです。

  • [構成] パラメーターが指定されない場合、ツールはデフォルトのダウンロード オプションを使用します。 ダウンロード オプションを設定するには、[プロジェクト] > [オプション] > [Business Analyst] > [レポート テンプレートのインポート オプションの設定] の順にクリックします。

パラメーター

ラベル説明データ タイプ
オンライン レポート テンプレート ID

レポート テンプレート ID。

String
出力フォルダー
(オプション)

レポート テンプレート アイテムがインポートされるローカル フォルダー。

Folder
データセット ID
(オプション)

レポート変数の設定に使用されるデータセット。

String
構成
(オプション)

レポートの SDCX マップ レポート変数が保存される場所を指定する JSON 文字列。 次のような構成オプションがあります。

  • [ID] - SDCX のポータル アイテム ID。
  • [ダウンロード] - true または false。 SDCX をダウンロードする場合は true に、既存の SDCX を参照する場合は false に設定します。
  • [パス] - SDCX の場所。 空の文字列を使用して、レポート出力フォルダーの場所など、既存のデフォルトを使用するか、新しいフォルダーの場所、または SDCX を含む既存のフォルダーを指定します。
  • [名前] - SDCX の名前。 SDCX の新しい名前または既存の SDCX の名前を指定します。

String

派生した出力

ラベル説明データ タイプ
更新されたフォルダー

更新されたフォルダー。

Folder

arcpy.ba.ImportBusinessAnalystReportTemplate(online_report_template_id, {output_folder}, {dataset_id}, {config})
名前説明データ タイプ
online_report_template_id

レポート テンプレート ID。

String
output_folder
(オプション)

レポート テンプレート アイテムがインポートされるローカル フォルダー。

Folder
dataset_id
(オプション)

レポート変数の設定に使用されるデータセット。

String
config
(オプション)

レポートの SDCX 変数が保存される場所を指定する JSON 文字列。 次のような構成オプションがあります。

  • id - SDCX のポータル アイテム ID。
  • download - true または false。 SDCX をダウンロードする場合は true に、既存の SDCX を参照する場合は false に設定します。
  • path - SDCX の場所。 空の文字列を使用して、レポート出力フォルダーの場所など、既存のデフォルトを使用するか、新しいフォルダーの場所、または SDCX を含む既存のフォルダーを指定します。
  • name - SDCX の名前。 SDCX の新しい名前または既存の SDCX の名前を指定します。

String

派生した出力

名前説明データ タイプ
updated_folder

更新されたフォルダー。

Folder

コードのサンプル

ImportBusinessAnalystReportTemplate の例 (Python ウィンドウ)

次の Python ウィンドウ スクリプトは、ImportBusinessAnalystReportTemplate 関数の使用方法を示しています。

import arcpy
arcpy.ba.ImportBusinessAnalystReportTemplate(
    online_report_template_id="33bcaa1e97fc4b9ba7fc68e14402a10f",
    output_folder=r"C:\ArcGIS\Business Analyst Templates",
    dataset_id="USA_ESRI_2022",
    config='{"downloadConfig":[{"id":"023871b31068415cbc0340fdd3ec5ba7","download":true,"path":"","name":"San Francisco Spending"}]}')

ライセンス情報

  • Basic: 次のものが必要 Business Analyst
  • Standard: 次のものが必要 Business Analyst
  • Advanced: 次のものが必要 Business Analyst

関連トピック