IM-RPA 利用ガイド 第5版 2021-08-01

IM-RPA 利用ガイド 第5版 2021-08-01

6.5. BizRobo!連携チュートリアル

6.5.1. チュートリアルの概要

本章では、IM-RPAのBizRobo!連携機能を使用して、BizRobo!のロボットを実行する方法をチュートリアル形式でご説明します。
このチュートリアルに沿って設定を行うことで、以下のような機能を実現できます。
  • intra-mart Accel PlatformからIM-LogicDesignerを介してBizRobo!のロボットを実行します。
  • BizRobo!のロボットに対してパラメータを渡し、計算した結果を受け取ります。
本章では、説明を簡単にするために、ロボットのシナリオはシンプルなものにしております。
シナリオの実行イメージは以下の通りです。
../../../_images/bizrobo_tutorial_0_1_1.png
図:本チュートリアルシナリオ実行イメージ

6.5.2. 準備・環境設定

6.5.2.1. BizRobo!環境の確認

BizRobo!のManagement ConsoleとDesign Studioが利用できる環境を準備します。
あらかじめ、 Management Consoleからロボットの実行ができることをご確認ください。
Management Consoleはintra-mart Accel Platformサーバとhttpポートで通信できる必要があります。
../../../_images/bizrobo_tutorial_1_1_1.png
図:構成イメージ

6.5.2.2. BizRobo!連携のセットアップ

IM-RPA利用ガイドの「BizRobo!連携」に従って、 intra-mart Accel Platformのセットアップおよび設定ファイルを記載します。
詳細は、「セットアップ」を参照してください。

6.5.3. ロボットの作成

Design Studioにてロボットを作成します。
以下は、ロボットの例です。
../../../_images/bizrobo_tutorial_2_1_1.png
図:Design Studio作成イメージ

コラム

Design Studioを使用したロボットの作成方法については、 「BizRobo!ナレッジベース」を参照してください。

6.5.3.1. パラメータの設定

上記「①ロボットが使用するIN/OUTパラメータを設定します」部分でパラメータ設定を行います。
先に、ロボットが使用する「タイプ」を作成します。ここでは、作成するタイプを testcal とします。
../../../_images/bizrobo_tutorial_2_1_2.png
図:Design Studioタイプの設定イメージ

コラム

「タイプ」は、BizRobo!のロボットが使用する、複数の変数をまとめたものです。

コラム

BizRobo!連携における、双方のパラメータの型は以下のようにマッピングされます。
記載以外のパラメータの型については、対応しておりません。
BizRobo!   intra-mart Accel Platform 備考
boolean <-> Boolean  
character <-> Character  
date <-> IMDateTime  
Long Text <-> String  
Short Text <-> String  
なお、IM-LogicDesigner側でパラメータを受け取る際に別のデータ型を指定した場合、自動的に型変換をします。
具体的な対応表は、「IM-LogicDesigner仕様書」 - 「IM-LogicDesigner データ型変換 仕様書」を参照してください。
次に、ロボットの「データの状態」より、 testcal タイプを追加します。
変数を追加する際、「パラメータとして使用」にチェックをすることで、パラメータの入出力が可能です。
../../../_images/bizrobo_tutorial_2_1_3.png
図:Design Studioパラメータの設定イメージ

6.5.3.2. アクションの設定

上記「②取得したパラメータ同士の計算をするアクションを追加します」部分でロボットのアクションを設定します。
「変数の割当」アクションを以下のように設定します。
../../../_images/bizrobo_tutorial_2_1_4.png
図:Design Studioアクションの設定 - 「変数の割当」
「③パラメータを返却するアクションを追加します」のアクションを設定します。
「値返却」アクションを以下のように設定します。
../../../_images/bizrobo_tutorial_2_1_5.png
図:Design Studioアクションの設定 - 「値返却」

6.5.4. ロボットのデプロイ

Design Studioの「アップロード」ボタンを押下し、Management Consoleにロボットをアップロードしてください。
../../../_images/bizrobo_tutorial_3_1_1.png
図:Design Studioロボットのデプロイ

コラム

ロボットやタイプは、Management Console上からアップロードすることも可能です。
Management Consoleにて、連携対象のプロジェクトに、ロボット、および変数タイプが登録されていることを確認してください。
../../../_images/bizrobo_tutorial_3_2_1.png
図:Management Console「リポジトリ」 - 「ロボット」
デプロイしたロボットが、Management Console上で正常に動作することを確認してください。
引数を含むロボットは、スケジュール実行で動作を確認します。
../../../_images/bizrobo_tutorial_3_3_1.png
図:Management Console「スケジュール」

コラム

引数を含まないロボットは、リポジトリのロボットを直接実行することも可能です。
Management Consoleの詳しい操作方法については、 「BizRobo!ナレッジベース」を参照してください。
BizRobo!ロボットの作成からデプロイまでの具体的な操作の流れについては、動画にてご覧いただけます。

6.5.5. IM-LogicDesignerユーザ定義タスクの準備

「ユーザ定義タスク」とは、IM-LogicDesignerにおいて作成可能な、各種機能を持つ独自タスクです。
ユーザ定義タスクの具体的な説明については、「IM-LogicDesigner仕様書」 - 「ユーザ定義タスク」を参照してください。
本チュートリアルでは、 1つのユーザ定義タスクを用意いたします。
ユーザタスク種別 内容
BizRobo定義
Management Consoleを介してBizRobo!のロボットを実行します。
実行時に任意のパラメータの送受信を行います。

6.5.5.1. ユーザ定義作成(BizRobo定義)

「サイトマップ」→「LogicDesigner」→「ユーザ定義」→「BizRobo!定義新規作成」をクリックします。
BizRobo定義を下記のように編集します。
BizRobo定義カテゴリより、対象のプロジェクト、およびロボットを選択してください。
../../../_images/bizrobo_tutorial_4_1_1.png
図:「BizRobo定義新規作成」 - 「BizRobo定義」
ユーザ定義タスク(BizRobo定義)の具体的な説明については、「IM-LogicDesigner ユーザ定義説明」を参照してください。
ロボットを選択すると、Management Consoleを介してロボットに必要な入出力パラメータを自動的に取得し、「入力値」および「返却値」に表示されます。
ここで入出力のパラメータを修正する必要はありません。
../../../_images/bizrobo_tutorial_4_1_2.png
図:「BizRobo定義新規作成」 - 「入力値/出力値」
「ユーザ定義名」など適宜設定し、BizRobo定義を登録します。

6.5.6. IM-LogicDesignerフローの呼び出し

「サイトマップ」→「LogicDesigner」→「フロー定義一覧」→「ロジックフロー新規作成」をクリックします。
以下は、BizRobo!連携(パラメータ使用)を行うための最もシンプルなIM-LogicDesignerフローです。
../../../_images/bizrobo_tutorial_5_1_1.png
図:完成イメージ(ロジックフロー)
具体的な手順は以下の通りです。

6.5.6.1. タスクとフローを設定します

パレットから各タスクを選択し、今回使用するタスクをキャンパスに配置します。
前項で作成したユーザ定義は、パレット内の「前項で設定したユーザカテゴリ>作成したユーザ定義名」にあります。
../../../_images/bizrobo_tutorial_5_1_2.png
図:IM-LogicDesignerタスク選択
配置する各タスクは、以下の通りです。
../../../_images/bizrobo_tutorial_5_1_3.png
図:IM-LogicDesigner配置タスク
次に、配置したタスク同士をフローで繋ぎます。

6.5.6.2. ロボットに連携するパラメータを設定します

IM-LogicDesignerの「入出力設定」を行います。
設定値の説明(入出力設定)
カテゴリ 設定値 説明
入力 param1 ロボットに渡す引数1
入力 param2 ロボットに渡す引数2
出力 result ロボットからの返り値
../../../_images/bizrobo_tutorial_5_2_1.png
図:IM-LogicDesigner- 「入出力設定」

6.5.6.3. データマッピングをします

各タスクをダブルクリックして、「データマッピング」の設定を行います。
各図を参考にマッピングをしてください。
ロボット実行タスク(作成したユーザ定義 BizRobo定義)のデータマッピングを行います。
../../../_images/bizrobo_tutorial_5_3_1.png
図:データマッピングの設定 - ロボット実行タスク
ログ出力(「汎用タスク」- 「ログ出力」)のデータマッピングを行います。
../../../_images/bizrobo_tutorial_5_4_1.png
図:データマッピングの設定 - ログ出力
ロボットの実行結果resultを、フローの出力用変数にマッピングします。
../../../_images/bizrobo_tutorial_5_4_2.png
図:データマッピングの設定 - 終了タスク

6.5.6.4. デバッグ実行で動作を確認します

ロジックフロー定義編集画面の「デバッグ」をクリックし、作成しているロジックフローをデバッグ実行します。
../../../_images/bizrobo_tutorial_5_5_1.png
図:IM-LogicDesigner- 「デバッグ実行」
デバッグ画面にて、「実行」をクリックします。
デバッグ実行時の入力値の設定を行います。ロボットに引き渡すパラメータとなる、param1とparam2を設定してください。
../../../_images/bizrobo_tutorial_5_5_2.png
図:IM-LogicDesigner- 「実行」- 「入出力値の設定」
デバッグ実行が正常に完了することを確認します。
../../../_images/bizrobo_tutorial_5_5_3.png
図:IM-LogicDesigner- デバッグ実行実行の成功
ロボットからの返却値となる、resultが正しく表示されていることを確認します。
../../../_images/bizrobo_tutorial_5_5_4.png
図:IM-LogicDesigner- 「フローの変数情報(デバッグ実行後)」

6.5.7. フロールーティングの設定

作成したIM-LogicDesignerのフローを、intra-mart Accel Platform他機能やREST経由で実行するため、フロールーティングの設定を行います。
「サイトマップ」→「LogicDesigner」→「ルーティング定義一覧」→「新規作成」をクリックします。
フロールーティングの設定については、「IM-LogicDesigner仕様書」 - 「フロールーティングの認可設定」を参照してください。
../../../_images/bizrobo_tutorial_5_6_1.png
図:フロールーティングの設定

コラム

メソッドには「POST」を選択してください。
ロジックフロールーティング定義一覧より「認可」をクリックして、認可設定を行います。
「認証済みユーザ」へ実行権限を付与します。
../../../_images/bizrobo_tutorial_5_6_2.png
図:認可設定

コラム

実運用をする際は適切な権限付与を検討してください。

6.5.8. swaggerで動作確認

ロジックフロールーティング定義一覧より「SPEC」をクリックしてswaggerを表示します。
swaggerの設定については、「IM-LogicDesigner仕様書」 - 「Swaggerの利用」を参照してください。
リクエストbodyを適宜設定し、「Try it out!」をクリックします。
../../../_images/bizrobo_tutorial_5_7_1.png
図:swaggerでリクエストを設定
リクエストの実行後、レスポンスコードが200で返ること、およびレスポンス内のパラメータresultが想定通りであることを確認してください。
../../../_images/bizrobo_tutorial_5_7_2.png
図:swaggerでレスポンスを確認
フロールーティングの設定からswaggerでの動作確認の具体的な操作の流れについては、動画にてご覧いただけます。