UiPathには、標準でたくさんのアクティビティが用意されています。
また、追加で公式・コミュニティまたは他の企業からあらゆるアクティビティを追加することもできます。
一方で、独自の機能に対応させるために自分だけのためにカスタマイズしたアクティビティを作成したいということがあります。
今回は、そのような要望のためにUiPathのアクティビティを開発する方法を記載します。
事前準備をするもの
開発するにあたり次の２つのソフトウェアが必要になります。
UiPtah Studio・Robotはすでに導入している前提となります。
- Microsoft Visual Studio
- NuGetPackageExplorer
どちらのソフトウェアも個人利用であれば、無料で利用する事ができます。
URLよりダウンロードしインストールをしてください。
Microsoft Visual Studio
NuGetPackageExplorer
開発の流れ
開発の流れは次のとおりとなります。
- Visual Studio で処理コード（C#）を記述
- NuGetPackageExplorerで.dllファイルからNugetパッケージを作成
- UiPath Studioからインストール
なれてしまえば特に複雑な処理は必要なく作業となります。
「コード書いて、パッケージ作ってインストールするんだな」くらいの感覚で問題ありません。
開発のサンプル
早速ですが、開発を始めますがその前に、今回の手順通りに作成したものが実際のアクティビティとしてどのように反映されるのか確認をしてみてください。
下記に今回の作成サンプルの貼り付けています。
「この名称を反映させるには、ここで入力すればいいんだ」という感覚を掴む参考としてください。
では、次から実際に開発手順となります。
Visual Studio で処理コード（C#）で記述
Visual Studio を起動します。
[ファイル] > [新規] > [プロジェクト] をクリックしプロジェクト作成画面を開きます。
左ペインから[Visual C#] を選択し、表示された中央のペインから[クラス ライブラリ (.NET Framework)] を選択します。
[名前] フィールドには、今回のプロジェクトの名前を入力します。
開発後のカスタムアクティビティの名称を記入しておくことをおすすめします。
入力が出来たら、[OK] をクリックします。
プロジェクト開発画面が起動します。
右側の【Solution Explorer】には、今回の開発材料が一覧になって表示されます。
ここでUiPathで利用可能なアクティビティを開発するために、追加で次の２つの参照を追加する必要があります。
- System.Activities
- System.ComponentModel.Composition
先程つけた名前と同一の名称のフォルダを選択し、右クリックをします。
[追加] > [参照の追加]を選択します。
すると、【Reference Mnager】の新しいウィンドウが開きます。
右上の検索欄にそれぞれ入力し、右側のチェックボックスにチェックを入れます。
“System.Activities”を検索し、右側にチェックします。
“System.ComponentModel.Composition”を検索し、右側にチェックします。
２つともチェックが出来たら[OK]を選択します。
では、早速コードに記述をしていきます。
まず、先程加えた参照を使えるようにします。
次の画像のように、using・・・で参照を追加します。
ここで、開発するカスタムアクティビティはUiPathで利用可能な”CodeActivity”クラスに準拠していなければなりません。
そのため、それを明示しておきます。
次の画像のように”CodeActivity”を記述してください。
また、デフォルトでは（【Solution Explorer】」およびコード上）クラス名が”Class1″となっていると思います。
この名称が、UiPathのアクティビティのデフォルトの名称となります。
そのため、この名称を変更することでUiPath上で表示されるアクティビティ名を変更する事ができます。
イメージが難しい場合、前段の開発のサンプルのところを参照にしてみてください。
“CodeActivity”に必要な”Excute”コードを追加しましょう。
ここから実際のコードの記述となります。
簡単にですが、記述方法を解説します。
UiPathのアクティビティは、インプットとアウトプットの引数（変数）とそれらを利用して行う処理から成り立っています。
それらを記述する必要がありますが、記述を行う場所はそれぞれで異なります。
まず、引数（変数）ですが、これらは”Class”〜”Execute”の間に、インプット・アウトプットどちらも記述をしてしまいます。
また、インプット・アウトプットを定義しているのはコード中の”InArgument”と”OutArgument”という単語です。
処理については、”Execute”の枠内に記述をします。
引数（変数）へアクセスするときは、getとsetを基本は利用します。
コードの記述が完了したら、ビルドをします。
[Build] > [Build “プロジェクト名”] をクリックします。
すると、開発したコードを反映した.dll ファイルが作成されます。
これでVisual Studioでの作成は終了です。
.dllファイルからNugetパッケージを作成
NuGet Package Explorer（NuGetPackageExplorer.exe）を起動します。
起動後ポップアップが表示されるので、[Create a new package]を選択します。
パッケージ作成画面が表示されるので、まだ何を置かれていない右側の【Package contents】欄で右クリックをし、[Add Lib Folder]を選択します。
すると、新しく [lib]フォルダが作成されます。
次に[lib]フォルダを右クリックして、[Add Existing File…] を選択します。
ここで、先程Visual Studioで開発した.dllファイルを選択してください。
問題なくファイルを選択し、[lib]フォルダ内に格納できたら、作成パッケージの名称を設定します。
[Edit] > [Edit Metadata] をクリックします。
【Package metadata】ペインが左側に表示されると思います。
多くの設定項目がありますが、基本必要な項目は一番上の【Id】となります。
これも、Studioの画面に表示されるものとなるため、適切な名前をつけるようにしてください。
公式では下記のような記述がありますが、なしでもインストールまで可能なようです。
NuGet パッケージ [Id] フィールドには、Studio の [Manage Packages] ウィンドウに表示するキーワード「Activities」を含める必要があります。
UiPath公式
【Id】の入力が完了したら、保存をします。
このあとUiPath Studioで読み取りフォルダをしてするひつようがあるため、デフォルトの保存場所がわからない方は、名前を付けて保存でフォルダをしてしてください。
これで、NuGet Package Explorerでの設定も完了です。
あとは、UiPath Studioからインストールをしてみましょう。
UiPath Studioからインストール
UiPath Studioへのインストールは、他のカスタムアクティビティのインストールと同様の方法で行うことができます。
唯一必要なのは参照パスの設定になります。
UiPath Studioの上部ペインから、【パッケージを管理】をクリックします。
これは、任意ですが、パッケージソースの参照先を設定します。
みなさんが、一番参照の際に楽なフォルダを設定することをおすすめします。
私は、とりあえず【ダウンロード】フォルダはインストール上楽なので設定しています。
先程開発したファイルが表示されたら、選択し右側の[インストール]を選択します。
その後、[保存]をクリックしプロジェクト作成画面を開きます。
これでインストールが完了しました。
自分の開発したアクティビティが表示されていることを確認してみてください。
まとめ
今回は、UiPath Studioへ利用出来るカスタムアクティビティの開発について記事にしてみました。
いかがだったでしょうか？
おそらく想像していたより簡単に感じられたのではないかと思います。
高度な処理を実装しようとするとC#の知識やコードの記述の知識など別のスキルが必要になります。
RPAからはじめたけど、コードも書いてみたいという方はUiPathとのシナジーを考慮しC#の勉強を始めてみてはいかがでしょうか。
もし、疑問点や質問がありましたらコメントへお願いします。
では。
