7.6. UiPath連携チュートリアル¶
項目
7.6.1. チュートリアルの概要¶
本章では、IM-RPAのUiPath連携機能を使用して、UiPathのプロセスを実行する方法をチュートリアル形式でご説明します。このチュートリアルに沿って設定を行うことで、以下のような機能を実現できます。
- intra-mart Accel PlatformからIM-LogicDesignerを介してUiPathのプロセスを実行します。
- UiPathのプロセスに対してパラメータを渡し、計算した結果を受け取ります。
本章では、説明を簡単にするために、ロボットのシナリオはシンプルなものにしております。シナリオの実行イメージは以下の通りです。
図：本チュートリアルシナリオ実行イメージ
7.6.2. 準備・環境設定¶
7.6.2.1. UiPath環境の確認¶
UiPathのUiPath OrchestratorとUiPath Studioが利用できる環境を準備します。あらかじめ、 UiPath Orchestratorからプロセスの実行ができることをご確認ください。UiPath Orchestratorはintra-mart Accel Platformサーバとhttpポートで通信できる必要があります。
図：構成イメージ
7.6.2.2. UiPath連携のセットアップ¶
IM-RPA利用ガイドの「UiPath連携」に従って、 intra-mart Accel Platformのセットアップおよび設定ファイルを記載します。詳細は、「セットアップ」を参照してください。
7.6.3. プロセスの作成¶
UiPath Studioにてプロセスを作成します。以下は、プロセスの例です。
図：UiPath Studio作成イメージ
コラム
UiPath Studioを使用したプロセスの作成方法については、 「UiPath Studio ガイド」を参照してください。
7.6.3.1. パラメータの設定¶
上記「①『引数』の設定で、入出力用の引数を設定します」部分でパラメータ設定を行います。
図：UiPath Studio引数の設定イメージコラム
UiPath連携における、双方のパラメータの型は以下のようにマッピングされます。記載以外のパラメータの型については、対応しておりません。
UiPath intra-mart Accel Platform 備考 String <-> String Int32 <-> Integer Boolean <-> Boolean DateTime <-> IMDateTime Double <-> Double
7.6.3.2. アクションの設定¶
上記「②取得したパラメータ同士の計算をするアクティビティを追加します」部分でプロセスのアクションを設定します。「代入」アクティビティを以下のように設定します。
図：UiPath Studioアクティビティの設定 - 「代入アクティビティ」
7.6.3.3. パラメータの設定¶
プロセスで使用する変数のうち、IN/OUTで使用するパラメータについては、 UiPath Studioにて、プロセスの使用する「引数」として設定してください。「変数」に設定した場合、パラメータの連携が行えません。
図：UiPath Studio変数と引数
7.6.4. プロセスのデプロイ¶
UiPath Studioの「パブリッシュ」ボタンを押下し、UiPath Orchestratorにプロセスをアップロードしてください。
図：UiPath StudioプロセスのパブリッシュUiPath Orchestratorにログインし、プロセス画面より先ほどパブリッシュしたプロセスをデプロイしてください。
図：UiPath Orchestratorプロセスをデプロイこの際、入出力パラメータが反映されていることを確認してください。
図：UiPath Orchestrator入力パラメータの確認
コラム
UiPath Orchestratorのフォルダー機能が有効である場合は、動作可能なロボットが紐づいているフォルダーを選択してプロセスをデプロイしてください。
そのフォルダー名は、後ほど「ユーザ定義作成（UiPath定義）」にて指定します。
7.6.5. UiPath Orchestrator上での動作確認¶
UiPath Orchestrator上のジョブで、対象のプロセスを実行し、正常に動作することを確認してください。
図：UiPath Orchestratorジョブの実行UiPathプロセスの作成から動作確認までの具体的な操作の流れについては、動画にてご覧いただけます。
7.6.6. IM-LogicDesignerユーザ定義タスクの準備¶
「ユーザ定義タスク」とは、IM-LogicDesignerにおいて作成可能な、各種機能を持つ独自タスクです。ユーザ定義タスクの具体的な説明については、「IM-LogicDesigner仕様書」 - 「ユーザ定義タスク」を参照してください。本チュートリアルでは、 1つのユーザ定義タスクを用意いたします。
ユーザタスク種別 内容 UiPath定義
7.6.6.1. ユーザ定義作成（UiPath定義）¶
「サイトマップ」→「LogicDesigner」→「ユーザ定義」→「UiPath定義新規作成」をクリックします。UiPath定義を下記のように編集します。UiPath定義カテゴリより、対象のフォルダー、および、プロセスを選択してください。
図：「UiPath定義新規作成」 - 「UiPath定義」ユーザ定義タスク（UiPath定義）の具体的な説明については、「IM-LogicDesigner ユーザ定義説明」を参照してください。プロセスを選択すると、UiPath Orchestratorを介してプロセスに必要な入出力パラメータを自動的に取得し、「入力値」および「返却値」に表示されます。ここで入出力のパラメータを修正する必要はありません。
図：「UiPath定義新規作成」 - 「入力値/出力値」「ユーザ定義名」など適宜設定し、UiPath定義を登録します。
7.6.7. IM-LogicDesignerフローの呼び出し¶
「サイトマップ」→「LogicDesigner」→「フロー定義一覧」→「ロジックフロー新規作成」をクリックします。以下は、UiPath連携（パラメータ使用）を行うための最もシンプルなIM-LogicDesignerフローです。
図：完成イメージ（ロジックフロー）コラム
UiPath Orchestratorのフォルダー機能が有効である場合でも、ユーザ定義タスクを実行するだけであれば、「フォルダー切り替え」タスクを配置せずにフローを実行することが可能です。そのため、このフローでは「フォルダー切り替え」タスクの配置を省略しています。具体的な手順は以下の通りです。
7.6.7.1. タスクとフローを設定します¶
パレットから各タスクを選択し、今回使用するタスクをキャンパスに配置します。前項で作成したユーザ定義は、パレット内の「前項で設定したユーザカテゴリ>作成したユーザ定義名」にあります。
図：IM-LogicDesignerタスク選択配置する各タスクは、以下の通りです。
図：IM-LogicDesigner配置タスク次に、配置したタスク同士をフローで繋ぎます。
7.6.7.2. プロセスに連携するパラメータを設定します¶
IM-LogicDesignerの「入出力設定」を行います。
設定値の説明（入出力設定） カテゴリ 設定値 説明 入力 param1 プロセスに渡す引数1 入力 param2 プロセスに渡す引数2 出力 result プロセスからの返り値 
図：IM-LogicDesigner- 「入出力設定」
7.6.7.3. データマッピングをします¶
各タスクをダブルクリックして、「データマッピング」の設定を行います。各図を参考にマッピングをしてください。プロセス実行タスク（作成したユーザ定義 UiPath定義）のデータマッピングを行います。
図：データマッピングの設定 - プロセス実行タスクログ出力（「汎用タスク」 - 「ログ出力」）のデータマッピングを行います。
図：データマッピングの設定 - ログ出力プロセスの実行結果resultを、フローの出力用変数にマッピングします。
図：データマッピングの設定 - 終了タスク
7.6.7.4. デバッグ実行で動作を確認します¶
ロジックフロー定義編集画面の「デバッグ」をクリックし、作成しているロジックフローをデバッグ実行します。
図：IM-LogicDesigner- 「デバッグ実行」デバッグ画面にて、「実行」をクリックします。デバッグ実行時の入力値の設定を行います。プロセスに引き渡すパラメータとなる、param1とparam2を設定してください。
図：IM-LogicDesigner- 「実行」- 「入出力値の設定」デバッグ実行が正常に完了することを確認します。
図：IM-LogicDesigner- デバッグ実行実行の成功プロセスからの返却値となる、resultが正しく表示されていることを確認します。
図：IM-LogicDesigner- 「フローの変数情報（デバッグ実行後）」
7.6.8. フロールーティングの設定¶
作成したIM-LogicDesignerのフローを、intra-mart Accel Platform他機能やREST経由で実行するため、フロールーティングの設定を行います。ルーティングに対する認可設定も合わせて行ってください。フロールーティングの設定については、「IM-LogicDesigner仕様書」 - 「フロールーティングの認可設定」を参照してください。
図：フロールーティングの設定
7.6.9. フロールーティングの設定¶
作成したIM-LogicDesignerのフローを、intra-mart Accel Platform他機能やREST経由で実行するため、フロールーティングの設定を行います。「サイトマップ」→「LogicDesigner」→「ルーティング定義一覧」→「新規作成」をクリックします。フロールーティングの設定については、「IM-LogicDesigner仕様書」 - 「フロールーティングの認可設定」を参照してください。図：フロールーティングの設定コラム
メソッドには「POST」を選択してください。ロジックフロールーティング定義一覧より「認可」をクリックして、認可設定を行います。「認証済みユーザ」へ実行権限を付与します。
図：認可設定コラム
実運用をする際は適切な権限付与を検討してください。
7.6.10. swaggerで動作確認¶
ロジックフロールーティング定義一覧より「SPEC」をクリックしてswaggerを表示します。swaggerの設定については、「IM-LogicDesigner仕様書」 - 「Swaggerの利用」を参照してください。リクエストbodyを適宜設定し、「Try it out!」をクリックします。
図：swaggerでリクエストを設定リクエストの実行後、レスポンスコードが200で返ること、およびレスポンス内のパラメータresultが想定通りであることを確認してください。
図：swaggerでレスポンスを確認フロールーティングの設定からswaggerでの動作確認の具体的な操作の流れについては、動画にてご覧いただけます。