【UiPath】カスタムアクティビティを開発する

Last updated on 2021年12月31日

どうも、エピックです。
UiPath のアクティビティって自分で作ることができるって知ってますか？
標準でさまざまな利用目的に合わせてアクティティビティが用意されているため（必要性は低いのですが）自分で作ることができます。
今回はちょっとマニアックな内容となりますがUiPathのアクティビティを開発する方法を説明していきます。

Contents

1 事前準備するもの
2 開発の流れ
3 開発サンプル
4 おまけ：Visual Studio からパッケージを発行する
5 最後に

事前準備するもの

開発するにあたり次の２つのソフトウェアが必要になります。

UiPtah Studio/ Robotはすでに導入している前提となります。

Microsoft Visual Studio
NuGetPackageExplorer　※現在は不要です→[おまけ_参照

どちらのソフトウェアも個人利用であれば、無料で利用する事ができます。

リンク先のURLよりダウンロードしインストールをしてください。

※すみませんがインストール手順は省略します

開発の流れ

開発の手順は次のようになります。

Visual Studio で処理コード（C#）を記述
NuGetPackageExplorerで.dllファイルからNugetパッケージを作成
UiPath Studioからインストール

コードの記述については、C#を利用します。

開発サンプル

サンプルでは次のようなアクティビティを開発します。

アクティビティで行う処理は非常に単純で２つの数字を受け取り平均（足して２で割る）を求める処理を行うというものです。

Visual Studioでプロジェクトを作成する際、いくつかパラメータを設定するのですがこれらが実際のアクティビティの名称やパラメータに反映されます。

こちらもサンプルを載せておくの確認してみてください。

Visual Studio で処理コード（C#）で記述

Visual Studio を起動します。

[ファイル] > [新規] > [プロジェクト] をクリックしプロジェクト作成画面を開きます。

左ペインから[Visual C#] を選択し、表示された中央のペインから[クラスライブラリ (.NET Framework)] を選択します。

[名前] フィールドには、今回のプロジェクトの名前を入力します。

[Solution name] と書かれた箇所が開発後のグループ名（アクティビティをまとめた単位）となるのでわかりやすい名称をつけるように気をつけてください。

入力が出来たら、[OK] をクリックします。

プロジェクト開発画面が起動します。

右側の【Solution Explorer】には、今回の開発材料が一覧になって表示されているのを確認してください。

ここで、UiPathで利用可能なアクティビティを開発するために、追加で次の２つの参照を追加する必要があります。

System.Activities
System.ComponentMode

先程つけた名前と同一の名称のフォルダを選択し、右クリックをします。

[追加] > [参照の追加]を選択します。

【Reference Mnager】の新しいウィンドウが開きますので、右上の検索欄に先程の２つの参照名をそれぞれ入力し、右側のチェックボックスにチェックを入れます。

まず、”System.Activities”を検索し、右側にチェックします。

次に、”System.ComponentModel”を検索し、右側にチェックします。

２つともチェックが出来たら[OK]を選択します。

※ 画像は System.ComponentModel.Compositionとなっています。

と、準備が終わりましたので、ようやくコードの記述を行っていきます。

先程加えた参照を使えるようにしましょう。

次の画像のように、using・・・で参照を追加します。

using System.Activities;
using System.ComponentModel;

加えて開発するカスタムアクティビティはUiPathで利用可能な”CodeActivity”クラスに準拠していなければなりません。

そのため、それを明示しておきます。

次の画像のように”CodeActivity”を記述してください。

エラーとなると思いますが、必要メソッド（Execute()）の実装不足であるため今は無視して問題ありません。

public class Class1 : CodeActivity
{

}

次に処理の内容を記述していきます。

UiPathのアクティビティは、インプットとアウトプットの引数（変数）とそれらを利用して行う処理から成り立っています。

これらをを記述していきますが、それぞれ記述する場所が決まっていますので注意してください。

まず、引数（変数）ですが、これらは”Class”〜”Execute”の間に、インプット・アウトプットどちらも記述をします。

インプット・アウトプットを定義しているのはコードの”InArgument”と”OutArgument”という単語です。

処理については、”Execute()”の枠内に記述をします。

引数（変数）へアクセスするときは、getとsetを基本は利用します。

では、まず引数を記述してみます。

今回は、２つの数字を受け取りますので、２つの InArgument 、そして計算した結果を返すので一つの OutArgument となります。

// 1つ目の数字
[Category("Input")]
[RequiredArgument]
public InArgument<Int32> FirstNumber { get; set; }

// 2つ目の数字
[Category("Input")]
[RequiredArgument]
public InArgument<Int32> SecondNumber { get; set; }

// 平均の結果
[Category("Output")]
[RequiredArgument]
 public OutArgument<Int32> ResultNumber { get; set; }

続いて、処理を記述します。

Execute() メソッドを定義し、その中に下記のコードを記述します。

protected override void Execute(CodeActivityContext context)
{
    int firstNumber = FirstNumber.Get(context);
    int secondNumber = SecondNumber.Get(context);

    int resultNumber = (firstNumber + secondNumber) / 2;

    ResultNumber.Set(context, resultNumber);
}

最終的なイメージは次のようになります。