获取报表模板信息 (服务器)

摘要

用于以 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 地图工具的相同文件夹位置。

  • 有关更多信息,请参阅 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.management.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')

环境

此工具不使用任何地理处理环境。