フォーム タスクを取得 (Get Form Tasks)

UiPath.Persistence.Activities.FormTask.GetFormTasks

説明

特定の基準、つまり以下のようなアクションの DTO プロパティによってフィルター処理を行う、単独または一連のアクションのクエリに使用できます。

• Status
• タイトル
• ID
• 優先度
• タスク カタログ名
• AssignedToUser
• CreatorUser
• LastModifierUser
• 作成時刻
• LastModificationTime
• OrganizationUnitID

[フォーム タスクを取得] アクティビティの出力オブジェクトは、他のあらゆる永続性アクティビティ、たとえば [フォーム タスク完了まで待機し再開] などで使用でき、アクションを作成したワークフローとは別のワークフローがアクションの完了を待機する必要があるような状況に対応できます (例: 現在のジョブが失敗した場合のリカバリー ワークフローを構築する場合など)。出力オブジェクトを別のプロセスに入力として渡すことで、すべてのアクションの完了を待たずに最初のプロセスを再開することもできます。

注: * アクションのフィルター処理およびクエリには、アクションのメタデータに基づいた OData 構文が使用されます。

プロジェクトの対応 OS

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

Windows および Windows - レガシでの設定

デザイナー パネル

• タスク カタログ名 - [フォーム タスクを作成] アクティビティを使用して設定されたアクションのカタログ名です。
• 参照 - [フォーム タスクを作成] アクティビティによって設定されたアクションの参照先です。
• フィルター - 取得されたアクションを指定された基準に従ってフィルター処理するために使用される、OData の filter オプションです。このフィールドでは、文字列と String 型変数のみがサポートされています。例: Status in ('Pending', 'Unassigned'), and Priority eq 'High'
• select - アクションのプロパティのサブセットを取得するために使用される、OData の select オプションです。ID オプションを入力する必要があります。そのため、アクション カタログを取得する場合に使用するクエリは "Id, TaskCatalogName" です。このフィールドでは、文字列と String 型変数のみがサポートされています。
• タスク オブジェクト (出力) - アクティビティで設定された基準に一致する出力オブジェクトのリストです。出力は Orchestrator から List<FormTaskData> オブジェクトとして返されます。このオブジェクトはリカバリー ワークフローを作成する場合や、別のプロセスの入力として渡す場合に使用します。

プロパティ パネル

共通

• エラー発生時に実行を継続 - アクティビティが例外をスローした場合でも、ワークフローを継続するかどうかを指定します。このフィールドでは Boolean 値 (True、False) のみサポートされています。既定値は False です。その結果、フィールドが空白で例外がスローされると、プロジェクトの実行が停止します。値を True に設定すると、プロジェクトの実行はエラーに関係なく継続されます。

注: このアクティビティが [トライ キャッチ] に含まれていて、[エラー発生時に実行を継続] プロパティの値が True の場合、プロジェクトが実行されたときにエラーは発生しません。

• 表示名 - アクティビティの表示名です。
• タイムアウト (ミリ秒) - エラーがスローされる前にアクティビティが実行されるまで待機する時間 (ミリ秒単位) を指定します。既定値は 30000 ミリ秒 (30 秒) です。

入力

• フォルダー パス - このアクティビティで使用する Orchestrator フォルダーのパスです。何も指定しない場合は、現在の Orchestrator フォルダーが使用されます。このフィールドは、文字列と String 型変数のみをサポートします。
• 参照 - [フォーム タスクを作成] アクティビティによって設定されたアクションの参照先です。
• タスク カタログ名 - [フォーム タスクを作成] アクティビティを使用して設定されたアクションのカタログ名です。

その他

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

OData クエリ オプション

OData クエリ オプション	説明	フィールド データの種類	例
展開	基準の関連エンティティの表示に使用する OData の expand オプションです。	文字列	"AssignedUser"
フィルター	取得されたアクションを指定された基準に従ってフィルター処理するために使用される、OData の filter オプションです。	文字列	Status in ('Pending', 'Unassigned') and Priority eq 'High'
order-by	取得されたアクションを指定された基準に従って昇順 (asc) または降順 (desc) で並べ替えるために使用される、OData の orderby オプションです。	文字列	"Title asc" "ID desc"
選択	アクションのプロパティのサブセットを取得するために使用される、OData の select オプションです。	文字列	"ID, Status, TaskCatalogName"
スキップ	一連のアクションを取得せずにスキップするために使用される、OData の skip オプションです。	Int32	2
上限数	取得されるレコードの数を設定するために使用される、OData の top オプションです。一度に取得できるレコードの数は最大 1,000 件に制限されています。空のままにすると、上位 100 件のレコードが取得されます。	Int32	20

注: AND/OR 演算子もサポートされています。

出力

• タスク オブジェクト (出力) - アクティビティで設定された基準に一致する出力オブジェクトのリストです。出力は Orchestrator から List<FormTaskData> オブジェクトとして返されます。このオブジェクトはリカバリー ワークフローを作成する場合や、別のプロセスの入力として渡す場合に使用します。

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

• タスク カタログ名 - [フォーム タスクを作成] アクティビティを使用して設定されたアクションのカタログ名です。
• 参照 - [フォーム タスクを作成] アクティビティによって設定されたアクションの参照先です。
• フィルター - 取得されたアクションを指定された基準に従ってフィルター処理するために使用される、OData の filter オプションです。このフィールドでは、文字列と String 型変数のみがサポートされています。例: Status in ('Pending', 'Unassigned'), and Priority eq 'High'
• select - アクションのプロパティのサブセットを取得するために使用される、OData の select オプションです。ID オプションを入力する必要があります。そのため、アクション カタログを取得する場合に使用するクエリは "Id, TaskCatalogName" です。このフィールドでは、文字列と String 型変数のみがサポートされています。
• タスク オブジェクト (出力) - アクティビティで設定された基準に一致する出力オブジェクトのリストです。出力は Orchestrator から List<FormTaskData> オブジェクトとして返されます。このオブジェクトはリカバリー ワークフローを作成する場合や、別のプロセスの入力として渡す場合に使用します。

詳細オプション

共通

• エラー発生時に実行を継続 - アクティビティが例外をスローした場合でも、ワークフローを継続するかどうかを指定します。このフィールドでは Boolean 値 (True、False) のみサポートされています。既定値は False です。その結果、フィールドが空白で例外がスローされると、プロジェクトの実行が停止します。値を True に設定すると、プロジェクトの実行はエラーに関係なく継続されます。

注: このアクティビティが [トライ キャッチ] に含まれていて、[エラー発生時に実行を継続] プロパティの値が True の場合、プロジェクトが実行されたときにエラーは発生しません。

• タイムアウト (ミリ秒) - エラーがスローされる前にアクティビティが実行されるまで待機する時間 (ミリ秒単位) を指定します。既定値は 30000 ミリ秒 (30 秒) です。

入力

• フォルダー パス - このアクティビティで使用する Orchestrator フォルダーのパスです。何も指定しない場合は、現在の Orchestrator フォルダーが使用されます。このフィールドは、文字列と String 型変数のみをサポートします。

OData クエリ オプション

OData クエリ オプション	説明	フィールド データの種類	例
展開	基準の関連エンティティの表示に使用する OData の expand オプションです。	文字列	"AssignedUser"
並べ替え順	取得されたアクションを指定された基準に従って昇順 (asc) または降順 (desc) で並べ替えるために使用される、OData の orderby オプションです。	文字列	"Title asc" "ID desc"
スキップ	一連のアクションを取得せずにスキップするために使用される、OData の skip オプションです。	Int32	2
上限数	取得されるレコードの数を設定するために使用される、OData の top オプションです。一度に取得できるレコードの数は最大 1,000 件に制限されています。空のままにすると、上位 100 件のレコードが取得されます。	Int32	20

OData クエリの例

次の例を使用して、フォーム タスクを取得するか、その他のクエリの参考とします。

1. ステータスが保留中で優先度が高いフォーム タスクの ID をタイトルの降順で取得します。
   1. Filter: "((Priority eq 'High') and (Status eq 'Pending'))"
   2. Order By: "Title desc"
   3. Select: "Id"
2. ステータスが「Unassigned」で優先度が「Medium」のフォーム タスクがすべて保存されているアクション カタログを取得し、タイトルの昇順に並べ替えます。
   1. Filter: "((Priority eq 'Medium') and (Status eq 'Unassigned'))"
   2. Order By: "Title asc"
   3. Select: "Id, TaskCatalogName"