UiPathのアクティビティを自作したい

UiPath Studio 2018.3 Early access - Beta release をさわってみた2 (カスタムアクティビティ) にて、2018.3版から導入される新しいカスタムアクティビティの作成方法をしらべました。そうしたら「既存のアクティビティを呼び出す、アクティビティ」などは簡単に作成できるのですが、たとえば

このような、GUIをもつようなアクティビティはどうやら作成することが出来ないことがわかりました。ってなわけでやっぱり、2018.2までの既存のカスタムアクティビティの作り方は知っておく必要がありそう、となりましたので、整理しておきます。。

ただ、先人の知恵には感謝です。
【UiPath】カスタムアクティビティの作成（事前準備と実践初級）このページに、かなりの情報が整理されていました！！いつも参考にさせていただいています。感謝します！

事前のインストールなど

Visual Studio IDE

https://visualstudio.microsoft.com/ja/vs/ より Visual Studio Community をインストール。2018/10/02現在2017版が最新ぽい。次へ次へでインストールできますが、「個別のコンポーネント」タブで Windows Workflow Foundation を選択することを忘れずに。。

nuget.exe

いわゆる *.nupkg を作成するコマンドラインツール。コレを使って自作アクティビティが入ったDLLをnupkgに格納します。
https://www.nuget.org/downloads よりダウンロードして、任意の場所に解凍しておきましょう。

やってみる

UiPathの出している Creating a Custom Activity コレを追っかけつつ「stringの配列を渡したらWindowsのパスを生成して返してくれる」ようなアクティビティを作ってみます。

こんな感じにWindowsのパスを返してくれます。

Visual Studio 側での作業

Visual Studioでプロジェクトの作成

Visual Studioを起動し、ファイル >> 新規作成 >> プロジェクトを選択

Visual C# >> クラスライブラリ(.NET Framework)を選択

	値
名前	Path
場所	適当で
ソリューション名	Path

としました。Gitで管理したい人は適宜「新しいGitリポジトリの作成」を選択します。

ライブラリの追加

つづいて、アクティビティ作成のためのライブラリの参照を追加します。メニューより、プロジェクト >> 参照の追加を選択し

下記の通り、

名前
System.Activities
System.ComponentModel.Composition

にチェックを入れてOKをクリックします。

アクティビティの追加

さて、アクティビティを追加していきます。ソリューションエクスプローラの「Path」ってなってるアイコンを右クリックして、追加 >> 新しい項目を選択

Workflow >> コードアクティビティを選択。クラス名は「Combine.cs」としました。

C#のソースコードが追加されたと思います。追加したソースは、初期状態は、こんな感じになっています。

Combine.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Activities;

namespace Path
{

    public sealed class Combine : CodeActivity
    {
        // 文字列型のアクティビティ入力引数を定義します
        public InArgument<string> Text { get; set; }

        // アクティビティが値を返す場合は、CodeActivity<TResult> から派生して、
        // Execute メソッドから値を返します。
        protected override void Execute(CodeActivityContext context)
        {
            // テキスト型の入力引数のランタイム値を取得します
            string text = context.GetValue(this.Text);
        }
    }
}

InArgument はこのアクティビティの引数、Execute メソッドはこのアクティビティが実行されたときの処理を記述するメソッドです。

あとでもうすこし整理しますが、とりあえず下記の通り、 OutArgument なプロパティを一つ定義しました。このOutArgument なプロパティは、Executeの実行結果を格納するためのプロパティです。Executeでは InArgumentの値にHello Worldを追記して、OutArgumentにSetしています。

    public sealed class Combine : CodeActivity
    {
        // 文字列型のアクティビティ入力引数を定義します
        public InArgument<string> Text { get; set; }

        public OutArgument<String> result { get; set; }  // 追記

        // アクティビティが値を返す場合は、CodeActivity<TResult> から派生して、
        // Execute メソッドから値を返します。
        protected override void Execute(CodeActivityContext context)
        {
            // テキスト型の入力引数のランタイム値を取得します
            string text = context.GetValue(this.Text);
            result.Set(context, text + " Hello world.");  // 追記

        }
    }

つづいて、GUIクラスを追加します。さきほど同様、ソリューションエクスプローラを右クリックして、追加 >> 新しい項目を選択し、次は、 Workflow >> アクティビティデザイナーを選択します。クラス名は「CombineDesigner.xaml」としました。

下記のようなGUIエディタが起動すると思います。

先ほどのC#のソース Combine.cs に、このXAMLファイルとの紐付けなどをおこなったり、このエディタでUIを構築したりしていきますが、いったんそれらは後回しにして先に進みます。

nupkgに反映されるデータの作成

つづいて、アクティビティが格納されるnupkgの元になる情報を作成していきます。

ソリューションエクスプローラを右クリックしてプロパティを選択

表示される画面で一番うえの「アプリケーション」を選択します。

アセンブリ名: ActivitiesPathUtils とします。ちなみに Creating a Custom Activity ここに

Important!
The NuGet Package Id field must contain the keyword “Activities” to appear in the Manage Packages window, in Studio.

と書いてあるとおり、アセンブリ名は「Activities」という文字列を含んでいる必要があるようです。

2018/10/18追記

上記の通り ActivitiesPathUtils にしたアセンブリ名ですが、https://www.nuget.org/packages/UiPath.Platform.Activities/ にあるライブラリを見た感じだと、ネーミングは kino.UiPath.Utils.Activities
とかのほうが、それっぽいですね。。

2018/10/18追記ここまで

またアセンブリ情報のボタンをクリックし、

項目	値
タイトル	Path Utilities
説明	Path Utilities は、ファイルパスの連結などを行うUtility群です
アセンブリバージョン	0.0.1.0

などと入力しておきます。タイトルとか説明は、まあなんでも結構です。

いったんビルド

ここまでで一度ビルドします。ツールバーの Debug をReleaseへ変更し、

ビルド>>ソリューションのビルドを選択します。

出力(コンソール)のところに、下記のようなActivitiesPathUtils.dll が出力された、的な文言が表示されていればOK。

1>------ すべてのリビルド開始: プロジェクト:Path, 構成: Release Any CPU ------
1>  Path -> Z:\git\Path\Path\bin\Release\ActivitiesPathUtils.dll
========== すべてリビルド: 1 正常終了、0 失敗、0 スキップ ==========

そのバスに実際にDLLが出力されていることを確認しましょう。

nupkgの設定ファイルnuspecの生成

ソースコードを含んだDLLが作成できたので、そのファイルをnupkgにパッケージングしていきますが、そのための設定ファイルをnuget.exeを使って作成します。

具体的には下記の通り、

Z:\git\Path\Path>dir
2018/10/04  18:12    <DIR>          .
2018/10/02  14:46    <DIR>          ..
2018/10/02  14:13               597 CombineDesigner.xaml.cs
2018/10/02  13:58    <DIR>          obj
2018/10/04  16:47    <DIR>          bin
2018/10/02  15:01             1,156 Combine.cs
2018/10/02  15:12             1,473 CombineDesigner.xaml
2018/10/04  17:41    <DIR>          Properties
2018/10/04  17:27             3,525 Path.csproj   ←コレ
2018/10/02  09:49               187 Class1.cs
Z:\git\Path\Path>

.Netのプロジェクトファイル Path.csprojがあるディレクトリに移動して、下記コマンドを実行します。

あ、nuget.exeにはパスを通しておくか、事前準備で配置した場所をフルパス指定してください。

Z:\git\Path\Path> nuget.exe spec Path.csproj
'Path.nuspec' は正常に作成されました。

というメッセージが表示され、下記のようなxmlファイル(Path.nuspec)が作成できたと思います。

<?xml version="1.0"?>
<package >
  <metadata>
    <id>$id$</id>
    <version>$version$</version>
    <title>$title$</title>
    <authors>$author$</authors>
    <owners>$author$</owners>
    <licenseUrl>http://LICENSE_URL_HERE_OR_DELETE_THIS_LINE</licenseUrl>
    <projectUrl>http://PROJECT_URL_HERE_OR_DELETE_THIS_LINE</projectUrl>
    <iconUrl>http://ICON_URL_HERE_OR_DELETE_THIS_LINE</iconUrl>
    <requireLicenseAcceptance>false</requireLicenseAcceptance>
    <description>$description$</description>
    <releaseNotes>Summary of changes made in this release of the package.</releaseNotes>
    <copyright>Copyright 2018</copyright>
    <tags>Tag1 Tag2</tags>
  </metadata>
</package>

コレを書き換えていきますが、結論いうと下記の通り書き換えればOKです。version など、さっき記載したアセンブリ情報のプレースホルダになってる箇所はそのままにしつつ、authorsはプレースホルダがないっぽいので固定的に。xxx_URL_HERE_OR_DELETE_THIS_LINEの箇所はとりあえず行削除。


<?xml version="1.0"?>
<package >
  <metadata>
    <id>$id$</id>
    <version>$version$</version>
    <title>$title$</title>
    <authors>m-kino</authors>   ←固定的に書かないとエラーになるっぽい
    <owners>m-kino</owners>
    <requireLicenseAcceptance>false</requireLicenseAcceptance>
    <description>$description$</description>
    <releaseNotes>Summary of changes made in this release of the package.</releaseNotes>
    <copyright>Copyright 2018</copyright>
  </metadata>
  <files>
    <file src="bin\Release\*.dll" target="lib" />
  </files>
</package>

このうち、

<files>
  <file src="bin\Release\*.dll" target="lib" />
</files>

については、DLLファイルをlibディレクトリ直下に配置せよっていう指示ですが、コレを書かないとUiPath Studioでは参照されない箇所(lib¥net461 っていうディレクトリ配下)にDLLが置かれるっぽく、その対応のためのおまじないです。

正しい対策方法があればしりたいのですが、今回はコレで行きます。ちなみに上記のディレクトリ階層(lib¥net461)は、.Netのバージョン毎にDLLを置くための配慮みたいですね。。

2018/10/18追記
他のヒトの nupkgを見てて、こうやればよさそうってのが分かってきたので整理しました。ちょっと分量があったので、UiPathのカスタムアクティビティのnupkgの作り方(元記事の訂正) にまとめました。
2018/10/18追記ここまで

nupkg作成

ようやくnupkgを作成します。先ほどのディレクトリで、下記の通りコマンドを実行します。

Z:\git\Path\Path> nuget.exe pack Path.csproj -Prop Configuration=Release
'Path.csproj' からパッケージをビルドしています。
MSBuild auto-detection: using msbuild version '15.8.169.51996' from 'C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\MSBuild\15.0\bin'.
'Z:\git\Path\Path\bin\Release' のファイルをパックしています。
メタデータに 'Path.nuspec' を使用しています。
Successfully created package 'Z:\git\Path\Path\ActivitiesPathUtils.0.0.1.nupkg'.
警告: NU5101: The assembly 'lib\ActivitiesPathUtils.dll' is placed directly under 'lib' folder. It is recommended that assemblies be placed inside a framework-specific folder. Move it into a framework-specific folder.
警告: NU5102: The value "Summary of changes made in this release of the package." for ReleaseNotes is a sample value and should be removed. Replace it with an appropriate value or remove it and rebuild your package.

Z:\git\Path\Path>

なんか色々と怒られてますが、Path.nuspec と Path.csproj などに記載している情報を元に、ActivitiesPathUtils.0.0.1.nupkg を作成することが出来たと思います。

遭遇したトラブルとしては、一度ビルドをしないとDLLが見つからないっていうエラーが出る、ソースを修正したあとは、ビルド >> ソリューションのクリーン、と、ビルドをしないと旧DLLがパッケージされちゃう、-Prop Configuration=Release オプションをつけないと、Debugの方のDLLも入れようとしてエラーになっちゃう、などがありましたのでご注意。

2018/10/18追記

ソースを修正したらソリューションのクリーンとビルドをしないと旧DLLがパッケージされちゃう件は「ソリューションのリビルド」でもよさそうです。

2018/10/18追記ここまで

パッケージマネージャのローカルリポジトリの追加

最後に、このnupkgが置かれる場所(今回は Z:\git\Path\Path ってなってます)を、Visual Studioのパッケージマネージャ配置場所として指定します。

このVisual Studioのパッケージマネージャの設定は、Visual Studioに追加機能としてインストールするモジュール達の配布場所を設定する箇所で、URLやローカルのパスを指定することが出来ます。で、この指定はどうやらUiPath Studioと共通になってるぽく、ここに設定するとUiPath Studio側にも追加されます。なのでどっちのStudioでやってもイイのですが、今回はVisual Studio側でやります。

ツール >> NuGet パッケージマネージャ >> パッケージマネージャ設定を選択

パッケージソースを選択、右上のプラスアイコンで、パッケージソースを追加

名前とソース(ファイルパス)を設定します。名前は何でもよく、ソースは、先ほどのnupkgが置かれた場所(Z:\git\Path\Path) を指定しました。で更新をクリックすると

下記の通り、利用可能なパッケージソースに追加されたので、OKをクリックします。

パッケージソースの場所は今回 Z:\git\Path\Path っていう中途半端な場所になりましたが、実運用を考えたパッケージソースの場所は、ちゃんと検討が必要になりそうですね。

以上で、Visual Studioでの作業は完了です。

やったことを整理すると、

Visual Studioでプロジェクトを作成
ソースを作成しビルドしてDLLを生成
DLLをnupkgに入れるための設定ファイルを作成し、nuget.exeで nupkgファイルを作成
nupkgファイルを UiPath Studioへ配布するためのリポジトリの設定

などになります。ソースコードの修正はこの次のサイクルでやるとして、つぎはこのnupkgをUiPath Studioへ配布・インストールしてみます。

UiPath Studio側での作業

UiPath Studioでのnupkgのインストール

UiPath Studioでプロジェクトを開始後、Activities ペインの段ボールっぽいアイコン(Manage Packagesて書いてある)のをクリック。

表示されるダイアログの、Available >> ALL をクリックします。先ほどの nupkgが表示されればOKです。ときおりナゼか表示されないこともあって、上部の検索ボックス(Search in Available)をいじると出てきたり、微妙に不安定な気がしますorz。。

まあ、表示されたら Install をクリックしてnupkgをインストールします。

インストールがうまくいったら、Installed >> ALLをクリックして、下記の通りインストール済みであることを確認してください。

アクティビティの配置

StudioのActivityペインに、インストールしたアクティビティが表示されていると思いますので、ドラッグアンドドロップしてみましょう。

先ほど作成したアクティビティのソースと見くらべてみると、Combine.csで定義したプロパティ:

public OutArgument<String> result { get; set; }
public InArgument<string> Text { get; set; }

が、Studio上のPropertiesに対応しています。

Textに定義された「"こんにちは"」がExecute で

 result.Set(context, text + " Hello world.");

と処理されてresultへセットされ、Studio上でresult 変数に格納され、それをつぎのアクティビティ Write lineでコンソール出力しています。

実行してみると、

うごきましたねーー。。。

いったんまとめ

ひきつづき

C#のコード側でXAMLを指定して、アクティビティとGUIの紐付け
そのGUIをXAMLで構築
パスを連結する実際のロジック作成
バージョンをインクリメントしてnupkgの再パッケージング

などをやりたいのですが、とても長くなったのでまずはここまで。本丸は次回です。。

ソースコード

https://github.com/masatomix/UiPath_Path/tree/0.0.1
に配置しました。

UiPath Studioで使用するカスタムアクティビティの作成方法

目次