外部タスクを作成

UiPath.Persistence.Activities.ExternalTask.CreateExternalTask

説明

指定されたデータ、タスク タイトル、タスクの優先度、およびタスク カタログで、外部アクションを作成します。

プロジェクトの対応 OS

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

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

デザイナー パネル

• タスク タイトル - 作成するアクションのタイトルです。このフィールドは、文字列と String 型変数のみをサポートします。
• タスクの優先度 - アクションの優先度レベルを選択できます。既定では、このプロパティは [TaskPriority.Medium] に設定されています。使用できるオプションは、[TaskPriority.Low (低)]、[TaskPriority.Medium (中)]、[TaskPriority.High (高)]、および [TaskPriority.Critical (クリティカル)] です。
• タスク カタログ - タスク アイテムの任意の事業分類です。このフィールドは、文字列と String 型変数のみをサポートします。
• タスク データ - 指定アクション内に保存する Dictionary<String,Argument> 形式のビジネス データのコレクションです。Out および In/Out 引数を変更すると、アクション完了後にそれらがワークフローにマップされます。このフィールドは Dictionary<String,Argument> オブジェクトのみをサポートします。
• TaskObject(Output) - The task object that is returned from Orchestrator as an ExternalTaskData object after the action is created. This object can be passed to the Wait for External Task and Resume activity in order to suspend the execution of the workflow until the action is completed.

プロパティ パネル

共通

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

注:

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

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

入力

• 外部タグ - 特定のアクションでのデータのソースである外部システムの識別に使用可能なタグです。このフィールドは、文字列と String 型変数のみをサポートします。
• ラベル - 入力されたラベルはロボットによってアクションに追加され、後でフィルター処理できます。このフィールドでは文字列の値のみがサポートされ、命名の制限があります。

注:

永続性アクティビティを使用してアクションに自動的にラベル付けできるようにするには、ワークフローを実行するロボット アカウントにタグの表示、作成、削除の権限が必要です。

• Orchestrator フォルダー パス - タスクを作成する Orchestrator のフォルダーのパスです。現在のプロセスが動作する Orchestrator のフォルダーのパス とは異なります。Orchestrator のフォルダーの詳細については、 こちらをご覧ください。クラシック フォルダーの場合、このプロパティはフローティング ロボットでのみ使用でき、現在のユーザーが対象のフォルダーでタスクの適切な権限を持っている場合にのみ使用できます。モダン フォルダーの場合、フォルダー パスのオーバーライドはサポートされていません。このフィールドは、文字列と String 変数のみをサポートします。

注:

[フォルダー パス] プロパティは、現在のフォルダーとは異なるフォルダーからタスクを開始またはクエリする必要がある場合にのみ使用する必要があります。このアクションを実行するユーザーがターゲット フォルダーに対する必要なアクセス許可を持っていない場合、タスクの作成は失敗し、重大なエラーがスローされます。フォルダーのアクセス許可について詳しくは、 こちらをご覧ください。

• タスク カタログ - タスク アイテムの任意の事業分類です。このフィールドは、文字列と String 型変数のみをサポートします。

注:

アクションを作成する前に 、アクション カタログ が存在していることを確認してください。そうしないと、アクションの作成は失敗し、「タスク カタログ (action_catalog_name] は存在しません。エラー コード: 2451)」というメッセージが表示されます。

• タスク データ - 指定アクション内に保存する Dictionary<String,Argument> 形式のビジネス データのコレクションです。Out および In/Out 引数を変更すると、アクション完了後にそれらがワークフローにマップされます。このフィールドは Dictionary<String,Argument> オブジェクトのみをサポートします。
• タスクの優先度 - アクションの優先度レベルを選択できます。既定では、このプロパティは [TaskPriority.Medium] に設定されています。使用できるオプションは、[TaskPriority.Low (低)]、[TaskPriority.Medium (中)]、[TaskPriority.High (高)]、および [TaskPriority.Critical (クリティカル)] です。
• タスク タイトル - 作成するアクションのタイトルです。このフィールドは、文字列と String 型変数のみをサポートします。

その他

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

出力

• TaskObject(Output) - The task object that is returned from Orchestrator as an ExternalTaskData object after the action is created. This object can be passed to the Wait for External Task and Resume activity in order to suspend the execution of the workflow until the action is completed.

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

• タスク タイトル - 作成するアクションのタイトルです。このフィールドは、文字列と String 型変数のみをサポートします。
• タスクの優先度 - アクションの優先度レベルを選択できます。既定では、このプロパティは [TaskPriority.Medium] に設定されています。使用できるオプションは、[TaskPriority.Low (低)]、[TaskPriority.Medium (中)]、[TaskPriority.High (高)]、および [TaskPriority.Critical (クリティカル)] です。
• タスク カタログ - タスク アイテムの任意の事業分類です。このフィールドは、文字列と String 型変数のみをサポートします。

注:

アクションを作成する前に 、アクション カタログ が存在していることを確認してください。そうしないと、アクションの作成は失敗し、「タスク カタログ (action_catalog_name] は存在しません。エラー コード: 2451)」というメッセージが表示されます。

• タスク データ - 指定アクション内に保存する Dictionary<String,Argument> 形式のビジネス データのコレクションです。Out および In/Out 引数を変更すると、アクション完了後にそれらがワークフローにマップされます。このフィールドは Dictionary<String,Argument> オブジェクトのみをサポートします。
• TaskObject(Output) - The task object that is returned from Orchestrator as an ExternalTaskData object after the action is created. This object can be passed to the Wait for External Task and Resume activity in order to suspend the execution of the workflow until the action is completed.

詳細オプション

共通

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

注:

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

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

入力

• ラベル - 入力されたラベルはロボットによってアクションに追加され、後でフィルター処理できます。このフィールドでは文字列の値のみがサポートされ、命名の制限があります。

注:

永続性アクティビティを使用してアクションに自動的にラベル付けできるようにするには、ワークフローを実行するロボット アカウントにタグの表示、作成、削除の権限が必要です。

• Orchestrator フォルダー パス - タスクを作成する Orchestrator のフォルダーのパスです。現在のプロセスが動作する Orchestrator のフォルダーのパス とは異なります。Orchestrator のフォルダーの詳細については、 こちらをご覧ください。クラシック フォルダーの場合、このプロパティはフローティング ロボットでのみ使用でき、現在のユーザーが対象のフォルダーでタスクの適切な権限を持っている場合にのみ使用できます。モダン フォルダーの場合、フォルダー パスのオーバーライドはサポートされていません。このフィールドは、文字列と String 変数のみをサポートします。

注:

[フォルダー パス] プロパティは、現在のフォルダーとは異なるフォルダーからタスクを開始またはクエリする必要がある場合にのみ使用する必要があります。このアクションを実行するユーザーがターゲット フォルダーに対する必要なアクセス許可を持っていない場合、タスクの作成は失敗し、重大なエラーがスローされます。フォルダーのアクセス許可について詳しくは、 こちらをご覧ください。

• 参照 - 特定のアクションでのデータのソースである外部システムの識別に使用可能なタグです。このフィールドは、文字列と String 型変数のみをサポートします。

外部アクションを作成する

外部アクションを作成するには、以下のいずれかの手順を選択します。

1. ワークフローに [外部タスクを作成] アクティビティを追加して、以下のプロパティ フィールドに情報を指定します。
   • タスク タイトル
   • タスクの優先度
   • タスク データ (コレクション)
   • 外部タグ - サードパーティ システムから取得する外部タスクのバッチを一意に識別するタグを指定します。このタグを使用して、外部タスクを外部システムと同期できます。また、ユーザーがサードパーティ システムで実行するアクションに基づいてタスクを完了するためにこのタグを使用することもできます。
2. API を使って外部アクションを作成します。

外部アクションをサードパーティ ツールと同期する

外部アクションを他の外部システムと同期するには、まず対応するオブジェクトを外部システム内に作成してから、サードパーティ システムで作成されたタスクまたはタスクのバッチを、API 呼び出しを使用して取得する必要があります。

1. オブジェクトを外部システム内に作成します。例:

   • Jira で課題を作成します。
   • Salesforce で連絡先を作成します。

2. Swagger で次の API を呼び出します: GET /odata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFolders。

   例: GET <ORCH_URL>/odata/Tasks/UiPath.Server.Configuration.OData.GetTasksAcrossFolders?$filter=(Type eq 'ExternalTask') and (IsDeleted eq false) and (ExternalTag eq 'JiraTasks') and (Status ne 'Completed')&$count=true

外部アクションを取得する

タスク ID と組織単位 ID (Orchestrator フォルダーの ID) を使用して外部タスクに関する情報を取得するには、次の API を呼び出します。GET /tasks/GenericTasks/GetTaskDataById。取得した詳細を使用して、類似するタスクをサードパーティ システム内に作成できます。

以下のスクリーンショットは、Swagger の API パラメーターと応答を示しています。Swagger 内でテナントにアクセスするには、「Accessing the Swagger file」の手順に従います。

外部アクションを完了する

タスク ID と組織単位 ID (Orchestrator フォルダーの ID) を使用して外部タスクを完了するには、次の API を呼び出します: POST /tasks/GenericTasks/CompleteTask。

詳しくは、『Orchestrator API ガイド』の「外部タスクを完了する」の手順をご覧ください。

ワークフローの例

サンプルや今後の参考資料については、サンプル プロジェクトをご覧ください。