スクリプトツールの作成

1 つのスクリプトツールが、1 つのスクリプトまたは実行可能なファイルタイプを実行するジオプロセシングツールになります。スクリプトツールは、ジオプロセシングツールをスクリプトへのインターフェイスとして使用し、これらのスクリプトを実行します。スクリプトツールを作成するときは、スクリプトの実行に必要なパラメーターを指定します。最も一般的なパラメーターとして、入力および出力データセット、フィールド名、選択リストから選択する文字列があります。スクリプトツールが実行されると、パラメーター値がスクリプトに渡され、スクリプトによって使用されます。

多くのスクリプトツールが ArcPy を使用する Python スクリプト (.py) を実行します。ArcPy は ArcGIS に付属してインストールされる Python サイトパッケージです。 ArcPy は、ジオプロセシングツールへのアクセスだけでなく、単純または複雑なワークフローを作成するための追加機能、クラス、モジュールへのアクセスも提供します。 ArcPy を使用すると、スクリプトから ArcGIS のジオプロセシング環境にアクセスできます。これにより、リアルタイム投影、選択セットのサポート、入力の検証、エラーメッセージ、履歴の記録などの利点が得られます。

スクリプトツールは、arcgisbinding R ライブラリーを使用する R スクリプト (.r) を実行することもできます。

R-ArcGIS Bridge の詳細

スクリプトツールはツールボックスで作成されます。スクリプトツールを作成するには、カタログ ウィンドウ内のツールボックスを右クリックして、新規作成 > スクリプトの順に選択します。

プロパティ

スクリプトツールを作成すると、新しく作成したスクリプトツールのプロパティダイアログボックスが開き、以下のサイドタブが表示されます。

一般
パラメーター
実行
検証
環境

一般タブ

一般タブには、次のプロパティがあります:

名前 - ツールを識別する、内部的な一意の名前。ツール名は文字 (a ～ z、A ～ Z) で始まる必要があり、文字および数字 (0 ～ 9) のみで構成する必要があります。スペースや特殊文字 (_、!、@、#、$、%、- など) は使用できません。
ラベル - ツールの名前で、ツールボックスに表示されるほか、ツールダイアログボックスでツールが開いているときにも表示されます。
説明 - ツールにポインターを合わせると表示される、ツールに関する簡単な説明。
サマリー - 開いているツールダイアログボックス上のヘルプアイコンにマウスポインターを合わせると表示される、ツールの説明。
図 - 開いているツールダイアログボックス上のヘルプアイコンにマウスポインターを合わせたときに、ツールのサマリーと共に表示される画像。
属性
- ツールが入力データを変更するバナーを表示 - このオプションをオンにすると、ツールダイアログボックスの上端にバナーが表示され、そのツールが入力データを変更することが示されます。
- ツールの出力をマップに追加しません - このオプションをオンにすると、ツールの出力データセットが開いているマップに自動的に追加されます。
  
  注意:
  
  出力データセットを開いているマップに追加するジオプロセシングオプションもオンになっているなら、ツールプロパティの属性が優先されます。
- 元に戻すの有効化切り替えボタンを表示 - このオプションをオンにすると、ツールダイアログボックスで実行ボタンの横に元に戻すの有効化切り替えボタンが表示されます。
- ツールが ArcGIS クレジットを消費するバナーを表示 - このオプションをオンにすると、ツールがクレジットを消費するなら、ツールダイアログボックスの上端にバナーが表示されます。
アイコン - ツールがリボン、クイックアクセスツールバー、または解析ツールギャラリーに追加されるときに表示される小さい画像。

プロパティを変更するには、テキストボックスに値を入力するか、アイコンをクリックし、図またはアイコンとして使用する新しい画像ファイルを参照します。

注意:

ツールボックスがレガシーツールボックス (.tbx) の場合は、ツールボックスファイルからツールのソーススクリプトへの相対パスが格納されるプロパティもあります。ツールボックスが ArcGIS ツールボックス (.atbx) の場合、この動作は別の方法で管理されます。スクリプトが .atbx ファイルと同じディレクトリーにある場合や、.atbx の格納場所の子フォルダーにある場合は、相対パスが保持されます。スクリプトと .atbx ファイルが完全に分かれている場合は、絶対パスが保持されます。

注意:

ツールボックスがレガシーツールボックス (.tbx) の場合、サマリー、図、アイコン、属性プロパティはサポートされません。

パラメータータブ

パラメーター タブには、パラメーターのプロパティのテーブルが示され、1 行に 1 つのパラメーターが表示されます。デフォルトでは、テーブルは空になります。パラメーターごとに複数のプロパティを定義します。たとえば、ジオプロセシング ウィンドウに表示されるラベル、パラメーターが受け入れるデータのタイプ、パラメーターがオプションであるか必須であるかなどを定義します。最低でも、パラメーターの ラベル、名前、データタイプ、タイプ、方向プロパティを設定します。


プロパティ	説明
ラベル	ツール上に表示されるパラメーターの名前。
名前	スクリプトツールが別の Python スクリプトから関数として呼び出されるときのパラメーターの名前。パラメーター名は文字 (a ～ z、A ～ Z) で始まる必要があり、文字と数字 (0 ～ 9) のみで構成する必要があります。スペースや特殊文字 (_、!、@、#、$、%、- など) は使用できません。
データタイプ	パラメーターが受け入れるデータのタイプを指定します。これによって、ツールで使用されるコントロールが決定します。たとえば、フィーチャレイヤーを選択すると、アクティブなマップからレイヤーを選択したり、フィーチャクラスを参照したりできます。
タイプ	パラメーターには、必須とオプションがあります。必須のパラメーターには必ず値を指定する必要があります。指定しないとツールは実行できません。オプションのパラメーターには値を指定しなくても、ツールは実行できます。
方向	パラメーターには、入力と出力があります。入力パラメーターは、処理対象の既存のデータまたは処理で使用される値を表します。出力パラメーターは、ツールが作成したデータまたは計算された値を表します。
説明	各ツールパラメーターについての文書ヘルプで、説明、情報、および受け入れられるデータタイプと値が含まれます。パラメーターのラベルの横にある情報ボタンの上にポインターを置くと、ツールダイアログボックスにパラメーターの説明が表示されます。
カテゴリー	カテゴリーの名前を入力すると、ツールのダイアログボックスにドロップダウングループのパラメーターが配置されます。
フィルター	フィルターを適用して、特定タイプのデータセット、ファイル、またはフィールド、特定の値、ツールへの入力値として使用できる範囲内の値を制限することができます。たとえば、ポイントフィーチャクラスのみを受け入れるようにフィーチャクラスのパラメーターをフィルターしたり、1 ～ 10 までの数字のみを受け入れるように数字のパラメーターをフィルターしたりできます。
依存関係	パラメーターを別のパラメーターに依存させることができます。たとえば、フィールドパラメーターをデータセットパラメーターに依存させます。この依存関係を設定すると、依存するデータセットからフィールドを選択できるようになります。
デフォルト	ツールのダイアログボックスが表示されるとき、パラメーターに自動的に設定される値。
環境	パラメーターは、ジオプロセシング環境からデフォルト値を取得できます。特定のジオプロセシング環境が設定されると、ツールのダイアログボックスが表示されるとき、指定のパラメーターのデフォルトとしてその値が使用されます。
シンボル	パラメーターのシンボルを定義するレイヤーファイルのパス。たとえば、出力データセットが作成されマップに追加されるときに、出力データセットのパラメーターのレイヤーファイルのシンボルを同じにすることができます。

実行タブ

実行タブには、スクリプトツールのソースコードに関連するプロパティや、Python または R スクリプトファイルへのパスが含まれています。このタブには、スクリプトツールのソースコードを埋め込んでパスワード保護するオプションや、ソースコードを新しいファイルにエクスポートするオプションも含まれています。

ソースコードをツールボックスに埋め込むか、外部のスクリプトファイルにリンクすることができます。ソースコードの場所に関係なく、このタブには、コードの変更に使用できるコードエディターが含まれています。または、スクリプトエディターで開く ボタンをクリックし、スクリプトエディターでコードを開きます。優先するスクリプトエディターは、ジオプロセシングオプションで指定できます。

検証タブ

検証タブには、スクリプトツールの検証コードが表示されます。検証では、ツールのパラメーターが、スクリプトツールの値や他のパラメーターに応答し、相互に連携するかをカスタマイズできます。検証コードは Python で記述されます。

ToolValidator Python コードブロックによって、スクリプトツールの外観、動作、メッセージを制御できます。コードエディターから検証コードを直接編集するか、スクリプトエディターで開く ボタンをクリックして、ジオプロセシングオプションダイアログボックスで設定できる優先スクリプトエディターで検証コードを開きます。

環境タブ

[環境] タブには、サポートされている環] および サポートされていない環境 という 2 つのリストが表示されます。これらのリスト間で、環境を追加または削除することができます。 サポートされている環境 リスト内の環境のみが、スクリプトツールのダイアログボックスの環境タブに表示されます。

スクリプト ツールの作成