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

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

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

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

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

注意:

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

ステップの実行時に、次のアクションを実行できます。

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

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

ステップの構成

ステップを構成するには、次の手順に従います。

  1. ワークフロー ダイアグラムを作成または編集し、[ステップ ライブラリ] パネルにアクセスします。
  2. [ArcGIS Pro ジオプロセシング ツールの実行][ステップのライブラリ] パネルからワークフロー キャンバス上のステップの接続矢印にドラッグします。

    [ステップの詳細] パネルが表示されます。

  3. [ステップ名] テキスト ボックスにステップの名前を入力します。
  4. 必要に応じて、[ユーザー プロンプト] テキスト ボックスにステップの実行時に表示するメッセージを追加します。

    ユーザー プロンプトにプレーン テキストと Arcade 式が含まれている場合は、テキストを次のように書式設定します。

    'This job is currently assigned to ' + JobOwner($Job) + '.'
    ヒント:

    [この入力は Arcade 式をサポートします] This input supports Arcade expressions をクリックし、ArcGIS Arcadeを選択して関連するテキスト ボックスに追加します。

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

    システム ツールボックス内のツール

    実行するツールを含むツールボックスのエイリアスを [ツールボックスのエイリアス] テキスト ボックスに入力します。

    ツールボックスのエイリアスは、ArcGIS Pro ドキュメントにあるツールのヘルプ ページ上の Python タブにあります。

    ArcGIS Pro プロジェクトにインポートされているツール

    実行するツールを含むツールボックスのエイリアスを [ツールボックスのエイリアス] テキスト ボックスに入力します。

    [カタログ] ウィンドウでツールボックスを右クリックし、[プロパティ] をクリックして、ツールボックスのエイリアスを表示します。

    カスタム ジオプロセシング ツールおよびスクリプト

    [ツールボックス パス] テキスト ボックスにツールボックスへの絶対パスを入力します。 ツールボックスへのパスは、ファイル ジオデータベースまたは エンタープライズ ジオデータベース に格納されているツールボックスを参照することもできます。 パスは ArcGIS Pro でアクセス可能になっている必要があります。

    ArcGIS Arcadeを使用して動的な値を入力することもできます。

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

    [ツール名] テキスト ボックスのジオプロセシング ツール名が、Arcade の関数名と一致する場合 ([バッファー][クリップ] など)、ツールの名前を一重引用符か二重引用符で囲み、Arcade 式として評価されないようにする必要があります。

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

    ArcGIS Arcadeを使用して動的な値を入力することもできます。

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

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

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

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

  14. 必要に応じて、[ジオプロセシング ログの添付] チェックボックスをオンにし、ツールの履歴をジョブの添付ファイルとして保存します。
    注意:

    [ジオプロセシング ログの添付] チェックボックスをオンにすると、ツールの履歴ログの添付ファイル ID がステップの出力値に含まれるようになります。

  15. 必要に応じて、ログが格納されるフォルダーの名前を [フォルダー] テキスト ボックスに入力します。

    フォルダー名にファイル システム パスまたは特殊文字を含めることはできません。 フォルダー名が入力されていない場合、[General] という名前のフォルダーが自動的に作成されます。

    注意:

    フォルダーは、ワークフロー アイテム内に含まれるため、ファイル システム パスではありません。

  16. [オプション] タブをクリックします。
  17. 必要に応じて、[ステップ オプション] を構成します。
    • [手動] - 手動でステップを実行します。
      • [オプション] - ステップを実行しないで終了できるようにします。
    • [自動] - アクティブになり次第、ステップを実行します。
      注意:

      ワークフロー ダイアグラムがデータ品質の評価ステップまたはジオプロセシング サービスの実行ステップを含む一連のステップを自動的に実行するように構成されている場合、一連のステップを開始したユーザー トークンの有効期限が切れた後に実行を試みるステップは、自動的に実行されません。 手動操作なしで、さらなる自動ステップの実行を継続するには、ArcGIS Workflow Manager Server Advanced ロールのライセンスが必要です。

    • [スケジュールに沿って実行] - 設定したスケジュールに従ってステップを実行します。

      スケジュール オプションの詳細

  18. 必要に応じて、次のオプションのいずれかを選択して、ステップでヘルプを構成します。
    • [なし] - ステップ ヘルプなしでステップを構成します。
    • [テキスト] - [テキスト] テキストボックスで、ステップのヘルプ テキストを構成します。

      ArcGIS Arcadeを使用して、ステップ ヘルプの動的な値を入力できます。 ステップ ヘルプにプレーン テキストと Arcade 式が含まれている場合は、テキストを次のように書式設定する必要があります。

      
      'For further assistance, please contact' + JobCreator($Job) + '.'

    • [URL] - [URL] テキストボックスで、ステップにヘルプ リソースへのリンクを構成します。
      注意:

      Web アプリで実行されるステップでは、HTTP、HTTPS URL 形式のみがサポートされます。 ArcGIS Pro で実行されるステップでは、HTTP、HTTPS、ファイル形式がサポートされます。

      Arcadeを使用して動的な値を入力することもできます。 URL にプレーン テキストと Arcade 式が含まれている場合は、テキストを次のように書式設定する必要があります。

      
      'https://pro.arcgis.com/en/pro-app/latest/tool-reference/' + JobExtendedProperty($Job, 'tools', 'toolbox') + '/' + jobExtendedProperty($job, 'tools', 'alias') + '.htm'

      [Arcade の結果を自動的にエンコード] チェックボックスを構成します。

      • URL に変換するときにエスケープする必要がある特殊文字 (スペースやフォワード スラッシュなど) を Arcade 式が返す場合、[Arcade の結果を自動的にエンコード] チェックボックスを必ずオンにしてください。
      • ベース URL を構成するために Arcade 式が使用される場合、[Arcade の結果を自動的にエンコード] チェックボックスをオフにします。

  19. 必要に応じて、[スタイル] タブをクリックし、ステップの形状と色を変更します。
  20. 必要に応じて、[情報] タブをクリックし、[ステップの説明] テキストボックスにステップの説明を入力します。
    ヒント:

    [情報] タブには、ステップの出力を取得するために動的なジョブ プロパティで使用できるステップ ID も含まれています。 ステップ ID をクリップボードにコピーするには、[ステップ ID をコピー] Copy Step ID をクリックします。

戻り値

ステップが完了すると、その戻り値が格納され、ステップの結果を示します。 パスを使用して戻り値をすぐに評価し、ワークフロー内の次のステップを決定できます。 ArcGIS Arcade 式を使用して、ワークフロー全体を通じて完了したステップの戻り値を取得することもできます。 次の表は、ステップの戻り値を示しています。

戻り値説明

S000001

ステップが正常に完了しました。

F000001

ステップを正常に完了できませんでした。

出力値

ステップが完了すると、その出力値が格納され、ワークフローがたどるパスの決定に使用したり、ワークフロー全体で他のステップの入力値として使用したりできます。 次の表は、ステップの出力値を示しています。

出力説明

<DerivedOutputParameterValue>

ツールから受信した、構成済みの派生出力値を返します。

attachmentId

ステップに追加された添付ファイル ID の配列を返します。

関連トピック


このトピックの内容
  1. ステップの構成
  2. 戻り値
  3. 出力値