RPAツール UiPath をクラウド BPM の業務フローと API 連携させてみた

システム連携ネタでよくブログを書いている日下です。
※ちなみにこれまでの記事はこちら

最近 RPA ツール*1 を使う方・試す方が増えているのではないかと思います。Googleトレンドで調べたところ、日本国内で主に話題になっているものといえば

• UiPath
• WinActor
• BasicRobo!（旧称 BizRobo!）

があげられます。中でも UiPath はサーバも含めて無料で試せるので人気が高いようです。

さて一方で、RPA ツールが非常に流行っていることもあり、ツールをとりあえず入れてはみたけど、いまいち効果が出せてない、という話をよく耳にします。
いろいろなケースが考えられますが、1つの解決アプローチとして、BPM*2 との連携活用があります。BPM で業務フローを整理して、業務上のどの部分を自動化すると効果的か検討した上で、効果の高い部分に RPA ツールを適用する、といった方法です。また業務フローの途中で BPM から自動的に RPA ツールを起動することができますので、BPM + RPA の組合せで RPA ツールをよりラクに・効果的に活用することもできます。
詳しくは以下のページをご覧ください。

RPA を成功に導く4つのステップ

無料で試せる BPM ワークフローと RPA ツールとの連携

ということで、今回は RPA ツール UiPath のロボットを、クラウド BPM ワークフロー Questetra で作成した業務フローから API*3 経由で起動できるかを検証しました。

おおまかに図にすると以下のような形です。
UiPath Studio（以下、Studio）は設計ツール、UiPath Orchestrator（以下、Orchestrator）はサーバです。図には描いてませんが Studio と Orchestrator の間は UiPath Agent（以下、Agent）というツール経由で接続します。
※今回は REST API 経由で、Questetra → UiPath という連携です。他の方式での連携や、逆向き（UiPath → Questetra）の連携も可能です

この章では具体的な設定について説明しています。技術的な部分に関心がない方は流し読みしてください。

この検証のために UiPath を本格的に触り始めたのですが、まずは考え方や用語とその関係性の理解に苦労しました。Orchestrator を触りながら理解した部分（「マシン」／「ロボット」／「ロボットグループ（Enviroment）」／「パッケージ」／「プロセス」／「ジョブ」の関係）について、以下の図がちょうどうまく表現されていました。
・業務可視化Note 【機能一覧からわかる】UiPath Orchestrator 6種のできること 【主要機能2】シナリオ配布管理
・同上 【主要機能3】シナリオ実行管理
UiPath のドキュメント内の Orchestrator の ER 図でもおおよそカバーされていました。

また、UiPath のドキュメントは日本語化がされていない部分があったり、フォーラムは英語の方が情報量が多いので、英語に抵抗のない場合には言語設定を English で扱う方がいいかもしれません。

やったことをざっと箇条書きにすると以下の通り。

• Studio で自動化プロセスを設計（検証用であれば MessageBox がポップアップ表示されるだけのものでも OK）
• デモ用 Orchestrator（https://demo.uipath.com）に接続してテナント登録（ここで登録するパスワードは後で API 実行の認証に利用することを想定して設定要）
• 設計 PC および実行 PC を Agent 経由で Orchestrator に接続
• Orchestrator で実行 PC を「マシン」として登録（ここで Windows のパスワードを入れないといけないのでどの PC で実行するかは留意要）
• Studio で設計したものを Publish する → Agent 経由で Orchestrator に「パッケージ」としてアップロードされる
• Orchestrator で実行「マシン」とひもづけて「ロボット」および「ロボットグループ（Enviroment）」作成
• Orchestrator で「パッケージ」と「ロボットグループ（Enviroment）」とひもづけて「プロセス」作成

この「プロセス」を実際に動かすのが「ジョブ」で、Orchestrator からでも API 経由でも実行可能となります。
※「プロセス」を API で実行する場合には、Processes（Releases） の Key が必要で、「プロセス」を作成した後に API で取得するしかなさそう。このような API 仕様になっているのは、おそらく以前は Release という名称だったんでしょうね・・・取得については詳細を後述します。

設計については、検索するといろいろなドキュメントが出てくるのでそれらを参照してもらうとして、ざっくりしたイメージとしては以下のような感じ。

• 必要な部品を検索して、フローに追加して、プロパティを設定。それを繰り返すことでフローを作り上げる
• もし必要な部品がなければインポートする

API の実行としては http リクエストを送る（「メッセージ送信中間イベント（HTTP）」を入れる）ように設定すればいいのですが、認証が少し特殊です。
そのため、処理としては以下のような形となります。

• 認証のための http リクエストを投げて、レスポンスの中からトークン取得
• そのトークンを使って API を実行する http リクエストを送付

https://platform.uipath.com/api/account/authenticate

{
    "tenancyName" : "XXX_TenantName_XXX",
    "usernameOrEmailAddress" : "XXX_email_XXX",
    "password" : "XXX_password_XXX"
}

var jsonObj = JSON.parse(engine.findDataByNumber("10"));
var token = jsonObj.result + "";
engine.setDataByNumber("11", token);

https://platform.uipath.com/odata/Releases?$filter=%20Name%20eq%20'XXX_ProcessName_XXX'

https://platform.uipath.com/odata/Jobs/UiPath.Server.Configuration.OData.StartJobs

{
  "startInfo": {
    "ReleaseKey": "XXX_Key_XXX",
    "Strategy": "All",
    "RobotIds": [],
    "NoOfRobots": 0
  }
}

実際に業務で使う場合には、承認を経た後に http リクエストを送る部分を足す、といった形になるでしょうか。
（例えば、マスタ追加申請で承認された後に RPA ツールでマスタ登録させる、とか）

REST API で起動する際に、当然引数によって動きを変えたい、ということがあるかと思います。
そういう場合には、以下の対応が必要。

• Studio で入力引数（arguments/IN）を準備（パブリッシュを忘れずに、またパブリッシュしなおしたら Orchestrator でプロセス作り直し要）
• 実行時に送付する JSON で引数を指定（引数部分は JSON を文字列化したもので）

{
  "startInfo": {
    "ReleaseKey": "XXX_Key_XXX",
    "Strategy": "All",
    "RobotIds": [],
    "NoOfRobots": 0,
    "InputArguments": "{\"XXX_ArgumentName_XXX\":\"XXX_value_XXX\"}"
  }
}

Studio を使って設計をした PC 自体が実行 PC にもなる場合、処理実行されるまでがあまり時間がかかりませんでした。設計 PC と実行 PC が異なる場合には、ロボットのダウンロードが必要となるようで、初回の実行には少し時間がかかりました。

また、実行 PC がスリープに入っていると処理が実行できませんでしたので、スリープに入ってしまわないような設定が必要でした。

これらを留意すれば、想定通りに自動処理が実行されました。

まずは自社内で、無料お試しへの申込があると Excel ファイルにデータが入るよう試運転させる予定です。その中で運用上の課題なども出てくると思いますが、それについてはまた別の記事で共有できればと考えています。

また、今回の UiPath の検証をしている中で、処理フローを設計 → それをデプロイする（UiPath では「Publish」、Questetra では「リリース」という表現になります）という設定方法について Questetra のそれと非常に近いと感じました。考え方が近いことで、相性もいいのではないかと。
※ただ、どちらにも「プロセス」というものがあるのですが、UiPath では実行のための設定を指し、Questetra では実行主体を指すので、その点は注意が必要です

ちなみに他の RPA ツールでも同様のことが実現可能です。UiPath と同様に知名度の高い BasicRobo!（旧称：BizRobo!）との API 接続は以前に検証済です。

RPAツール(BasicRobo!)とBPMシステムの連携について

また、API 以外の方式で、他の RPA ツールとの連携もいくつか検証済のものがあります。

ご質問・ご相談等がありましたら、お問合せフォームからお気軽にご連絡ください。

以下の Web フォームからお申込みいただきますと Questetra の無料お試しアカウントが作成できます。上記のものを含め、全ての機能が使えます。UiPath も Community Edition であれば無料で試せますので、ぜひ一緒にお試しください。

また資料請求・お問合せはこちらから。