ライブラリとは、複数の再利用可能なコンポーネントを含むパッケージをいいます。ライブラリは .nupkg ファイルとして保存され、パッケージ マネージャーを使用してワークフローに対する依存関係としてインストールすることができます。

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

再利用可能なコンポーネント アクティビティを管理する

再利用可能なコンポーネントアクティビティとは、.nupkg ファイルとしてまとめてパッケージ化される 1 つ以上のワークフローを指します。

ライブラリを作成する

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

📘

注:

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

[プロパティ] ウィンドウを開き、ライブラリへのツールチップ/ヘルプのリンクを追加します。

新しいアクティビティを追加した後に、[アクティビティ] パネルでヒントが表示されます。選択したアクティビティで F1 キーを押すと、ヘルプ リンクが開きます。

テンプレートを使用して新しいライブラリを作成する際、そのテンプレートに Main.xaml ファイルが含まれていない限り、デザイナーパネルは自動的に .xaml ファイルを開きません。

ライブラリの使用された引数に注釈を追加して、後でアクティビティの [プロパティ] パネルにツールチップとして表示します。引数に注釈を追加する方法についての詳細は、「引数パネル」をご覧ください。

📘

注:

ライブラリの場合には、"" ではなく、変数に NULL 値を割り当てるために Nothing を使用することが推奨されます。これは、パッケージ化されたライブラリをプロジェクトへの依存関係として使用する場合の矛盾を回避するためです。

ライブラリ設定の調整

ライブラリ プロジェクトごとに、一連の設定を個別に作成できます。これらの設定は [プロジェクト設定] ウィンドウで行えます。[プロジェクト設定] ウィンドウを開くには、[プロジェクト] パネルの をクリックします。

[プロジェクト設定] ウィンドウでは、ライブラリの名前と説明を変更できます。[ソースを含む] トグルを [はい] に設定して、生成したアセンブリ ファイル内のすべての.xaml ソース (以前非公開にしていたワークフローを含む) をパッケージ化します。

❗️

重要

重大な変更の発生を防止するために、ライブラリとプロセスでは、同じバージョンの依存関係、または相違が軽微なパッケージ更新の範囲にある依存関係を使用することを強くお勧めします。これは、ライブラリの開発と再利用におけるベスト プラクティスです。
ライブラリを呼び出すプロセスの実行時に System.MissingMethodException が発生する場合は、前述のプロセスで使用されているバージョンに近いバージョンの依存関係を使用してライブラリを再コンパイルする必要があります。

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

1. [デザイン] リボン タブで、[パブリッシュ] を選択します。[ライブラリをパブリッシュ] ウィンドウが表示されます。

2. [パブリッシュする場所] カテゴリで、ライブラリを Orchestrator、カスタム NuGet フィード、またはローカル マシンにパブリッシュするように設定します。API キーを使用して、カスタム NuGet フィードを認証できます。
   ライブラリが Orchestrator にパブリッシュされると、[設定] ページの設定に従って、ホスト フィードまたはテナント フィードに格納されます。ライブラリ フィードについて詳しくは、こちらをご覧ください。

📘

注:

NuGet の制限により、Windows 環境パス変数を使用して、ユーザーが制限したサブフォルダーを含む場所にライブラリをパブリッシュすることはできません。

3. [リリース ノート] カテゴリに、バージョンの詳細とその他の関連情報を入力します。パブリッシュ済みプロジェクトのリリース ノートは、Orchestrator の [パッケージ] セクションに表示されます。[リリース ノート] フィールドには、10,000 文字まで入力できます。
4. プロジェクトに新しいバージョンを追加し、必要に応じて [プレリリース] ボックスのチェックをオンにして、バージョンを alpha としてマークします。これにより、プロジェクトのバージョン スキーマが自動的にセマンティックに変更されます。ファイルの新しいバージョンをローカルにパブリッシュする場合、指定する場所に同じバージョン番号のファイルが含まれていないことを確認してください。プロジェクトのバージョン管理について詳しくは「オートメーション プロジェクトについて」をご覧ください。

📘

注:

NuGet v3 の制約により、パブリッシュされたライブラリのリリース ノートは、Orchestrator でのみ表示されます。

5. [ライブラリ設定] カテゴリで、[アクティビティ ルート カテゴリ] に名前を設定するか、既定のライブラリ名をそのまま使用します。[アクティビティ] パネルで、再利用可能なコンポーネントの新しいカテゴリが作成されます。以前に設定したルート カテゴリはドロップダウン リストに記憶されます。
6. [ソースを含む] の横のチェック ボックスをオンにすると、これまでに非公開になっていたワークフローを含むすべての .xaml ソースが、生成されるアセンブリ ファイル内にパッケージ化されます。必要に応じて、その後アセンブリ ファイルを逆コンパイルして、デバッグ時に役立つ可能性のあるワークフローを抽出できます。
7. [証明書署名] セクションで、[証明書] ボックスの横にローカル証明書のパスを追加します。さらに、必要に応じて、[証明書のパスワード] と [オプションの証明書のタイムスタンパー] を追加します。詳細については、「パッケージの署名」ページをご覧ください。

📘

注:

現在、プロジェクトの署名では、証明書の拡張子として.pfxおよび.p12のみが認められています。

8. [パブリッシュ] を選択します。プロジェクト フォルダー全体が .nupkg ファイルにアーカイブされ、Orchestrator、カスタム NuGet フィードにアップロードされるか、ローカル ディレクトリに保存されます。
9. プロジェクトが正常にパブリッシュされると、[情報] ダイアログが表示されます。これには、次が含まれます。
   • パッケージが Orchestrator またはローカルにパブリッシュされる名前。
   • パブリッシュされたパッケージのバージョン番号
   • プロジェクトがパブリッシュされた場所 (プロジェクトがローカルにパブリッシュされた場合)
   • [クリップボードにコピー] オプション

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

次の制限事項によって、ライブラリ プロジェクトのパブリッシュが阻まれます。

• [分離] オプションが選択された [ワークフロー ファイルを呼び出し] アクティビティを含むライブラリは、パブリッシュできません。[出力] パネルにエラー メッセージが表示されます。
• [ワークフロー ファイルを呼び出し] アクティビティを使用する際には、呼び出されるファイルがライブラリ プロジェクトと同じフォルダーにあることを確認してください。
• [対話型ワークフローを起動] アクティビティはライブラリではサポートされません。
• ライブラリ内で [ワークフロー ファイルを呼び出し] を使用して、そのライブラリ自体を参照する機能はサポートされていません。
• 次の両方の条件が成立する場合、Studio v2019.10.4 からはライブラリをパブリッシュできません。
  1. プロジェクト内部に、ライブラリ名とまったく同じ名前のフォルダーまたは .xaml ファイルがある。
  2. プロジェクトの子フォルダー部分のいずれかに、.xaml ファイルの[ワークフロー ファイルを呼び出し]アクティビティの部分が置かれている。

このようなライブラリをパブリッシュしようとすると、エラー メッセージ Compilation failed or was canceled. が表示され、[出力] パネルには次のエラーが表示されます。

ここでパブリッシュしようとしたプロジェクトを次に示します。

次の 2 つの条件が成立していることがわかります。

• MyLibraryProject フォルダーに、ライブラリ名 MyLibrary と同じ名前のサブフォルダーがある。
• InvokeWorkflow ファイルが InvokingSequence ファイルに属していて、ルート フォルダー MyLibrary に置かれていない。

この問題を解決するには、次の 2 つの例のように、プロジェクト内部で MyLibrary フォルダーの名前を変更するか、InvokingSequence ファイルをルート フォルダーに移動します。

この左側の例では、MyLibrary サブフォルダーの名前を MyLibrary1 に変更しています。右側の例では、[ワークフロー ファイルを呼び出し] アクティビティを収めた .xaml ファイルである InvokingSequence をプロジェクトのルートに移動しています。

• 親フォルダーから起動される .xaml ファイルを含むライブラリは、Studio v2019.10.3 からはパブリッシュできません。
  この問題が発生した場合は、考えられる以下の 2 つの回避策のいずれかを使用してください。

1. 両ファイルを同じフォルダーまたはプロジェクト内の同じレベルに移動したうえで、ライブラリをパブリッシュします。
2. レガシー ライブラリ コンパイラに切り替えます。それには、%ProgramFiles(x86)%\UiPath\Studio\Profiles にある Development.json を開きます。UseLegacyLibraryCompiler フラグについては、値を true に設定します。このファイルには、それ以外の変更は加えないでください。

{
      "name": "UseLegacyLibraryCompiler",
      "value": true
    },

❗️

警告

ここに示した方法以外で Development.json ファイルを手動で編集すると、予期せぬ動作を招く恐れがあります。

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

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

📘

注:

ライブラリには前方互換性があります。つまり、v2018.3 およびそれ以降の Studio で作成したプロジェクトでのみ使用できます。ライブラリは、v2018.3 より前のバージョンの Orchestrator にはパブリッシュできません。

ライブラリ プロジェクトで、[ワークフローをインポート] を使用してライブラリを含むワークフローを追加した場合、そのライブラリで参照される依存関係はインポートされません。