レポート テンプレート情報の取得 (Get Report Templates Info) (サーバー)

サマリー

レポート ファイルとレポート テンプレートの内容を JSON 形式で返します。 レポート ファイル (.rptx) とレポート テンプレート (.rptt) はレポート定義の保存に使用されます。

使用法

  • このツールは、印刷サービス内のジオプロセシング タスクとして公開されるようになっています。

  • このツールの出力は、JSON で書式設定された文字列です。 この文字列は、次の情報を含む使用可能なレポート テンプレートとレポート ファイルのリストです。

    • レポート セクション情報
      • レポート名
      • レポート データ ソース
    • 関連レポート セクション情報
      • リレーションシップ ID
      • 関連レポート データ ソース
    • グループ化
    • フィールド値
    • フィールド名
    • 統計

    JSON の出力例:

    [{
        "reportTemplate": "Attribute List Group Letter Landscape",   // name of the template
        "reportOptions": {
          "Report Section": {
            "name": "My Report",                                     // name of the report section
            "sourceId": "my_source",                                 // report section data source
            "groupSections": {                                       // field(s) used for grouping
              "Group Header: [group-field-value]": "Subdivision"
            },
            "fieldElements": {                                       // field(s) used for dynamic field values
              "Field 1": "APN10",
              "Field 2": "Address",
            },
            "fieldLabelElements": {
              "Field Label 1": "Parcel",
              "Field Label 2": "Street Address"
            },
            "statisticElements": {                                   // field(s) used for statistics
              "Count Statistic Field 1": "APN10",
            } } 
        }
      },
        {
          "reportTemplate": "Custom_AttrList_RelatedReport_Port",
          "reportOptions": {
            "Report Section": {
              "name": "States Report",
              "sourceId": "us-states",
              "fieldElements": {
                "Field 1": "Name",
                "Field 2": "Population",
                "Field 3": "Region"
              },
              "fieldLabelElements": {
                "Field Label 1": "State Name",
                "Field Label 2": "Current Population",
                "Field Label 3": "Region"
              },
              "statisticElements": {
                "Count Statistic Field 1": "Name"
              }
            },
            "Related Report Section": {
              "relatedId": "R1L1statesL0cities",                     //related report Id
              "sourceId": "us-cities",                               //related report data source
              "fieldElements": {
                "Related Field 1": "SqMi_Area",
                "Related Field 2": "Population"
              },
              "fieldLabelElements": {
                "Related Field Label 1": "Area",
                "Related Field Label 2": "Population"
              } } 
    } 
    }]
  • 関連する [Web マップのエクスポート (Export Web Map)] ツールのフォルダーの場所と同じ場所を使用します。

  • 詳細については、ArcGIS Enterprise ヘルプの「Web アプリケーションでの印刷」をご参照ください。

パラメーター

ラベル説明データ タイプ
レポート テンプレート フォルダー
(オプション)

レポート テンプレートとして使用するレポート ファイル (.rptx または .rptt) が格納されているフォルダーの絶対パス。 デフォルトの場所は、<install_directory>\Resources\ArcToolBox\Templates\ExportWebMapTemplates です。

Folder
レポート アイテム ID
(オプション)

テンプレートに使用されるレポート アイテムのポータル ID (JSON 形式)。 形式 {"id": "<portal-id>"} を使用します。

String

派生した出力

ラベル説明データ タイプ
JSON 文字列

JSON 形式の文字列。 この文字列は、その他の情報を含む使用可能なレポート テンプレート (.rptt) とレポート ファイル (.rptx) のリストです。

String

arcpy.server.GetReportTemplatesInfo({Report_Templates_Folder}, {Report_Item_ID})
名前説明データ タイプ
Report_Templates_Folder
(オプション)

レポート テンプレートとして使用するレポート ファイル (.rptx または .rptt) が格納されているフォルダーの絶対パス。 デフォルトの場所は、<install_directory>\Resources\ArcToolBox\Templates\ExportWebMapTemplates です。

Folder
Report_Item_ID
(オプション)

テンプレートに使用されるレポート アイテムのポータル ID (JSON 形式)。 形式 {"id": "<portal-id>"} を使用します。

String

派生した出力

名前説明データ タイプ
Output_JSON

JSON 形式の文字列。 この文字列は、その他の情報を含む使用可能なレポート テンプレート (.rptt) とレポート ファイル (.rptx) のリストです。

String

コードのサンプル

GetReportTemplatesInfo の例 (Python ウィンドウ)

次のスクリプトは、各レポートについて、メタデータの一覧を返します。

import arcpy
arcpy.server.GetReportTemplatesInfo(r'C:\Data\MyReports')

環境

このツールは、ジオプロセシング環境を使用しません。

ライセンス情報

  • Basic: Yes
  • Standard: Yes
  • Advanced: Yes

関連トピック