ライブラリについて

ライブラリとは、他のプロジェクトでアクティビティとして再利用できる 1 つ以上のワークフローを含むプロジェクトです。ライブラリはパブリッシュ時に nupkg ファイルとして保存され、パッケージマネージャーから依存関係としてインストールできます。

「基本のライブラリを作成する」に記載されているように、たとえば、Excel スプレッドシートからデータを収集して他のシートに追加するライブラリを作成できます。さらに、このライブラリをパッケージ化して他のプロセスでアクティビティとして使用できます。

ライブラリを作成する

Studio のバックステージビュー > [スタート] > [ライブラリ] に移動します。[新しい空のライブラリ] ウィンドウが開きます。
ライブラリの名前を入力し、場所を指定します。既定の場所は C:\Users\<current_user>\Documents\UiPath です。説明を追加し、プロジェクトの対応 OS と言語を選択して、[作成] を選択します。新しいライブラリが作成され、ローカルマシンに保存されます。
注:
- ライブラリ名は最大 128 文字、説明は最大 500 文字です。
- lib をライブラリ名として使用しないでください。ライブラリがインストールされているプロジェクトでコンパイルエラーが発生するためです。
[プロジェクト] パネルに、プロジェクトフォルダー、依存関係、実際のワークフローを含む NewActivity.xaml がツリーで表示されます。

ライブラリ内の各ワークフローファイルは、ライブラリが依存関係としてインストールされているプロジェクトのアクティビティとして使用できます。特定のファイルを非公開にする場合は、右クリックして [非公開にする] を選択します。この場合、ファイルはライブラリパッケージには含められますが、[アクティビティ] パネルで再利用可能なコンポーネントとしては利用できません。

注: 既定では、新しいライブラリで使用可能な依存関係は、[最も低い適用可能なバージョン] のランタイムルールが適用される新しい空のプロジェクト、すなわち、UiPath.Excel.Activities、UiPath.Mail.Activities、UiPath.System.Activities、UiPath.UIAutomation.Activities と同じです。

アクティビティにツールチップとヘルプリンクを追加するには、[プロジェクト] パネルでワークフローファイルを右クリックして、[プロパティ] を選択します。ライブラリがインストールされているプロジェクトの [アクティビティ] および [デザイナー] パネルで、アクティビティにカーソルを合わせると、ツールチップが表示されます。[デザイナー] パネルでアクティビティを選択して F1 を押すと、ヘルプリンクが開きます。

ライブラリで定義した引数が、ライブラリが依存関係としてインストールされているプロジェクトのアクティビティのプロパティになります。必須としてマークされた引数は、デザイナー パネルでアクティビティの本体として使用できます。ライブラリで引数に追加した注釈が、生成されたアクティビティの [プロパティ] パネルにプロパティのツールチップとして表示されます。引数の詳細については、「引数パネル」をご覧ください。

注:

ライブラリの場合には、"" ではなく、変数に NULL 値を割り当てるために Nothing を使用することが推奨されます。これは、パッケージ化されたライブラリをプロジェクトへの依存関係として使用する場合の矛盾を回避するためです。
System.Activities.ActivityBuilder オブジェクトの ImplementationVersion プロパティはサポートされていません。このプロパティの値を設定すると、引数が保存されません。[デザイナー] パネルの空白領域を選択すると、このオブジェクトが [プロパティ] パネルに表示されます。

ライブラリ設定を調整する

ライブラリプロジェクトの設定を行うには、[プロジェクト] パネルで [設定] をクリックして、[プロジェクト設定] ウィンドウを開きます。

[全般] タブで、以下のオプションを利用できます。

名前 - プロジェクトの名前を編集します。
説明 - プロジェクトの説明を編集します。
Automation Hub URL - プロジェクトにリンクされている Automation Hub のアイデアの URL です。詳しくは、「プロジェクトを Automation Hub のアイデアにリンクする」をご覧ください。
プロジェクトのアイコン - 必要に応じて、プロジェクトのカスタムアイコンを定義します。ファイルを参照して選択するか、最大 1MB の ico、jpeg、jpg、または png ファイルへのパスまたはパブリック URL を入力します。

プロジェクトがパブリッシュされると、アイコンは Studio の [パッケージを管理] ウィンドウでパッケージの横に表示されます。
ソースを含める - これまで非公開になっていたワークフローを含むすべての .xaml ソースをライブラリパッケージに含めるには、[はい] に設定します。Windows - レガシライブラリの場合、ファイルは生成されるアセンブリファイル内、および lib\net45 フォルダーの .nupkg ファイル内に保存されます。Windows およびクロスプラットフォームのライブラリの場合、ファイルは content フォルダーの .nupkg ファイル内に保存されます。
アクティビティの数式をコンパイル - [はい] に設定すると、ライブラリ内でアクティビティの数式がすべてコンパイルされ、パッケージ化されます。これにより、実行時間が短縮されます。Windows - レガシライブラリでのみ使用できます。
すぐに実行可能にする - [はい] に設定すると、実行時の JIT コンパイルを高速化するために、生成されるアセンブリを最適化します。Windows - レガシライブラリでのみ使用できます。
モダンデザインエクスペリエンス - [はい] に設定すると、UI Automation の操作のモダンエクスペリエンス (向上した新しいアクティビティ、レコーダー、ウィザード、オブジェクトリポジトリなど) が有効化されます。

ライブラリをパブリッシュする

ライブラリのパブリッシュはプロセスのパブリッシュと似ています。詳細については、「オートメーションプロジェクトのパブリッシュについて」をご覧ください。

ライブラリをパブリッシュする際の制限事項

ライブラリをパブリッシュするときは、以下の制限事項を考慮してください。

NuGet の制約によるもの:
- Windows 環境パス変数を使用して、ユーザーが制限したサブフォルダーを含む場所にライブラリをパブリッシュすることはできません。
- パブリッシュされたライブラリのリリースノートは、Orchestrator でのみ表示されます。
名前に特殊文字を使用している .xaml ファイルが含まれているライブラリは、正常にパブリッシュできない場合があります。
ライブラリに同じ名前の .xaml ファイルと引数が含まれる場合、そのライブラリをパブリッシュすることはできません。
[ワークフローファイルを呼び出し] アクティビティが含まれ、[分離] オプションが選択されている場合、Windows - レガシ対応のライブラリプロジェクトをパブリッシュすることはできません。パブリッシュしようとすると、[出力] パネルにエラーメッセージが表示されます。この制限は、Windows またはクロスプラットフォーム対応のライブラリには適用されません。
[ワークフローファイルを呼び出し] アクティビティを使用する際には、呼び出されるファイルがライブラリプロジェクトと同じフォルダーにあることを確認してください。
[対話型ワークフローを起動] アクティビティはライブラリではサポートされません。
ライブラリ内で [ワークフローファイルを呼び出し] を使用して、そのライブラリ自体を参照する機能はサポートされていません。
ファイルパスを入力として受け入れるアクティビティがライブラリに含まれている場合、プロジェクトでコンポーネントが使用される際に、環境変数を含むパスはライブラリフォルダーへの相対パスとして解釈されます。回避策として、Environment.GetEnvironmentVariable メソッドまたは [特殊フォルダーのパスを取得] アクティビティを使用してフォルダーパスを取得し、この出力を使用して再利用可能なコンポーネントに渡す絶対パスを作成します。
プロジェクトでライブラリのフォルダー内に配置されたワークフローファイルを名前空間として使用している場合、ライブラリのフォルダー名を変更しライブラリを再パブリッシュした後にプロジェクトでインストールすると、不明なアクティビティが発生します。

再利用可能なコンポーネントをオートメーションプロジェクトに追加する

新しいプロジェクトを開くか、作成します。
[すべてのパッケージ] カテゴリで、ライブラリを保存するフィードを選択し、パッケージをインストールします。
[OK] を選択します。パッケージがプロジェクト定義に追加されます。
[アクティビティ] パネルのカスタムカテゴリに、このアクティビティが表示されます。

プロジェクトへのライブラリのインストールに関する考慮事項

ライブラリは、対応 OS が同じプロジェクトにのみインストールできます。
クロスプラットフォームライブラリに UI Automation アクティビティを伴うワークフローが含まれている場合、生成されたアクティビティをクロスプラットフォームプロジェクトに追加すると、プロジェクトの実行時に検証エラーが発生します。
2019.10.1 以前のバージョンの Studio で作成したライブラリおよび 2019.10.1 以降のバージョンの Studio からパブリッシュしたライブラリから、カスタムアクティビティを含むプロジェクトを実行すると、エラーが発生する可能性があります。その場合は、もう一度ライブラリを作成してパブリッシュする必要があります。
[ワークフローをインポート] を使用してライブラリを含むワークフローをライブラリプロジェクトに追加した場合、そのライブラリで参照される依存関係はインポートされません。
同じカスタムライブラリの 2 つのバージョンをプロジェクトにインポートすると、2 番目にインポートしたライブラリにのみ含まれるカスタムアクティビティは、最初にインポートしたライブラリを削除しないかぎり、[アクティビティ] パネルに表示されません。