IM-RPA 利用ガイド 第7版 2023-10-01

IM-RPA 利用ガイド 第7版 2023-10-01

7.5. Webhook

7.5.1. UiPath連携でのWebhook

UiPath連携では、UiPath Orchestratorが発行するWebhookリクエストをキャッチし、 IM-LogicDesignerトリガを経由してロジックフローを実行する機構を用意しています。
以下のWebhookイベントの種類に対応しています。
イベントの種類 内容
job.completed ジョブは正常に完了しました
job.faulted ジョブの実行は正常に完了しませんでした
queueItem.transactionCompleted キューアイテムトランザクションは正常に完了しました
queueItem.transactionFailed キューアイテムトランザクションが失敗しました
queueItem.transactionAbandoned キューアイテムトランザクションは期限切れとなり、破棄されました
schedule.failed スケジュールの実行に失敗しました

7.5.2. UiPath Orchestratorの設定

UiPath OrchestratorのWebhook作成画面にて設定できる項目のうち、以下の項目については説明のように設定してください。
項目 説明
URL
Webhookを受信するintra-mart Accel PlatformのエンドポイントURLです。
以下のように設定してください。
  • テナント名を自動解決する場合
    http(s)://<%ホスト名%>:<%ポート番号%>/<%コンテキストパス%>/uipath/webhook
  • テナント名を指定する場合
    http(s)://<%ホスト名%>:<%ポート番号%>/<%コンテキストパス%>/uipath/webhook/<%テナント名%>
シークレット
設定ファイル」で記述したシークレット(共通鍵)を設定してください。
イベントタイプ
「個別のイベントを選択」を選択し、「UiPath連携でのWebhook」に記載のイベントの種類の中から任意のものを選んでください。
../../../_images/uipath_webhook_1.png
図:UiPath Orchestrator Webhook作成画面

7.5.3. IM-LogicDesignerトリガの設定

有効にしたWebhookイベントの種類に対応したIM-LogicDesignerトリガ定義を作成することで、UiPath Orchestratorが送信したWebhookに反応して任意のロジックフローを実行できます。
IM-LogicDesignerトリガ定義の作成方法については、「IM-LogicDesigner ユーザ操作ガイド」 - 「トリガ定義を新規登録する」を参照してください。
以下の項目については説明のように設定してください。
項目 説明
発生条件
カテゴリ「UiPath Webhook」に、「UiPath連携でのWebhook」に記載のイベントの種類に対応した条件を用意しています。
このカテゴリ内で、反応したいWebhookイベントの種類を選択してください。
マッピング設定
Webhookリクエスト内のペイロードに含まれる情報を、ロジックフローの入力値とマッピングできます。
各イベントの種類のペイロードについては、UiPath Orchestratorのガイド内の以下のページを参照してください。
../../../_images/uipath_webhook_2.png
図: 発生条件
../../../_images/uipath_webhook_3.png
図:マッピング設定