Enregistrer une boîte à outils dans la version (Gestion des données)

Synthèse

Analyse et enregistre une boîte à outils à utiliser avec une version spécifique du logiciel ArcGIS.

Les analyseurs recherchent une variété de problèmes de compatibilité avec les outils de géotraitement entre la version installée de ArcGIS Pro et une version cible spécifiée. Pour une liste des problèmes de compatibilité, reportez-vous à l'outil Analyser la boîte à outils pour la version car il utilise la même logique d'analyseur.

En savoir plus sur l'enregistrement d'une boîte à outils dans une version précédente

Les analyseurs de l'outil signalent les problèmes de compatibilité avec les outils basés sur ModelBuilder et Python (uniquement pour les outils de script dont la source est un fichier Python). Les actions effectuées se distinguent comme suit :

  • Outil de modèle : certains types de problèmes de compatibilité sont résolus dans le cadre de l'opération.
  • Outil de script : aucune modification apportée au fichier source de l'outil.

Utilisation

  • Cet outil crée une boîte à outils en sortie dans laquelle le résultat est écrit. La boîte à outils d'origine n'est pas modifiée. Il est conseillé de conserver la boîte à outils d'origine pour éviter toute perte de données.

  • Les outils de la boîte à outils en sortie risquent de générer des résultats incohérents avec la boîte à outils d'origine. Vérifiez la cohérence des outils de la boîte à outils en sortie.

  • Certaines fonctionnalités des modèles, en particulier celles liées aux filtres, domaines et listes d'options (listes déroulantes de valeurs), sont supprimées de la boîte à outils en sortie. Pour corriger cela, ajoutez, puis reconnectez les outils appropriés au processus du modèle.

  • Pour les outils de script, le chemin d'accès au fichier Python de l'outil n'est pas modifié dans la boîte à outils en sortie. Les outils de script dans la boîte à outils d'origine et celle en sortie utilisent le même fichier. Si des modifications sont requises, créez une copie du fichier .py et mettez à jour l'une des deux propriétés Fichier de script de l'outil de script pour qu'elle pointe sur le deuxième fichier .py. Cela ne s'applique pas aux outils de script avec un fichier de script imbriqué.

  • Certains problèmes de compatibilité ne peuvent pas être réparés par cet outil. Par exemple, les types de données non présents dans la version cible génèrent une erreur. Pour résoudre ce problème, créez une copie de la boîte à outils, supprimez manuellement les données problématiques et utilisez cette boîte à outils en entrée.

Paramètres

ÉtiquetteExplicationType de données
Boîte à outils en entrée

Boîte à outils en entrée (.tbx ou .atbx) à analyser et enregistrer. Le fichier n'est pas modifié.

Le format de boîte à outils Python (.pyt) n'est pas pris en charge comme entrée.

Toolbox
Version cible

Spécifie la version de logiciel à utiliser pour l'analyse des problèmes de compatibilité de la boîte à outils.

  • 10.6.0ArcGIS Desktop 10.6.0 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
  • 10.7.0ArcGIS Desktop 10.7.0 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
  • 10.8.0ArcGIS Desktop 10.8.0 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
  • 10.8.2ArcGIS Desktop 10.8.2 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
  • 2.2ArcGIS Pro 2.2 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
  • 2.3ArcGIS Pro 2.3 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
  • 2.4ArcGIS Pro 2.4 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
  • 2.5ArcGIS Pro 2.5 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
  • 2.6ArcGIS Pro 2.6 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
  • 2.7ArcGIS Pro 2.7 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
  • 2.8ArcGIS Pro 2.8 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
  • 2.9ArcGIS Pro 2.9 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
String
Boîte à outils en sortie

Boîte à outils créée pour être utilisée avec le logiciel ArcGIS dont la valeur du paramètre Version cible est spécifiée.

Toolbox
Erreur sur l’outil manquant
(Facultatif)

Indique si l'opération génère une erreur lorsqu'elle rencontre un outil non présent dans la version cible.

  • Activé : si un outil non présent dans la version cible est rencontré, l'opération génère une erreur et la boîte à outils en sortie n'est pas créée. Il s’agit de l’option par défaut.
  • Désactivé : si un outil non présent dans la version cible est rencontré, l'opération génère un message d'avertissement et crée la boîte à outils en sortie. Pour les outils de modèle, l'outil problématique est supprimé du modèle, ce qui requiert une modification manuelle.
Boolean
Erreur sur le paramètre requis manquant
(Facultatif)

Indique si l'opération génère une erreur lorsqu'elle rencontre un paramètre non présent dans la version cible et que ce paramètre possède une valeur autre que la valeur par défaut.

  • Activé : si un paramètre non présent dans la version cible est rencontré et que ce paramètre possède une valeur autre que la valeur par défaut, l'opération génère une erreur et la boîte à outils en sortie n'est pas créée. Il s’agit de l’option par défaut.
  • Désactivé : si un paramètre non présent dans la version cible est rencontré et que ce paramètre possède une valeur autre que la valeur par défaut, l'opération supprime ce paramètre du modèle et la boîte à outils en sortie est créée.
Boolean
Erreur sur la valeur de paramètre non valide
(Facultatif)

Indique si l'opération génère une erreur lorsqu'elle rencontre une valeur de paramètre non présente dans son filtre de paramètres, dans la version cible.

  • Activé : si une valeur de paramètre non présente dans son filtre de paramètres, dans la version cible, est rencontrée, l'opération génère une erreur et la boîte à outils en sortie n'est pas créée. Il s’agit de l’option par défaut.
  • Désativé : si une valeur de paramètre non présente dans son filtre de paramètres, dans la version cible, est rencontrée, l'opération se poursuit avec des avertissements et la boîte à outils en sortie est créée. La boîte à outils en sortie génère une erreur si elle possède une valeur qui ne se trouve pas dans le domaine ou n'est pas valide.
Boolean

arcpy.management.SaveToolboxToVersion(in_toolbox, version, out_toolbox, {missing_tool}, {missing_param}, {invalid_param_value})
NomExplicationType de données
in_toolbox

Boîte à outils en entrée (.tbx ou .atbx) à analyser et enregistrer. Le fichier n'est pas modifié.

Le format de boîte à outils Python (.pyt) n'est pas pris en charge comme entrée.

Toolbox
version

Spécifie la version de logiciel à utiliser pour l'analyse des problèmes de compatibilité de la boîte à outils.

  • 10.6.0ArcGIS Desktop 10.6.0 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
  • 10.7.0ArcGIS Desktop 10.7.0 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
  • 10.8.0ArcGIS Desktop 10.8.0 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
  • 10.8.2ArcGIS Desktop 10.8.2 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
  • 2.2ArcGIS Pro 2.2 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
  • 2.3ArcGIS Pro 2.3 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
  • 2.4ArcGIS Pro 2.4 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
  • 2.5ArcGIS Pro 2.5 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
  • 2.6ArcGIS Pro 2.6 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
  • 2.7ArcGIS Pro 2.7 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
  • 2.8ArcGIS Pro 2.8 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
  • 2.9ArcGIS Pro 2.9 est utilisé pour l'analyse des problèmes de compatibilité de la boîte à outils. La boîte à outils en sortie est enregistrée dans cette version.
String
out_toolbox

Boîte à outils créée pour être utilisée avec le logiciel ArcGIS dont la valeur du paramètre version est spécifiée.

Toolbox
missing_tool
(Facultatif)

Indique si l'opération génère une erreur lorsqu'elle rencontre un outil non présent dans la version cible.

  • ERROR_ON_MISSING_TOOLSi un outil non présent dans la version cible est rencontré, l'opération génère une erreur et la boîte à outils en sortie n'est pas créée. Il s’agit de l’option par défaut.
  • WARN_ON_MISSING_TOOLSi un outil non présent dans la version cible est rencontré, l'opération génère un message d'avertissement et crée la boîte à outils en sortie. Pour les outils de modèle, l'outil problématique est supprimé du modèle, ce qui requiert une modification manuelle.
Boolean
missing_param
(Facultatif)

Indique si l'opération génère une erreur lorsqu'elle rencontre un paramètre non présent dans la version cible et que ce paramètre possède une valeur autre que la valeur par défaut.

  • ERROR_ON_MISSING_REQUIRED_PARAMSi un paramètre non présent dans la version cible est rencontré et que ce paramètre possède une valeur autre que la valeur par défaut, l'opération génère une erreur et la boîte à outils en sortie n'est pas créée. Il s’agit de l’option par défaut.
  • WARN_ON_MISSING_REQUIRED_PARAMSi un paramètre non présent dans la version cible est rencontré et que ce paramètre possède une valeur autre que la valeur par défaut, l'opération supprime ce paramètre du modèle et la boîte à outils en sortie est créée.
Boolean
invalid_param_value
(Facultatif)

Indique si l'opération génère une erreur lorsqu'elle rencontre une valeur de paramètre non présente dans son filtre de paramètres, dans la version cible.

  • ERROR_ON_INVALID_PARAM_VALUESi une valeur de paramètre non présente dans son filtre de paramètres, dans la version cible, est rencontrée, l'opération génère une erreur et la boîte à outils en sortie n'est pas créée. Il s’agit de l’option par défaut.
  • WARN_ON_INVALID_PARAM_VALUESi une valeur de paramètre non présente dans son filtre de paramètres, dans la version cible, est rencontrée, l'opération se poursuit avec des avertissements et la boîte à outils en sortie est créée. La boîte à outils en sortie génère une erreur si une valeur ne se trouve pas dans le domaine ou qu'elle n'est pas valide.
Boolean

Exemple de code

Exemple 1 d'utilisation de l'outil SaveToolboxToVersion (fenêtre Python)

La fenêtre de script Python suivante illustre l’utilisation de la fonction SaveToolboxToVersion en mode immédiat.

import arcpy
arcpy.management.SaveToolboxToVersion(r"C:\toolboxes\MyTools.atbx", "2.7", "C:\toolboxes\MyTools_27.tbx")

Environnements

Cet outil n’utilise pas d’environnement de géotraitement.

Informations de licence

  • Basic: Oui
  • Standard: Oui
  • Advanced: Oui

Rubriques connexes