UiPath Appsのイベントでキューに追加する方法の備忘録
アプリのボタンを押してキュートリガーを発火し、プロセスを起動させるために今回の機能を実現しました。
手順
- 【Orchestrator】キューを作成
- 【Orchestrator】キューのスキーマ設定
- 【Apps】アプリ内にキューを追加
- 【Apps】ボタンのルール作成
キューを作成
公式のドキュメントをもとにキューを作成
今回はMy Workspaceの中にDemoQueueを作成しました。
キューのスキーマ設定
Apps上でキューを利用するためにはキューのスキーマを設定する必要性があります。
試しに公式のドキュメントにあるサンプルスキーマを利用してJsonファイルを作成。
Jsonファイルの作成には以下のサイトを利用しました。
サンプルのスキーマにはRequiredの項目があり、ここに入っている項目はキューアイテムの更新が必須になります。（どのようなエラーが出るかは下で説明しています。）
今回は"name"を削除して利用しました。
作成したschema.jsonを、キューの[スキーマ定義]>[固有データJSONスキーマ]に配置
アプリ内にキューを追加
Appsを開き、[コントロールを追加]のドロップダウンから[キュー]を選択
テナントを選択し、作成したキューをクリックして追加。Jsonファイルで指定したスキーマが表示される。
ボタンのルール作成
Apps上でアプリを作成し、適当なボタンを配置。 ボタンの[イベント]から[ルールを作成]をクリック
[キューに追加]のルールを追加し、[使用するキュー]として先ほど追加したキューを選択。
キューの項目に値を追加したい場合には以下の設定も行ってください。スキーマのRequiredに設定された項目は必ず値を上書きする必要性があります。
これですべて工程が完了です。
プレビュー
配置したAdd Queue Itemのボタンをクリックすると新たにアイテムが追加されたことが確認できました。
もしボタンを押してキューを追加しようとしたときに、以下のエラーが出たらスキーマを定義したファイルを見直してください。
日本語「このキュー アイテムは指定の入力スキーマに違反しています。」
English ”The queue item violates the specified input schema”
私は最初にサンプルを使った時にRequiredの項目が設定されていたことに気づかずに、このエラーが出ました。Requiredに設定されている項目では、[キューに追加]のルールで項目を上書きすることが必須になります。
活用方法
今回はサンプルをもとに作成しましたが、スキーマとルールに変更を加えることで実現できることはさらに広がります。私は、ログインしているアカウントのメールアドレスとアプリ側から受け取った値をアイテムの項目に追加して、キュートリガーで呼び出したプロセスに渡し、メール送信を自動化を実現しました。
ただ、プロセスを起動するだけであればApps側のルールで実現できるので、キューを追加してキュートリガーから呼び出す必要があるかは状況によって使い分ける必要性がありそうです。