UiPathのカスタムアクティビティの配置場所について(アクティビティ開発者・UiPath開発者・Robot向け) #VisualStudio

これまで数回 UiPathのカスタムアクティビティを作成してきて、その作成したカスタムアクティビティを社内で共有しようと思ったとき、どのように共有するのがよりよいかをあらためて考えてみました。

全体像

このように「Visual Studioでアクティビティを開発するヒト」と「UiPath Studioで、そのアクティビティを使ったUiPathのシナリオを開発するヒト」そして「そのシナリオをRobotから使うヒト」がいるわけですね。

今回はこれら3つのアクターがカスタムアクティビティのnupkg を共有するために、今回は、.NET系のヒトたちがライブラリを共有するためのサイト、https://www.nuget.org/ を使用してみました。JavaでいうMavenのセントラルリポジトリみたいなもんですね。

全体像(NuGetサイト追記)

NuGetサーバ( https://www.nuget.org/ )を追記した全体像は以下の通り。

Visual Studioでアクティビティを開発するヒト

図中の上のヒトです。カスタムアクティビティをVisual Studioで開発しながらUiPath Studioでデバッグしている工程では、NuGet のサイトを用いるのではなく単純に、Visual Studio(正確にはnuget.exe)がnupkgを配置する場所をUiPath Studioが参照すればよいわけですね。

この場合は、Visual Studio のパッケージマネージャ設定で、ローカルのnupkgが出力されるパスを指定すればUiPath Studioもそこを参照してくれる、ようになっているのでした。

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

したがってカスタムアクティビティの開発者はこれで十分ですが、他のアクターとのnupkgの共有のために、リリースしたいnupkgを NuGetのサイトに公開します。

NuGetサイトへnupkgを公開する

NuGetサイトでのnupkg公開には、NuGetサイトのアカウントの作成と、そのアカウントでnupkgをアップロードする際に必要なAPIキーが必要です。

やってみます。https://www.nuget.org/ へアクセスし、右上の「Sign in」を選択

下図ではMicrosoftアカウントでログインしようとしていますが、まあ、何でもイイのでアカウントを作成してください

アカウントを作成したら、右上部分から「API Keys」を選択してAPI キーの管理画面に遷移します

Createを選ぶと、キーを作成する画面になります。

キーの名前や、そのキーで出来ること(packagesのPushができればじゅうぶん)、Globパタンで「*」(どのパッケージもアップできるって意味。制限することも可能) などを記述して、Create ボタンをクリック

キーが作成できました。このキーは、いま、この画面でしかコピペできないので、どこかにひかえておきましょう。

早速アップロードしてみましょう。カスタムアクティビティはまあ何でもよいんですが、ずっと記事に使ってるカスタムアクティビティを使用します。

NuGetサイトへのアップロードは、nupkgファイルのある場所に移動して、下記のコマンドで行います。

Z:\git\Path\Utils> dotnet nuget push kino.UiPath.Utils.Activities.0.1.30.nupkg 
                     -k [取得したAPIキー] 
                     -s https://api.nuget.org/v3/index.json    (実際は一行で)
info : kino.UiPath.Utils.Activities.0.1.30.nupkg を 'https://www.nuget.org/api/v2/package' にプッシュしています...
info :   PUT https://www.nuget.org/api/v2/package/
info :   Created https://www.nuget.org/api/v2/package/ 12900 ミリ秒
info : パッケージがプッシュされました。

うまくいったようです。アップが完了するとほどなくして(10〜30分くらい？？結構かかる)、NuGetのサイトの Manage packages画面で、

こんな感じに確認することが可能です。

検索も可能になってるはずです。

以上でアップロードは完了しました。改めて図示するとこんな感じですね。

UiPath Studioで、そのアクティビティを使ったUiPathのシナリオを開発するヒト

つづいて、UiPath Studioでカスタムアクティビティをつかったシナリオを開発するヒトです。このアクターは、UiPath Studioが直接 NuGetサイトのフィードを参照してくれれば良いのですが、直接は参照してくれないっぽい¹ので、https://www.nuget.org/ よりnupkgをローカルにダウンロードし、それが展開される場所を UiPath Studioが参照するようにします。

具体的には以下の通り。

まずはNuGetサイトからのGetですが、任意のディレクトリで、下記のコマンドを使用します

C:\Temp> nuget install kino.UiPath.Utils.Activities -Source https://api.nuget.org/v3/index.json
Feeds used:
  https://api.nuget.org/v3/index.json

Installing package 'kino.UiPath.Utils.Activities' to 'c:\Temp'.
  GET https://api.nuget.org/v3/registration3-gz-semver2/kino.uipath.utils.activities/index.json
  OK https://api.nuget.org/v3/registration3-gz-semver2/kino.uipath.utils.activities/index.json 675ms
... 割愛

Successfully installed 'kino.UiPath.Utils.Activities 0.1.30' to c:\Temp
Executing nuget actions took 1.72 sec

c:\Temp>

こうすると、 c:\Temp> にnupkgが配置されると同時に

C:\Users\ユーザ名\.nuget\packages にも、nupkgが展開されます。

実はC:\Users\ユーザ名\.nuget\packagesこちらのディレクトリは、次のアクターのRobotも参照している場所のようなので、UiPath Studioにはこのディレクトリを参照するよう設定します。

UiPath Studio >> Activitiesペインの Manage Packages(段ボールアイコン) >> 右クリックで Configure Sources を選択

追加(プラス)アイコンをクリックして、C:\Users\ユーザ名\.nuget\packages を参照先として追加してOKをクリック。

Package管理画面から、ローカルに展開されたカスタムアクティビティを参照できるようになりました。

改めて図示するとこんな感じです。

今後NuGetサイト上のカスタムアクティビティが更新されたばあいは再度 nuget install コマンドでローカルのファイルを更新して、それからPackage管理画面を開いてください。そこからUpdateすることが可能です。

カスタムアクティビティとそのシナリオをRobotから使うヒト

さて最後は「カスタムアクティビティとそのシナリオをRobotから使うヒト」です。さきほど少し書きましたが、C:\Users\ユーザ名\.nuget\packages はUiPath Robotがデフォルトで参照しているディレクトリでした。従って「アクティビティを使ったUiPathのシナリオを開発するヒト」と同様、NuGetサイトから nupkgをダウンロードして、展開しておくだけで良さそうです。手順は同じで、任意のディレクトリで下記のコマンドを実行します。

C:\Temp> nuget install kino.UiPath.Utils.Activities -Source https://api.nuget.org/v3/index.json

図示するとこう。

参考：UiPathのカスタムアクティビティの配布について(Orchestrator接続なし版)

UiPathのnupkgについては、Orchestratorナシの場合は手動でローカルの所定の場所へ、OrchestratorアリのばあいはOrchestratorから配布してもらいましょう。

まとめると

おつかれさまでした。

カスタムアクティビティのnupkgをどう取得・配置すればよいかについて整理しました。まとめると

「Visual Studioでアクティビティを開発するヒト」→ 開発時は、Visual/UiPath Studio がローカルでnupkgを共有する。配布はNuGetサイトへ
「UiPath Studioで、そのアクティビティを使ったUiPathのシナリオを開発するヒト」→nuget.exeでnupkgをinstallしたのち、UiPath Studioが、所定のディレクトリC:\Users\ユーザ名\.nuget\packagesを参照する
「そのシナリオをRobotから使うヒト」→nuget.exeでnupkgをinstall すれば、Robotが参照している場所に自動的に展開される

という事になりそうです。今回はネット上のNuGetサーバを用いましたが、社内開発みたいな公開したくないアクティビティはイントラ内にNuGetのサーバを構築すればイイってことですかね。

そういえば、UiPathのカスタムアクティビティの配布について(Orchestrator接続あり版) でOrchestratorに接続したロボについて書きましたが、そのパタンではOrchestratorサーバ自体がNuGetサーバになって、Robotはそこからカスタムアクティビティを取得しました。仕組みとしては近しい感じです。。

ちなみに、UiPath Studio 2018.3からは、Package管理画面に https://www.nuget.org/ が設定されているようなので、UiPath Studio 開発者はカスタムアクティビティの取得が少しは楽になりそうですね。(ロボットが https://www.nuget.org/ を参照してて自動ダウンロードしてくれるかは未確認。。)

2018/10/19追記
https://www.nuget.org/ が設定されている、と書きましたが正確には自分で追加したのかも、、、。しかも追加したURLは https://api.nuget.org/v3/index.json でした。ただ、2018.2系ではこのURLの追加は出来なくて(エラーになる)、2018.3系から直接参照できる、ってのは変わりません。。

2018/10/19追記ここまで

ソース

https://github.com/masatomix/UiPath_Path ソース自体はこちら
https://www.nuget.org/packages/kino.UiPath.Utils.Activities/ リリースしたカスタムアクティビティはこちら。

記事目次

UiPath Studioで使用するカスタムアクティビティの作成方法
UiPath Studioで使用するカスタムアクティビティの作成方法つづき(GUI構築)
UiPathのカスタムアクティビティの配布について(Orchestrator接続なし版) ロボがカスタムアクティビティを参照するまで。今回はさらにその共有をNuGetでやってみました
UiPathのカスタムアクティビティの配布について(Orchestrator接続あり版) ロボがカスタムアクティビティをOrchestratorから取得する件。このケースは今回調べた件の派生パタンだったのね
UiPathのカスタムアクティビティの配置場所について(アクティビティ開発者・UiPath開発者・Robot向け) 今回の記事
https://github.com/masatomix/UiPath_Path ソースのMaster Branch

2018/11/12追記 うえにも少し書きましたが、UiPath Studioの2018.3からは、NuGetのプロトコルをそのまま読めるようになった(?)みたいで、Orchestratorに繋いだStudioは、OrchにデプロイしたカスタムアクティビティをStudio上で直接取得できるようになりました。Orchに接続しているロボは直接Orchのフィードを受けていましたが、それと同様の挙動になったって事ですね。さらには、UiPathのカスタムアクティビティの配布について(Orchestrator接続あり版) では、コマンドを使ってカスタムアクティビティをOrchestratorにデプロイしましたが、2018.3のOrchからはアップロードするGUIが追加されましたね、、。(メニューにライブラリという欄が追加されました。) ↩

UiPathのカスタムアクティビティの配置場所について(アクティビティ開発者・UiPath開発者・Robot向け)

全体像