[ArcGIS Pro ジオプロセシング ツールの実行] の追加および構成

[ArcGIS Pro ジオプロセシング ツールの実行] ステップは、構成済みのジオプロセシング ツール、Python スクリプト、または ArcGIS Pro の ModelBuilder モデルを実行します。

ステップが実行されると、ジョブ タイルに [起動中] アイコン が表示されます。 ツールが起動すると、[実行中] アイコン が表示され、ツールが実行されていることを示します。

ステップ パラメーターに ArcGIS Arcade 式が構成されている場合は、ツールの実行が開始される前に適切な値に変換されます。

[実行時に表示] オプションが有効になっている場合、ステップで構成されたツールが [ジオプロセシング] ウィンドウで開き、ツールが実行される前にパラメーター値を定義することができます。 デフォルトのパラメーター値が構成されている場合、ステップの実行時に表示され、オーバーライドすることができます。 [ユーザー プロンプト] 値と [ステップ ヘルプ] 値がステップに構成されていない場合、ステップの実行時に自動的に実行されます。

注意:

ArcGIS Arcade 式から取得したパラメーター値がツールと互換性がない場合、ステップは失敗します。

When the step is run, the following actions can be performed:

• [実行時に表示] オプションが有効になっている場合、[ジオプロセシング] ウィンドウの [実行] をクリックすることで、パラメーター値を入力し、ステップを実行することができます。
• [キャンセル] をクリックして、ステップをキャンセルできます。

  注意:

  このステップの実行を開始した後は、キャンセルできない場合もあります。

ステップの構成

To configure the step, do the following:

1. Create or edit a workflow diagram to access the Step Library panel.
2. [ArcGIS Pro ジオプロセシング ツールの実行] を [ステップのライブラリ] パネルからワークフロー キャンバス上のステップの接続矢印にドラッグします。

   Learn more about adding steps to a workflow diagram

   The Step Details panel appears.

3. Provide a name for the step in the Step Name text box.
4. Optionally, add the message you want to appear when the step is run in the User Prompt text box.

   You can also use the following example to display a dynamic value using ArcGIS Arcade expressions:

   'This job is currently assigned to ' + jobOwner($job) + '.'

5. [引数] セクションで実行するツールのタイプを選択します。
   • [システム ツールボックス] - ArcGIS Pro に付属しているジオプロセシング ツール、および ArcGIS Pro プロジェクトにインポートされたツールボックス
   • [その他のツールボックス] - カスタム ジオプロセシング ツールおよびスクリプト
6. 次のいずれかを実行します。

   システム ツールボックス内のツール	実行するツールを含むツールボックスのエイリアスを [ツールボックスのエイリアス] テキスト ボックスに入力します。 ツールボックスのエイリアスは、ArcGIS Pro ドキュメントにあるツールのヘルプ ページ上の Python タブにあります。
   ArcGIS Pro プロジェクトにインポートされているツール	実行するツールを含むツールボックスのエイリアスを [ツールボックスのエイリアス] テキスト ボックスに入力します。 [カタログ] ウィンドウでツールボックスを右クリックし、[プロパティ] をクリックして、ツールボックスのエイリアスを表示します。
   カスタム ジオプロセシング ツールおよびスクリプト	[ツールボックス パス] テキスト ボックスにツールボックスへの絶対パスを入力します。 ツールボックスへのパスは、ファイル ジオデータベースまたは エンタープライズ ジオデータベース に格納されているツールボックスを参照することもできます。 パスは ArcGIS Pro でアクセス可能になっている必要があります。

7. [ツール名] テキスト ボックスに、実行するツールの名前を入力します。

   ツール名は、ArcGIS Pro ドキュメントにあるツールのヘルプ ページ上の Python タブにあります。

8. 必要に応じて、[実行時に表示] チェックボックスをオンにし、ArcGIS Pro でステップが実行される際にパラメーター値を設定できるようにします。
9. [新しいパラメーターの追加] をクリックします。
10. [パラメーター名] テキスト ボックスに、パラメーターの名前を入力します。

    ツールのパラメーター名は、ArcGIS Pro ドキュメントにあるジオプロセシング ツールのヘルプ ページ上の Python タブにあります。

11. 必要に応じて、[デフォルト値の表示] ボタン をクリックし、ステップが実行される際のパラメーターのデフォルト値を定義します。
    1. 次のオプションの中から 1 つを選択します。
       • [値] - 静的な値を入力します。
       • [Arcade 式] - Arcade 式を使用して動的な値を入力します。
    2. [値] または [Arcade 式] テキスト ボックスで、プロパティのデフォルト値を入力します。
12. パラメーターをさらに追加するには、ステップ 9 ～ 11 を繰り返します。
13. 必要に応じて、ツールの実行が完了した際に出力値として使用する派生出力パラメーターの名前を入力します。

    ツールの派生出力パラメーターは、ArcGIS Pro ドキュメントにあるツールのヘルプ ページ上の Python タブにあります。

14. 必要に応じて、[ジオプロセシング ログの添付] チェックボックスをオンにし、ツールの履歴をジョブの添付ファイルとして保存します。
15. 必要に応じて、ログが格納されるフォルダーの名前を [フォルダー] テキスト ボックスに入力します。

    フォルダー名に特殊文字を含めることはできません。

    注意:

    フォルダー名が入力されていない場合、[General] という名前のフォルダーが自動的に作成されます。

16. Click the Options tab.
17. Configure Step Options as necessary.
    • Manual—Run the step manually.
      • Optional—Allow the step to be finished without being run.
    • Automatic—Run the step as soon as it becomes active.

      注意:

      If your workflow diagram is configured to automatically run a sequence of steps that includes the Evaluate Data Quality or the Run GP Service step, steps that attempt to run after the user token that started the sequence of steps expires will not run automatically. You must have a license for the ArcGIS Workflow Manager Server Advanced role to continue running the additional automated steps without manual intervention.

    • Run on a Schedule—Run the step according to a schedule you set.

      Learn more about scheduling options

18. Optionally, provide help text for the step in the Step Help text box.

    You can also use the following example to display a dynamic value using ArcGIS Arcade expressions:

    'For further assistance, please contact ' + jobCreator($job) + '.'

19. Optionally, click the Style tab to change the shape and color of the step.
20. Optionally, click the About tab and provide a description for the step in the Step Description text box.

    注意:

    The About tab also contains the step's ID that can be used with dynamic job properties to obtain a step's output.

Return value

When the step is completed, its return value is stored to indicate the result of the step. The return value can be immediately evaluated using paths to determine the next steps in the workflow. You can also retrieve the return value for completed steps throughout the workflow using ArcGIS Arcade expressions. The following table lists the step's return values:

Return values	Description
S000001	The step completed successfully.
F000001	The step failed to complete successfully.

出力値

When the step is completed, its output value is stored and can be used to determine the path the workflow follows or be used as inputs for other steps throughout the workflow. The following table shows the step's output value:

出力	説明	ArcGIS Arcade 式の構文
<DerivedOutputParameterValue>	ツールから受信した、構成済みの派生出力値を返します。	jobOutputValue($job, '<step_id>','<derived_output_parameter_name>') 注意: derived_output_parameter_name はオプションのパラメーターです。 派生出力パラメーター名が入力されていない場合、最初の派生出力値が返されます。