| Label | Explanation | Data Type |
Input
| The input toolbox (.tbx or .atbx file) that will be analyzed. The Python toolbox format (.pyt file) is not supported as an input. | Toolbox |
Target Version | Specifies the software version that will be used for toolbox compatibility analysis.
| String |
Output File
(Optional) | The text file that will be created containing the compatibility issues identified by the analyzers. | File |
Summary
Analyzes the contents of a toolbox and identifies compatibility issues with previous versions of ArcGIS software.
The tool evaluates a toolbox (for both ModelBuilder and Python-based tools) and determines the ArcGIS AllSource geoprocessing tools it contains. Then tool then identifies compatibility issues between the version of the software being used and a specified target version. Compatibility issues are presented as warning messages and can optionally be written to a text file.
Usage
The input toolbox will not be modified. To update the toolbox, use the Save Toolbox To Version tool.
The tool's compatibility analyzers track the list of known compatibility issues for each geoprocessing tool to each target version.
Compatibility issues are only tracked for ArcGIS AllSource system toolboxes.
The tool's analyzers do not track compatibility of nongeoprocessing tool functions in ArcPy. Changes to nongeoprocessing functions (for example, changes to arcpy.da.SearchCursor) may cause compatibility issues.
The compatibility analyzer identifies and reports for the following compatibility issues:
- Geoprocessing tools from the system toolboxes that are not present at the target version. For example, the PDF To TIFF tool was not available in ArcGIS AllSource prior to version 2.9.
- The geoprocessing data type of a model variable or tool parameter is not present at the target version (models only). For example, the data type of Voxel Layer (GPVoxelLayer) is only supported since ArcGIS AllSource 2.6.
- Tool parameters that are not present at the target version. For example, the Template Tables parameter was added to the Add Fields (multiple) tool at ArcGIS AllSource 2.6.
- Modifications to certain properties of a tool parameter. Changes to the following parameter properties will produce compatibility warnings:
- Parameter type—A parameter can have a type of required, optional, or derived.
- Direction—A parameter can have a direction of input or output.
- Value—The parameter's default value.
- Multivalue—A parameter can support a single or multiple values.
- Data type—The data type of a parameter, for example, Feature Class (DEFeatureClass).
- Filter list—The options and filters limiting the values that are considered valid for a parameter.
- Filter type—The type of filter associated with the parameter. For example, a parameter can have no filter, a list of values, or a range of values (for example, 0 to 10). Typically, filter type changes are from having no filter to having a filter.
Note:
ArcGIS AllSource supports backward compatibility of geoprocessing tools. Models and scripts created with an earlier version of the software can be used by later versions of the software. For example, a model created at ArcGIS AllSource 2.9 can be used in ArcGIS AllSource 3.0. The purpose of the Analyze Toolbox For Version tool is to identify any compatibility issues that will cause problems when a toolbox is created (or edited) in a later version of the software (for example, ArcGIS AllSource 3.0) and is then used with an earlier version of the software (for example, ArcGIS AllSource 2.9).
Parameters
arcpy.management.AnalyzeToolboxForVersion(in_toolbox, version, {report})| Name | Explanation | Data Type |
in_toolbox | The input toolbox (.tbx or .atbx file) that will be analyzed. The Python toolbox format (.pyt file) is not supported as an input. | Toolbox |
version | Specifies the software version that will be used for toolbox compatibility analysis.
| String |
report (Optional) | The text file that will be created containing the compatibility issues identified by the analyzers. | File |
Code sample
The following Python window script demonstrates how to use the AnalyzeToolboxForVersion function in immediate mode.
import arcpy
arcpy.management.AnalyzeToolboxForVersion(r"C:\toolboxes\MyTools.atbx", "2.7")Environments
This tool does not use any geoprocessing environments.