[ジョブ プロパティの更新] の追加および構成

[ジョブ プロパティの更新] ステップでは、ジョブを実行しているユーザーが拡張プロパティや次のジョブ プロパティを更新できます。

• job_name
• start_date
• due_date
• priority_rank
• 説明
• owned_by
• job_status
• メモ
• parent_job

ステップが実行されると、ステップで構成されたプロパティがジョブ タイルに表示されます。 ステップにヘルプ テキストが構成されている場合、ジョブ タイルの下部に表示されます。 更新可能な各プロパティの下にあるテキスト ボックスに、デフォルト値または現在の値が表示されます。

プロパティに無効な値が含まれていたり、必須のプロパティに値が含まれていない場合、そのプロパティは赤色でハイライト表示され、[続行] ボタンは使用できません。

注意:

プロパティが自動的に更新され、エラーが発生した場合、ステップは失敗し、ジョブ タイルにエラーが表示されます。 エラーは ArcGIS Server ログにも書き込まれます。

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

• The step can be cancelled by clicking Cancel.
• The step can be finished by clicking Proceed.

ステップの構成

To configure the step, do the following:

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

   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. [引数] セクションの [ジョブ プロパティ] テキスト ボックスに、更新するプロパティのテーブル名とフィールド名を次の構文で入力します。

   tablename.fieldname

   注意:

   ジョブ プロパティのテーブル名は jobs です。 拡張プロパティ テーブルのテーブル名は、ジョブ テンプレートの [拡張プロパティ] タブに表示されます。

6. 必要に応じて、[デフォルト値の表示] ボタン をクリックし、ステップが実行される際のプロパティのデフォルト値と表示設定を定義します。
   1. 次のオプションの中から 1 つを選択します。
      • [値] - 静的な値を入力します。
      • [Arcade 式] - Arcade 式を使用して動的な値を入力します。
   2. [値] または [Arcade 式] テキスト ボックスで、プロパティのデフォルト値を入力します。
   3. ステップが実行される際に値を変更できるようにするには、[表示] チェックボックスをオンにします。

   注意:

   デフォルト値が入力されておらず、[表示] チェックボックスがオフになっている場合、ステップが実行される際にジョブ プロパティの現在の値は削除されます。

7. 必要に応じて、[新しいジョブ プロパティの追加] をクリックし、ステップ 5 と 6 を繰り返して、さらにプロパティを追加します。

   注意:

   ジョブ プロパティを削除するには、そのプロパティの上にカーソルを置き、[プロパティの削除] ボタン をクリックします。

8. Optionally, hover over a property, click the Reorder Property button , and drag it to the desired location to reorder the properties.
9. Click the Options tab.
10. 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

11. Optionally, check the Enabled check box in the Step Commenting section to allow a user to add a comment when the step is run.
12. Optionally, if you enabled step commenting, check the Required check box in the Step Commenting section to require a comment.
13. 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) + '.'

14. Optionally, click the Style tab to change the shape and color of the step.
15. 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.