获得 Business Analyst 许可后可用。
Imports an online report so that it can run locally using a locally installed ArcGIS Business Analyst dataset.
This tool is the underlying engine that runs the Import Template interactive workflow from the Catalog pane. This tool is ideal for performing more advanced automated tasks, such as importing templates through Python scripting or programmatically modifying data paths.
The Import Template workflow will run the tool in the background and add its information to the Geoprocessing history.
The report template ID will be the portal item ID.
All Business Analyst reports contain a unique alphanumeric report template ID. To locate a report template ID, in the Catalog window, click the Portal tab, and click the My Content button. In the Report Templates folder, hover over a report template. The report template ID is listed as the Name value. The Path URL contains the report template ID and connects to the item page in your portal or on ArcGIS Online.
The output folder will contain all of the resources required to run the report locally.
The Dataset ID parameter refers to the ID of the local Esri dataset.
The Config parameter is an optional parameter that defines the associated Statistical Data Collection (SDCX) that will be stored locally or referenced.
If the Config parameter is not specified, the tool will use the default download option. To set download options, click Project > Options > Business Analyst > Set options for importing report templates.
| 标注 | 说明 | 数据类型 |
Online Report Template ID
| The report template ID. | String |
Output Folder
(可选) | The local folder where the report template items will be imported. | Folder |
Dataset ID
(可选) | The dataset that will be used to populate the report variables. | String |
Config
(可选) | A JSON string specifying where the report's SDCX map report variables will be stored. The config options are as follows:
| String |
| 标注 | 说明 | 数据类型 |
| Updated Folder | The updated folder. | Folder |
arcpy.ba.ImportBusinessAnalystReportTemplate(online_report_template_id, {output_folder}, {dataset_id}, {config})| 名称 | 说明 | 数据类型 |
online_report_template_id | The report template ID. | String |
output_folder (可选) | The local folder where the report template items will be imported. | Folder |
dataset_id (可选) | The dataset that will be used to populate the report variables. | String |
config (可选) | A JSON string specifying where the report's SDCX variables will be stored. The config options are as follows:
| String |
| 名称 | 说明 | 数据类型 |
| updated_folder | The updated folder. | Folder |
The following Python window script demonstrates how to use the ImportBusinessAnalystReportTemplate function.
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"}]}')