ジョブを取得

UiPath.Core.Activities.GetJobs

説明

Orchestrator API でカスタム フィルターを指定して Orchestrator のジョブのリストを取得します。スキップするジョブの数や取得するジョブの最大数を指定することもできます。 Studio でこのアクティビティを実行するためには、ロボットが Orchestrator に接続されており、Robot ロールにジョブ、プロセス、およびロボット グループの表示権限が付与されている必要があります。このアクティビティは、実行するロボットの下で実行されます。

プロジェクトの対応 OS

Windows - レガシ | Windows | クロスプラットフォーム

クロスプラットフォームでの設定

• Orchestrator フォルダー パス - ジョブの取得元となるフォルダーのパスです (プロセスが実行されているフォルダーと異なる場合)。このフィールドでは文字列値のみがサポートされており、サブフォルダーを示す区切り文字として / を使用します。たとえば "Finance/Accounts Payable" です。
  注:

  Folder Path パラメーターは、クラシック フォルダー内のロボットによって実行されるプロセスでは機能しません。モダン フォルダー内のロボットのみが、フォルダー外にデータを渡すことができます。

  X-UIPATH-FolderPath-Encoded ヘッダーでは、以下のように相対フォルダー パスがサポートされています。

  / で始まるパス - 周囲のフォルダーが属するツリーの root フォルダーから開始します。

  . で始まるパス - 周囲のフォルダーから開始します。

  .. で始まるパス - パス内のそれぞれの .. について、周囲のフォルダーの階層で 1 つ上のレベルから開始します (例: ../: 1 レベル上の階層、../../: 2 レベル上の階層)。

  末尾にスラッシュを付けることはできません。

• フィルター - ジョブを取得するための OData フィルターを指定します (例: CreationTime gt 2017-01-01T00:03:08.93Z and State eq 'Running')。詳しくは、OData のドキュメントをご覧ください。このプロパティでは、文字列と String 型変数のみがサポートされています。式の代わりにフィルターを使用する場合は、利用可能なウィザードを使用して設定できます。

Windows での設定

• Orchestrator フォルダー パス - ジョブの取得元となるフォルダーのパスです (プロセスが実行されているフォルダーと異なる場合)。このフィールドでは文字列値のみがサポートされており、サブフォルダーを示す区切り文字として / を使用します。たとえば "Finance/Accounts Payable" です。
  注:

  Folder Path パラメーターは、クラシック フォルダー内のロボットによって実行されるプロセスでは機能しません。モダン フォルダー内のロボットのみが、フォルダー外にデータを渡すことができます。

  X-UIPATH-FolderPath-Encoded ヘッダーでは、以下のように相対フォルダー パスがサポートされています。

  / で始まるパス - 周囲のフォルダーが属するツリーの root フォルダーから開始します。

  . で始まるパス - 周囲のフォルダーから開始します。

  .. で始まるパス - パス内のそれぞれの .. について、周囲のフォルダーの階層で 1 つ上のレベルから開始します (例: ../: 1 レベル上の階層、../../: 2 レベル上の階層)。

  末尾にスラッシュを付けることはできません。

• フィルター - ジョブを取得するための OData フィルターを指定します (例: CreationTime gt 2017-01-01T00:03:08.93Z and State eq 'Running')。詳しくは、OData のドキュメントをご覧ください。このプロパティでは、文字列と String 型変数のみがサポートされています。フィールドをクリックすると、フィルター ウィザード ウィンドウが開きます。

詳細オプション

その他

• Skip - 最初の「n」個のジョブをスキップできます。このプロパティでは整数と整数の変数のみサポートされています。
• 上限 - 合計のうちの指定した数のジョブだけを返します。最大値は 100 です。このプロパティでは整数と Integer 型変数のみがサポートされています。
• Target.Timeout (milliseconds) - エラーがスローされるまでにアクティビティが待機する時間 (単位: ミリ秒) を指定します。既定値は、30000 ミリ秒 (30 秒) です。
• エラー発生時に実行を継続 - アクティビティでエラーが発生した場合でも、オートメーションを継続するかどうかを指定します。このフィールドでは Boolean 値 (True、False) のみがサポートされています。既定値は False です。その結果、フィールドが空白の場合にエラーが発生すると、プロジェクトの実行が停止します。値を True に設定すると、エラーの発生に関係なくプロジェクトの実行は継続されます。

出力

• ジョブ - 取得したジョブ (IEnumerable<OrchestratorJobs> 変数) です。

ウィザードを設定する

ウィザードを使用すると、Orchestrator からジョブを取得するために使用するフィルターを簡単に作成できます。

次のエンティティを使用できます。

• キー - Orchestrator ジョブのキーです。

  • 特定の文字列または変数に等しいか ([次の値と等しい])、または等しくないか ([次の値と等しくない]) を設定できます。

• 開始時刻 - Orchestrator ジョブの開始時刻です。

  • 特定の日付/時刻/時間より新しいか ([次の値より新しい])、または古いか ([次の値より古い]) を設定できます。

• End Time - Orchestrator のジョブの終了時刻です。

  • 特定の日付/時刻/時間より新しいか ([次の値より新しい])、または古いか ([次の値より古い]) を設定できます。

• State - Orchestrator のジョブのステートです。

  • 以下のいずれかの値に等しいか ([次の値と等しい])、または等しくないか ([次の値と等しくない]) を設定できます。
    • エラー
    • 保留中
    • 再開
    • Running (実行中)
    • 停止
    • 停止中
    • 成功
    • 中断
    • 終了中

• 優先度 - Orchestrator ジョブの優先度です。

• • 以下のいずれかの値に等しいか ([次の値と等しい])、または等しくないか ([次の値と等しくない]) を設定できます。
    • 高 (High)
    • 低 (Low)
    • 標準 (Normal)

• 作成時刻 - Orchestrator ジョブの作成時刻です。

• • 特定の日付/時刻/時間より新しいか ([次の値より新しい])、または古いか ([次の値より古い]) を設定できます。

• Release Name

• • 次のいずれかのオプションを設定できます。
    • 次の値を含む
    • 行末
    • 次に等しい
    • 次を含まない
    • 次の値と等しくない
    • 次の値で始まる

Windows - レガシでの設定

プロパティ パネル

共通

• エラー発生時に実行を継続 - アクティビティでエラーが発生した場合でも、オートメーションを継続するかどうかを指定します。このフィールドでは Boolean 値 (True、False) のみがサポートされています。既定値は False です。その結果、フィールドが空白の場合にエラーが発生すると、プロジェクトの実行が停止します。値を True に設定すると、エラーの発生に関係なくプロジェクトの実行は継続されます。
• 表示名 - アクティビティの表示名です。
• Target.Timeout (milliseconds) - エラーがスローされるまでにアクティビティが待機する時間 (単位: ミリ秒) を指定します。既定値は、30000 ミリ秒 (30 秒) です。

入力

• フィルター - ジョブを取得するための OData フィルターを指定します (CreationTime gt 2017-01-01T00:03:08.93Z および State eq 'Running')。詳細については、OData のドキュメントをご覧ください。このプロパティでは、文字列または String 型変数のみがサポートされています。

その他

• Orchestrator フォルダー パス - ジョブの取得元となるフォルダーのパスです (プロセスが実行されているフォルダーと異なる場合)。このフィールドでは文字列値のみがサポートされており、サブフォルダーを示す区切り文字として / を使用します。たとえば "Finance/Accounts Payable" です。
  注:

  Folder Path パラメーターは、クラシック フォルダー内のロボットによって実行されるプロセスでは機能しません。モダン フォルダー内のロボットのみが、フォルダー外にデータを渡すことができます。

  X-UIPATH-FolderPath-Encoded ヘッダーでは、以下のように相対フォルダー パスがサポートされています。

  / で始まるパス - 周囲のフォルダーが属するツリーの root フォルダーから開始します。

  . で始まるパス - 周囲のフォルダーから開始します。

  .. で始まるパス - パス内のそれぞれの .. について、周囲のフォルダーの階層で 1 つ上のレベルから開始します (例: ../: 1 レベル上の階層、../../: 2 レベル上の階層)。

  末尾にスラッシュを付けることはできません。

• プライベート - オンにした場合、変数および引数の値が Verbose レベルでログに出力されなくなります。

出力

• ジョブ - 取得したジョブ (IEnumerable<OrchestratorJobs> 変数) です。

ページネーション

• Skip - 最初の「n」個のジョブをスキップできます。このプロパティでは整数と整数の変数のみサポートされています。
• 上限 - 合計のうちの指定した数のジョブだけを返します。最大値は 100 です。このプロパティでは整数と Integer 型変数のみがサポートされています。