UiPathを導入して実際に動かす詳細手順(Windows10)

RPAへの取り組みについて、弊社的には1年以上前にさかのぼりますが、コンサル部隊で本格的に取り組むきっかけとなったのが、前回の記事「SikuliXを導入してRPAとして動かす詳細手順(Windows10)」でした。

次に取りくんだのが「UiPath」です。

オープンソースのSikuliXと比べて、さすが商用グレードの製品という感じでした。
元ネタは弊社内技術者向けに書いているのですが、その当時の温度感を重視して、体裁をあえてそのままにしました。

Have Fun!

🔰目次

• 1 UiPathとは
• 2 UiPath ソフトウェアの入手
• 3 UiPathで参考になるドキュメント等
• 4 Community Editionのインストール
• 5 notepadを起動してhelloworldとタイプしてみる
• 6 作成されたProjectを確認してみる。
• 7 publish(nupkgファイル)を生成してみる
• 8 コマンドラインから起動してみる
• 9 UiPath Robotから起動してみる
• 10 コマンドラインからUiPathRobotを起動する際に引数inputを利用してargumentに値を渡す
• 11 画像認識で電卓を操作してみる
• 12 総評

🔰UiPathとは

UiPathはRPA(robotics process automation)というカテゴリのソフトウェアです。

RPAは人間がPCで行う作業をソフトが理解できる記述内容に落とし込むことによって、ソフトウェア（ロボット）が記述内容に基づいて人間の代わりに作業を行います。画像認識等の技術を用いて様々なアプリ、ウィンドウの状態を把握し人間と同様に操作する。という機能を有するソフトウェアがRPAと呼ばれているらしい。

ただRPAと言われる機能を満たしていても、あくまでテストツールと言っているSikuliXというOSSが存在したりする。
UiPathはRPAソフトの一つで、概要ページを見るとUiPath RPA Platformという製品群がある。

UiPath RPA Platformにはの下記の３つがあります。

• UiPath Studio(ロボットの処理を記述したプロジェクトの作成が行える開発環境)
• UiPath Orchestrator(作成した処理パッケージを一元管理する管理環境)
• UiPath Robot(UiPathの実行エージェント)

なお、UiPathStudioにはUiPathRobotが含まれています。

🔰UiPath ソフトウェアの入手

一般企業の方は、UiPath Studio無料体験版を60日間有効のフリーライセンスとして提供されています。また、UiPathにはCommunity Editionが用意されており、下記ページに利用するための条件が記載されています。（2017年12月現在）

Free trial or Community

年商100万ドル以下もしくはワークステーション数250台以下の小規模事業者、学術機関、非営利団体なら無償利用可能：

Community エディションの詳細はこちら

Community エディションライセンス契約についての詳細はこちら

これをみて最初弊社では使えないとおもったのですが、こちらの記事がありました。この辺りはご自身で都度最新情報を元に判断して頂くようお願いします。

なお、Community EditionではUiPath Studio(Community Edition)という開発環境が利用できます。(UiPath StudioにはUiPath Robotが含まれているのでこちらも同様に利用できる)

また、UiPathStudio(CommunityEdition)は作成した処理パッケージ(publish)をUiPathOrchestratorに登録できないといった制限があるようですが、
Orchestrator Community Editionが最近出てきたようです。

後述の例は、Community Editionをベースに説明しています。

🔰UiPathで参考になるドキュメント等

• UiPathStudioガイド
• UiPathアカデミー
• UiPathKnowledgeBase
• UiPathForum

UiPathアカデミーは登録すると無料でRPA開発者向け – 基本トレーニング等が受けられる、本当に素晴らしいです。

🔰Community Editionのインストール

※現在不具合により、本ページトライアルリクエストがご利用いただけません。英語ページでリクエストいただくよう、お願い致します。

上記のように2017年12月15日現在記載されているので英語ページからダウンロードを行う。

• Free UiPath Community Edition

上記ページのGET COMMUNITY EDITIONを選択。

必要事項を記載して、REQUEST COMMUNITY EDITIONを選択。

登録完了。登録したメールアドレスにダウンロードパスが送られても来ますが、登録完了ページにもダウンロードリンクが記載されているので今回はこちらからダウンロードします。

ダウンロードしたUiPathStudioSetup.exeを実行してインストール。

インストール中。

UIPathStudioが起動するのでStart Freeを選択。

登録したEmail Addressを入力してActivateを選択。

インストール完了。

🔰notepadを起動してhelloworldとタイプしてみる

ここではnotepadを起動して、Helloworldとタイプする処理を作成してみます。

UiPathStudioを起動した画面でBlankを選択

作成するプロジェクトの情報を入力してCreateを選択

UiPathStudioのDESIGN画面が開きます。
左側のActivitiesパネルからSequenceを選択して、ダブルクリックかドラッグ&ドロップで登録。

これはシーケンス処理を行う際に利用するオブジェクトです。

MainパネルにSequenceが登録されました。

右側にあるPropertiesからプロパティを変更できるのでDisplayNameをhelloworldに変更してみます。
これでSequenceオブジェクトの表示名が変更されました。

notepadを起動するのに左側のActivitiesパネルからStartProcessオブジェクトを選択します。

ツリーの中から探してもいいですし、seachから探す事も出来ます。

StartProcessはその名の通り、プロセスを開始するオブジェクトです。

StartProcess登録したら、起動するプロセスを登録します。
下記赤枠のボタンを押すと選択ダイアログが開きます。

StartProcess登録したら、起動するプロセスを登録します。
下記赤枠のボタンを押すと選択ダイアログが開きます。

ダイアログが開いたらC:\Windows\notepad.exeを選択。

StartProcessに起動するアプリが登録されました。

helloworldとキー入力を行うのに左側のActivitiesパネルからType intoオブジェクトを選択して追加する。
追加した後に、右側にあるPropertiesパネルのtextの入力ボタンを選択する。

入力ポップアップが開くので**”helloworld”と入力してOK**を選択。
ダブルコーテーションで括らないと文字列ではなく変数名として認識されるので注意して下さい。

textに”helloworld”と入力されました。
ポップアップを開かないで、この小窓に直接入力もできます。

このままSAVEしてRUNから実行してもnotepadが起動してhelloworldとタイプされて動きますが、今回はselectorを登録してみます。

selectorはUiPathで各処理を実行する対象を選択するもので。
下記のような形式で記述します。
"<wnp app='notepad.exe' cls='Notepad' title='無題 - メモ帳' />"

• appは実行ファイル名
• clsはウィンドウクラス名
• titleはウィンドウタイトル

上記のselectorをType intoオブジェクトのプロパティselectorに記載すると条件に合致するウィンドウを探してType intoが動作します。
毎回このselectorを手入力で作成するのかというとそうでもなくて。
現在起動しているウィンドウから自動でselectorを生成してくれるツール(UiExplorer)があります。

Launch UiExplorer Selectorsを選択。

UiExplorerを起動すると、現在開いているウィンドウの一覧が出てきます。 

このようにUiExplorerは現在開いているウィンドウのselectorを確認する事ができます。
今回はnotepadのウィンドウのselectorが知りたいのでnotepadを起動して、Resetボタンを選択。

一覧が更新され、notepadが追加されるかと思います。
なお下記の画像ではsearch byでappを選択し、アプリケーション名がnotepadに合致する画面のみ表示している例。

notepad.exeが見つかったら、対象を選択してダブルクリックする。

下記のように右下にselectorが表示されます。
このselectorを控えておきます。

Type intoオブジェクトのプロパティのselector入力ボタンを選択。 

先程控えておいたselectorを入力します。

Type intoオブジェクトのプロパティDisplayNameにtype helloworldと入力する。
これでType intoオブジェクトの表示名が変更されました。

SAVEを選択。 

RUNを選択。 

実行するとnotepadが立ち上がり、helloworldとタイプされます。

🔰作成されたProjectを確認してみる。

Project作成時に指定したディレクトを確認してみる。

• Main.xaml
• project.json

というファイルが作成されています。

どうやらProjectはxamlとjsonで保存されるようです。

🔰publish(nupkgファイル)を生成してみる

UiPathではpublishというnupkgフォーマットのファイルをOrchestratorやrobotに登録して利用する仕組みがあり。
publishを生成してみます。

UiPathStudioのsetupタブにあるpublishを選択。

publishファイルが生成され、格納場所が表示されます。
ちなみにc:\ProgramDataというディレクトリは隠しフォルダです。

該当ディレクトリを確認するとnupkgファイルが生成されています。

🔰コマンドラインから起動してみる

コミュニティにそのものズバリの投稿があるのでコレを参照して実行してみる。

Starting ‘UiPath Studio Community’ process using Command LIne

UiPathRobot.exeに引数fileでxmalファイルを指定すれば動くらしい。

CommunityEditionではUiPathRobotは下記パスに格納されているらしいので確認する。

C:\Users\userName\AppData\Local\UiPath\app-xx.x.xxxx

ありました。

Powershellから下記コマンドを実行。

※userNameとapp-xx.x.xxxxの箇所は各自の環境に合わせて書き換えて下さい。

今回は先程作成した処理を指定したので、notepadが起動してhelloworldとタイプされました。

🔰UiPath Robotから起動してみる

UiPathRobotはコマンドラインからだけでなく、普通に起動してGUIを利用する事もできます。
UiPathRobot.exeを起動するとタスクトレイに下記のように表示される。

該当アイコンをクリックすると下記のような画面が表示される。

ここにはpublishが生成された物が表示されるようです。(C:\ProgramData\UiPath\Packagesをチェックしている模様)

さきほど生成したhelloworldを選択してstartボタンから実行。

実行されました。

🔰コマンドラインからUiPathRobotを起動する際に引数inputを利用してargumentに値を渡す

UiRobot.exeにはinputという引数が存在し、この引数を利用することでUiPath起動時にargumentに値を渡すことができます。

UiRobotの引数input説明

/i: /input
A dictionary of input parameters to the workflow, keyed by argument name
Remarks
The dictionary must be in JSON format and should contain only standard types

今回はinput引数で渡した値をメッセージボックスに表示する処理を作成する。
まずはinputArgumentというblankのプロジェクト作成する。

必要事項を入力してcreateを選択。

Argumentを選択してArgumentパネルを表示する。 

Create Argumentを選択 

下記のように入力して引数inputvalueを定義する。 

左側のActivitiesパネルからMessage Boxを選択して追加

Message BoxのプロパティContentに定義したargument:inputValueを設定する

SAVEを選択

RUNを選択

引数に何も値を入力していないので、空のメッセージボックが表示されます。

Uirobot.exeに作成したプロジェクトをinput引数をつけて実行する。

下記コマンドを実行する。

※userNameとapp-xx.x.xxxxの箇所は各自の環境に合わせて書き換えて下さい。

input引数で指定した値が宣言してargument:inputValueに代入され、メッセージボックスで表示される事が確認できる。

🔰画像認識で電卓を操作してみる

今回はcalcを起動し、ボタンを画像認識で操作するロボットを作成する。

UiPathStudioを起動した画面でBlankを選択

作成するプロジェクトの情報を入力してCreateを選択

Sequenceを登録する。

Start processを設定し、"C:\Windows\System32\calc.exe"を選択する。

ボタンを画像認識でクリックするために、Click imageオブジェクトを登録する。

calcを起動する。(次のステップでボタンを押すための画像認識用必要)

Indicate image on screenを選択する。
選択すると、画像認識に利用する画像を範囲指定して選択するモードとなります。
なおこの時にF2キーを押すと、選択するまでのディレイがかかり選択以外の操作が行える用になります。

下記の図のように電卓の1のボタンを範囲選択します。

範囲選択した画像が、Click imageに登録されました。

SAVEを選択。

RUNを選択。

電卓が起動し1が入力される事が確認できるかと思います。

🔰総評

UiPathはpublishとしてNugetのパッケージ形式であるnupkgを使ったり、projectの保存にxamlを利用したりとなんかMicrosoft社のオープンな技術を多く利用していた。UiPath社はルーマニア発のスタートアップでCEOのDaniel Dinesが元Microsoftの人らしいです。

ともかくオープンな技術を利用していたり、CommunityEditionの存在やアカデミーで無料トレーニングがあったり、フォーラムが存在したりと、他のRPA製品と比較して、かなりオープンに舵を切っているソフトウェアのように思いました。