ツールボックスをバージョンに保存 (Save Toolbox To Version) (データ管理)

サマリー

特定のバージョンの ArcGIS ソフトウェアで使用するためにツールボックスを解析して保存します。

この解析ツールは、インストール済みバージョンの ArcGIS Pro と指定したターゲット バージョン間のジオプロセシング ツールの互換性に関するさまざまな問題を確認します。 互換性の問題のリストについては、[ツールボックスのバージョンを解析 (Analyze Toolbox For Version)] ツールをご参照ください。このツールは同じ解析ツール ロジックを使用しています。

前のバージョンにツールボックスを保存する方法の詳細

このツールの解析ツールは、ModelBuilderPython ベースの両ツールで互換性に関する問題をレポートします (ツールのソースとして Python ファイルを使用するスクリプト ツールの場合のみ)。 実行されるアクションの違いは次のとおりです。

  • モデル ツール - 互換性に関する特定の種類の問題は、操作の一部として対処されます。
  • スクリプト ツール - ツールのソース ファイルは変更されません。

使用法

  • このツールは、結果が書き込まれる出力ツールボックスを作成します。 元のツールボックスは変更されません。 データ損失を回避するために、元のツールボックスを保持することをお勧めします。

  • 出力ツールボックス内のツールにより、元のツールボックスと一致しない結果が生じる場合があります。 一貫性を持たせるために出力ツールボックスのツールをテストします。

  • モデル内のいくつかの機能、とくにフィルター、ドメイン、選択リスト (値のドロップダウン リスト) に関連する機能は、出力ツールボックスから削除されます。 これを修正するには、関連ツールを追加してモデルのワークフローに再接続します。

  • スクリプト ツールの場合、ツールの Python ファイルへのパスは出力ツールボックスで変更されません。 元のツールボックスと出力ツールボックスのスクリプト ツールは同じファイルを使用します。 変更が必要な場合、.py ファイルのコピーを作成し、スクリプト ツールの 2 つの [スクリプト ファイル] プロパティのいずれかを 2 つ目の .py ファイルを指すように更新します。 これは、埋め込まれたスクリプト ファイルを使用するスクリプト ツールには適用されません。

  • 特定の互換性に関する問題はこのツールでは修正できません。 たとえば、ターゲット バージョンに存在しないデータ タイプによりエラーが発生します。 このエラーに対処するには、ツールボックスのコピーを作成し、問題があるデータを手動で削除して、そのツールボックスを入力として使用します。

パラメーター

ラベル説明データ タイプ
入力ツールボックス

解析および保存対象の入力ツールボックス (.tbx または .atbx ファイル)。 ファイルは変更されません。

Python ツールボックス形式 (.pyt ファイル) は入力としてはサポートされていません。

Toolbox
ターゲット バージョン

ツールボックスの互換性の問題解析に使用されるソフトウェア バージョンを指定します。

  • 10.6.0ArcGIS Desktop 10.6.0 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 10.7.0ArcGIS Desktop 10.7.0 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 10.8.0ArcGIS Desktop 10.8.0 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 10.8.2ArcGIS Desktop 10.8.2 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 2.2ArcGIS Pro 2.2 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 2.3ArcGIS Pro 2.3 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 2.4ArcGIS Pro 2.4 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 2.5ArcGIS Pro 2.5 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 2.6ArcGIS Pro 2.6 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 2.7ArcGIS Pro 2.7 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 2.8ArcGIS Pro 2.8 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 2.9ArcGIS Pro 2.9 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 3.0ArcGIS Pro 3.0 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
String
出力ツールボックス

指定された [ターゲット バージョン] パラメーター値の ArcGIS ソフトウェアで使用するために作成されるツールボックス。

Toolbox
ツールが使用できない場合のエラー
(オプション)

ツールがターゲット バージョンに存在しない場合に、エラーが生成されるかどうかを指定します。

  • オン - エラーが生成され、出力ツールボックスは作成されません。 これがデフォルトです。
  • オフ - 警告メッセージーが生成され、出力ツールボックスは作成されます。 モデル ツールの場合、問題があるツールがモデルから削除されるため、手動による編集が必要になります。
Boolean
必要なパラメーターが欠落している場合のエラー
(オプション)

パラメーターがターゲット バージョンに存在せず、そのパラメーターの値がデフォルト値以外である場合に、エラーが生成されるかどうかを指定します。

  • オン - エラーが生成され、出力ツールボックスは作成されません。 これがデフォルトです。
  • オフ - 警告メッセージーが生成され、モデルからパラメーターが削除され、出力ツールボックスが作成されます。
Boolean
パラメーター値が無効な場合のエラー
(オプション)

パラメーター値がターゲット バージョンのそのパラメーター フィルターに存在しない場合に、エラーが生成されるかどうかを指定します。

  • オン - エラーが生成され、出力ツールボックスは作成されません。 これがデフォルトです。
  • オフ - 警告メッセージーが生成され、出力ツールボックスは作成されます。 ドメインに含まれていない値または無効な値がある場合、出力ツールボックスはエラーを生成します。
Boolean

arcpy.management.SaveToolboxToVersion(in_toolbox, version, out_toolbox, {missing_tool}, {missing_param}, {invalid_param_value})
名前説明データ タイプ
in_toolbox

解析および保存対象の入力ツールボックス (.tbx または .atbx ファイル)。 ファイルは変更されません。

Python ツールボックス形式 (.pyt ファイル) は入力としてはサポートされていません。

Toolbox
version

ツールボックスの互換性の問題解析に使用されるソフトウェア バージョンを指定します。

  • 10.6.0ArcGIS Desktop 10.6.0 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 10.7.0ArcGIS Desktop 10.7.0 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 10.8.0ArcGIS Desktop 10.8.0 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 10.8.2ArcGIS Desktop 10.8.2 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 2.2ArcGIS Pro 2.2 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 2.3ArcGIS Pro 2.3 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 2.4ArcGIS Pro 2.4 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 2.5ArcGIS Pro 2.5 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 2.6ArcGIS Pro 2.6 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 2.7ArcGIS Pro 2.7 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 2.8ArcGIS Pro 2.8 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 2.9ArcGIS Pro 2.9 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
  • 3.0ArcGIS Pro 3.0 がツールボックスの互換性の問題解析に使用されます。 出力ツールボックスはこのバージョンに保存されます。
String
out_toolbox

指定された version パラメーター値の ArcGIS ソフトウェアで使用するために作成されるツールボックス。

Toolbox
missing_tool
(オプション)

ツールがターゲット バージョンに存在しない場合に、エラーが生成されるかどうかを指定します。

  • ERROR_ON_MISSING_TOOLエラーが生成され、出力ツールボックスは作成されません。 これがデフォルトです。
  • WARN_ON_MISSING_TOOL警告メッセージーが生成され、出力ツールボックスは作成されます。 モデル ツールの場合、問題があるツールがモデルから削除されるため、手動による編集が必要になります。
Boolean
missing_param
(オプション)

パラメーターがターゲット バージョンに存在せず、そのパラメーターの値がデフォルト値以外である場合に、エラーが生成されるかどうかを指定します。

  • ERROR_ON_MISSING_REQUIRED_PARAMエラーが生成され、出力ツールボックスは作成されません。 これがデフォルトです。
  • WARN_ON_MISSING_REQUIRED_PARAM警告メッセージーが生成され、モデルからパラメーターが削除され、出力ツールボックスが作成されます。
Boolean
invalid_param_value
(オプション)

パラメーター値がターゲット バージョンのそのパラメーター フィルターに存在しない場合に、エラーが生成されるかどうかを指定します。

  • ERROR_ON_INVALID_PARAM_VALUEエラーが生成され、出力ツールボックスは作成されません。 これがデフォルトです。
  • WARN_ON_INVALID_PARAM_VALUE警告メッセージーが生成され、出力ツールボックスは作成されます。 ドメインに含まれていない値または無効な値がある場合、出力ツールボックスはエラーを生成します。
Boolean

コードのサンプル

SaveToolboxToVersion の例 1 (Python ウィンドウ)

次の Python ウィンドウ スクリプトは、イミディエイト モードで SaveToolboxToVersion 関数を使用する方法を示しています。

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

環境

このツールは、ジオプロセシング環境を使用しません。

ライセンス情報

  • Basic: Yes
  • Standard: Yes
  • Advanced: Yes

関連トピック