はじめに
※2020/7/29に再投稿
本書は #UiPathFreiensdの@ShumpeiWatanabeさんが始められた
「UiPathブログ ブログ発信チャレンジ」への投稿になります。
（https://twitter.com/ShumpeiWatanabe/status/1281173891189059585）
ブログなんて書いたことないし、UiPathなんてしばらく実務で使っていなかったので、何書けばいいんだろうと思いましたが、今実務でメインにつかっている「SharePoint」との連携を書けばいいんじゃないかということで書いてみました。
少し機能の掘り下げが甘いですが、これを機に徐々に追記してゆきます
UiPath SharePoint Custom Activities Packageとは
UiPathには様々な追加パッケージがUiPath社や、同社が運営するUiPath connect マーケットプレイス（ https://connect.uipath.com/ja/marketplace/components ）から提供されています。表題のパッケージもその一つで、マーケットプレイスもしくは、UiPath本体の「パッケージ管理」から導入することができます。
名前の通り、MicrosoftのSharePointを操作するActivity群です。
マーケットプレイス、パッケージ管理どちらからインストールしてもいいのですが、マーケットプレイスは英語ながらもドキュメントが添付されていますので、最初はマーケットプレイスを読んで、実際のインストールはパッケージ管理からインストールしたほうがいいでしょう。
【マーケットプレイス】https://connect.uipath.com/ja/marketplace/components/sharepoint-custom-activities-package
※記事の時点のバージョンは 1.5.2
※UiPathの社員さんがリリースしているようですが、会社としてのサポートはないようです。英語ですが、質問ができるようです。
インストール
実際にインストールしてみます。
UiPathのパッケージ管理画面を開いて、connectチャネルを選択し、「SharePoint」で検索してみてください。
２つ以上検索されますので、「UiPathTeam.SharePoint.Activiteies」を選択してください。
インストールを続行すると、依存性のチェック画面が出てくるので、「OK」でインストールを完了させてください。
インストールが完了すると、以下のアクテビティが追加されています。
アクテビティについて
アクテビティは大きく４つにカテゴライズされます
| 分類 | 説明 |
|---|---|
| ライブラリ関連 | ファイルを格納するライブラリを操作するアクテビティ群です |
| リスト関連 | 簡易データベースのListを操作するアクテビティ群です |
| パーミッション関連 | 上記ライブラリやListのパーミッションを操作するアクテビティ群です |
| ユーザー関連 | ユーザーの権限関連の操作を行うアクテビティ群です |
今回はList操作にについて説明します。
アイテムの追加、参照、削除、更新の４つの機能について説明します。
※リストやライブラリ、ユーザーを作成する機能はありません
ワークフローへの記載
ワークフローへの記載は以下の通りとなります。
SharePointアプリケーションスコープの配置
まず、ワークフローにSharePoint Aplication scope を配置します。SHarePointとの接続を行う部分です。
必要な情報は以下の３点です
- SharePointサイトのURL
- ユーザー名
- パスワード
※実行に当たり、ユーザーに対して実際のSharePointの操作権限が付与されている必要があります
コンポーネントの配置
次に実際に操作するコンポーネントを配置してゆきます。
SharePoint Application Scopeの「Do」スコープに配置してゆきます。
※Doスコープから外れると、接続が維持できなくなりますのでご注意ください
ADD List Item アクテビティ
リストにアイテムを追加するアクテビティです。
リスト名と追加アイテム値をセットします。追加アイテム値は項目名とデータをキーペアとした辞書（Dictionary）型である必要があります。
キーとなる項目名は内部名である必要があり、かつ大文字／小文字を区別しますのでご注意ください。
【実際のワークフローの例】
SharePointに下記のようなリストがあるとします
※上記リストのタイトルの内部列名は「Title」、valie1は「value1」です。
それぞれに項目を追加するワークフローは以下の通りです。
これで、タイトルに「タイトル」をvalue1に「バリュー１」と入力するワークフローができました。
【実行結果】
Get List Item アクテビティ
リストの値を取得アクテビティです。
リスト名とデータを選択するためのCAMLクエリ、出力先の変数（DataSet型かもしくはDictionary型）を設定します
CAMLクエリーを設定しない場合は全件取得します。
CAMLクエリーを簡単に作りたい場合はこちら＞ https://qiita.com/TwToshiya/items/beee89f00ec94ce10baf
※本アクテビティのマニュアルに紹介されているツールを紹介しました
DELETE List Item アクテビティ
リストアイテムを削除するアクテビティです
これも対象リストと、削除したい条件式をCAMLクエリーで設定します。
クエリーを空で指定すると全件削除になります。
いちおう、ガードとして、プロパティの「AllowOperationOnAllItems」にチェックを入れないと、CAMLクエリーを空白値とすることを許さない仕様になっています。
UPDATE List Item アクテビティ
リストを更新するためのアクテビティです
こちらは少し変わっていて、変更したいリスト名を指定するのは今までと同様なのですが、変更する特定を対照するためのCAMLクエリーと更新するための項目名と項目地のペアの辞書（Dictionary）型変数をセットする必要があります。
最後に
駆け足でSharePoint Custom Activitiesを紹介してみましたが、いかがだったでしょうか？
「SharePointの操作ならPower Auromateがあるじゃないか」とおっしゃる方。ごもっとです。
しかしながら、オンプレミスのSharePoint等でPower Automateが適用できない場合や、UiPathの一連処理の流れで最後にSharePointにデータを格納したい場合など、UiPathを使用するほうが適切といったケースもあると思いますので、この方法を参考してみてはいかがでしょうか？
ちなみに、StudioXにもパッケージのインストールはできましたが、辞書型変数の生成ができないため、取り扱いは難しいかもしれません。
ご拝読ありがとうございました。