Importer un modèle de rapport Business Analyst (Business Analyst)

Disponible avec une licence Business Analyst.

Synthèse

Importe un rapport en ligne pour que celui-ci puisse être exécuté localement avec un jeu de données ArcGIS Business Analyst installé localement.

Cet outil est le moteur sous-jacent qui exécute le processus interactif Importer un modèle à partir de la fenêtre Catalogue. Cet outil convient parfaitement pour effectuer des tâches automatisées plus avancées, telles que l’importation de modèles via des scripts Python ou la modification par programmation des chemins de données.

Le processus Importer un modèle exécute l’outil en arrière-plan et ajoute ses informations à l’historique de géotraitement.

Utilisation

  • L’ID du modèle de rapport sera l’ID de l’élément du portail.

  • Tous les rapports Business Analyst contiennent un ID de modèle de rapport alphanumérique unique. Pour localiser un ID de modèle de rapport, dans la fenêtre Catalogue, cliquez sur l’onglet Portail, puis sur le bouton Mon contenu. Dans le dossier Modèles de rapport, survolez un modèle de rapport. L’ID du modèle de rapport est répertorié en tant que valeur Nom. L’URL Chemin contient l’ID du modèle de rapport et établit une connexion à la page de l’élément sur votre portail ou sur ArcGIS Online.

  • Le dossier en sortie contiendra toutes les ressources requises pour exécuter le rapport localement.

  • Le paramètre ID du jeu de données se rapporte à l’ID du jeu de données Esri local.

  • Le paramètre Config est un paramètre facultatif qui définit la collection de données statistiques (Statistical Data Collection, SDCX) associée à stocker localement ou à référencer.

  • Si le paramètre Config n’est pas spécifié, l’outil utilise l’option de téléchargement par défaut. Pour définir les options de téléchargement, cliquez sur Projet > Options > Business Analyst > Définir les options d’importation des modèles de rapport.

Paramètres

ÉtiquetteExplicationType de données
ID du modèle de rapport en ligne

ID du modèle de rapport.

String
Dossier en sortie
(Facultatif)

Dossier local dans lequel les éléments du modèle de rapport sont importés.

Folder
ID du jeu de données
(Facultatif)

Jeu de données qui est utilisé pour renseigner les variables du rapport.

String
Config
(Facultatif)

Chaîne JSON spécifiant l’emplacement de stockage des variables de rapport cartographique SDCX du rapport. Les options du paramètre Config sont les suivantes :

  • ID : ID d’élément du portail de la collection de données statistiques.
  • Télécharger : vrai ou faux. Définissez ce paramètre sur vrai pour télécharger la collection de données statistiques ou sur faux pour référencer une collection de données statistiques existante.
  • Chemin : emplacement de la collection de données statistiques. Utilisez une chaîne vide pour utiliser la valeur par défaut existante (par exemple, l’emplacement du dossier en sortie du rapport) ou spécifiez un nouvel emplacement de dossier ou un dossier existant contenant la collection de données statistiques.
  • Nom : nom de la collection de données statistiques. Spécifiez un nouveau nom pour la collection de données statistiques ou le nom d’une collection de données statistiques existante.

String

Sortie obtenue

ÉtiquetteExplicationType de données
Dossier mis à jour

Dossier mis à jour.

Folder

arcpy.ba.ImportBusinessAnalystReportTemplate(online_report_template_id, {output_folder}, {dataset_id}, {config})
NomExplicationType de données
online_report_template_id

ID du modèle de rapport.

String
output_folder
(Facultatif)

Dossier local dans lequel les éléments du modèle de rapport sont importés.

Folder
dataset_id
(Facultatif)

Jeu de données qui est utilisé pour renseigner les variables du rapport.

String
config
(Facultatif)

Chaîne JSON spécifiant l’emplacement de stockage des variables SDCX du rapport. Les options du paramètre Config sont les suivantes :

  • id : ID d’élément du portail de la collection de données statistiques.
  • download : vrai ou faux. Définissez ce paramètre sur vrai pour télécharger la collection de données statistiques ou sur faux pour référencer une collection de données statistiques existante.
  • path : emplacement de la collection de données statistiques. Utilisez une chaîne vide pour utiliser la valeur par défaut existante (par exemple, l’emplacement du dossier en sortie du rapport) ou spécifiez un nouvel emplacement de dossier ou un dossier existant contenant la collection de données statistiques.
  • name : nom de la collection de données statistiques. Spécifiez un nouveau nom pour la collection de données statistiques ou le nom d’une collection de données statistiques existante.

String

Sortie obtenue

NomExplicationType de données
updated_folder

Dossier mis à jour.

Folder

Exemple de code

Exemple d’utilisation de la fonction ImportBusinessAnalystReportTemplate (fenêtre Python)

Le script suivant pour la fenêtre Python illustre l’utilisation de la fonction 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"}]}')

Informations de licence

  • Basic: Nécessite Business Analyst
  • Standard: Nécessite Business Analyst
  • Advanced: Nécessite Business Analyst

Rubriques connexes