通知を受け取る

UiPath Studio

UiPath Studio ガイド

ライブラリについて

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

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

Libraries with the cross-platform compatibility can be installed in cross-platform and Windows projects. Windows - Legacy and Windows libraries can only be installed in processes that have the same compatibility.

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

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

Creating a library

  1. Studio のバックステージ ビュー > [スタート] > [ライブラリ] に移動します。[新しい空のライブラリ] ウィンドウが開きます。
  2. ライブラリの名前を入力し、場所を指定します。既定の場所は C:\Users\<current_user>\Documents\UiPath です。説明を追加し、プロジェクトの対応 OS と言語を選択して、[作成] を選択します。新しいライブラリが作成され、ローカル マシンに保存されます。

📘

注:

  • ライブラリ名は最大 128 文字、説明は最大 500 文字です。
  • lib をライブラリ名として使用しないでください。ライブラリがインストールされているプロジェクトでコンパイル エラーが発生するためです。
  1. [プロジェクト] パネルに、プロジェクト フォルダー、依存関係、実際のワークフローを含むNewActivity.xamlがツリーで表示されます。
    ライブラリ内の各ワークフロー ファイルは、ライブラリが依存関係としてインストールされているプロジェクトのアクティビティとして使用できます。特定のファイルを非公開にする場合は、右クリックして [非公開にする] を選択します。この場合、ファイルはライブラリ パッケージには含められますが、[アクティビティ] パネルで再利用可能なコンポーネントとしては利用できません。

📘

注:

By default, the dependencies available for new libraries are the same as those for new projects with the Lowest Applicable Version runtime rule.

Extracting a project as library

You can extract any process or test automation project as a library to be reused in other projects. For example, you can convert a test automation project to use its templates in other automation projects.

  1. Open a project in Studio.
  2. In the Project panel, right-click the process node, and then select Extract as Library.
297297
  1. Configure the following Extract Options:
    • テスト ケースを含む: 既定では、このオプションはプロセス プロジェクトでは有効化され、テスト オートメーション プロジェクトでは無効化されています。抽出後のライブラリにテスト ケースを含める場合は、このオプションを有効化する必要があります。
    • Publish and install the library: Automatically selected to publish the package to a shared feed and install the library as a project dependency. You can disable this option if you want to create the library without publishing it. If disabled, the remainder options are not available for configuration.
    • Alter your workflows after the package install: Choose to modify the workflows with activities that have been compiled from the library.
      • Replacing Mode: Choose the workflow replacing method.
        Select Replace invoked workflows content to change the workflows invoked from entry point, or test cases with corresponding activities from the extracted library.
        Use this option if you use the Isolated and Target Sessions properties for Invoke Workflow activities to run in a separate Windows process, and start in a different session, respectively.
        [ワークフローを呼び出し] アクティビティを置換] は、[ワークフローを呼び出し] アクティビティを、抽出後のライブラリに含まれるアクティビティに変更する場合に選択します。
        Do not select this option if you are using the Isolated and Target Sessions properties for Invoke Workflow activities.
      • Delete replaced workflows: Delete the workflows that have been replaced by the extracted library activities.
    • Set Execution Templates from library: Add execution templates to the library.
  2. Click Ok to confirm the library options.
584584
  1. Click Create to finish library creation.
451451
  1. (Optional) Publish the library if you've selected Publish and install the library in step 3, and then click Publish.
645645

📘

In case you didn't enable the Publish and install the library option, you'll be prompted to open the library or continue with the current project.

455455

🚧

重要

モック テストを使用しているワークフローでは、抽出後のライブラリによる、ワークフローや呼び出されるアクティビティの置換は実行されません。

アクティビティのレイアウトを設定する

ライブラリで定義した引数が、ライブラリが依存関係としてインストールされているプロジェクトのアクティビティのプロパティになります。

To configure the look and the behavior of an activity when it is used in a project, right-click the workflow file in the library Project panel, and then select Activity Layout. The activity properties window is displayed with different options depending on the library compatibility (Windows - Legacy, Windows, or cross-platform).

916916

Options for Windows and Cross-platform libraries

Select Activity Properties in the left-side menu, and enter the following:

  • Display name - The activity's name displayed in the Activities panel.
  • ツールチップ - ライブラリがインストールされているプロジェクトの [アクティビティ] パネルおよびデザイナー パネル内のアクティビティ上でホバーしたときに表示されるツールチップです。
  • Help Link - The help link that opens when you select the activity in the Designer panel and press F1 on your keyboard.
  • SVG アイコン - アクティビティ名の横に表示する SVG アイコンです。
  • Color - The highlight color displayed for the activity in the Designer panel.

The arguments defined in the workflow file are listed under Activity Properties in the left-side menu.

  • To customize the generated property, select it and configure the following:
    • Display name - The label that appears in the activity for the property.
    • ツールチップ - アクティビティのプロパティ上でホバーしたときに表示されるツールチップです。
    • Input Type - The type of input for the property. You can use the default input for the property type or select an input option depending on the type:
      • Boolean - Toggle (default), Condition builder, Radio button.
      • Numeric (int, double, decimal, long, short, sbyte, byte, ulong, ushort, unit, float) - Number editor.
      • String - Text composer (default), Rich Text composer.
      • String[] - String array.
      • Date Time - Date Time selector.
      • Time Span - Duration selector.
      • Dictionary - Dictionary builder.
      • All other types - Input (expression editor).
    • Placeholder - THE Placeholder text to display for the input when no value is selected.
    • Required - Whether the property is required.
    • Advanced Only - Whether the property should only be displayed in the advanced options section of the activity. Properties from the advanced options section can also be organized in categories.
  • To add a category under which to group multiple related properties, select New Category in the lower-left side of the window. Categories are available only in the advanced options section of the generated activity and can be expanded or collapsed. If a category is empty, it is removed when you click Save to close the window.
  • To change the order of properties and categories, or add properties to categories, drag-and-drop the items in the list.
15431543

Options for Windows - Legacy libraries

Select Activity Properties in the left-side menu and enter the following:

  • ツールチップ - ライブラリがインストールされているプロジェクトの [アクティビティ] パネルおよびデザイナー パネル内のアクティビティ上でホバーしたときに表示されるツールチップです。
  • Help Link - The help link that opens when you select the activity in the Designer panel and press F1 on your keyboard.

The arguments defined in the workflow file are displayed under Activity Properties in the left-side menu.

  • To customize the generated property, select it and configure the following:
    • Display name - The label that appears in the activity for the property.
    • ツールチップ - アクティビティのプロパティ上でホバーしたときに表示されるツールチップです。
    • Required - Whether the property is required.
    • Advanced Only - Whether the property should be displayed only in the Properties panel. If selected, the property is not displayed in the Designer panel for the generated activity.
  • To change the order in which the properties are displayed in the activity, drag-and-drop them in the list.

📘

注:

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

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

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

874874

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

  • 名前 - プロジェクトの名前を編集します。
  • 説明 - プロジェクトの説明を編集します。
  • Automation Hub URL - URL of an Automation Hub idea linked to the project. For more information, see Linking a Project to an Idea in Automation Hub.
  • プロジェクトのアイコン - 必要に応じて、プロジェクトのカスタム アイコンを定義します。ファイルを参照して選択するか、最大 1MB の icojpegjpg、または png ファイルへのパスまたはパブリック URL を入力します。
    プロジェクトがパブリッシュされると、アイコンは Studio の [パッケージを管理] ウィンドウでパッケージの横に表示されます。
  • アクティビティの数式をコンパイル - [はい] に設定すると、ライブラリ内でアクティビティの数式がすべてコンパイルされ、パッケージ化されます。これにより、実行時間が短縮されます。Windows - レガシ ライブラリでのみ使用できます。
  • すぐに実行可能にする - [はい] に設定すると、実行時の JIT コンパイルを高速化するために、生成されるアセンブリを最適化します。Windows - レガシ ライブラリでのみ使用できます。
  • モダン デザイン エクスペリエンス - [はい] に設定すると、UI Automation の操作のモダン エクスペリエンス (向上した新しいアクティビティ、レコーダー、ウィザード、オブジェクト リポジトリなど) が有効化されます。

ライブラリのパブリッシュ

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

Limitations when Using Libraries

When using libraries, take into account the following limitations:

  • NuGet の制約によるもの:
    • Windows 環境パス変数を使用して、ユーザーが制限したサブフォルダーを含む場所にライブラリをパブリッシュすることはできません。
    • パブリッシュされたライブラリのリリース ノートは、Orchestrator でのみ表示されます。
  • 名前に特殊文字を使用している .xaml ファイルが含まれているライブラリは、正常にパブリッシュできない場合があります。
  • ライブラリに同じ名前の .xaml ファイルと引数が含まれる場合、そのライブラリをパブリッシュすることはできません。
  • Library projects with the Windows - Legacy compatibility cannot be published if they contain Invoke Workflow File activities with the Isolated option selected. An error message is displayed in the Output panel when you try to publish. This limitation does not apply to libraries that use the Windows or cross-platform compatibility.
  • [ワークフロー ファイルを呼び出し] アクティビティを使用する際には、呼び出されるファイルがライブラリ プロジェクトと同じフォルダーにあることを確認してください。
  • [対話型ワークフローを起動] アクティビティはライブラリではサポートされません。
  • ライブラリ内で [ワークフロー ファイルを呼び出し] を使用して、そのライブラリ自体を参照する機能はサポートされていません。
  • If a library contains an activity that accepts a file path as input, to ensure the path is resolved correctly in projects where the library is installed, add the UiPath.Constants.Project.Location global constant when referencing the path (use this exact capitalization). This disables changing Environment.CurrentDirectory to the library folder at the start of execution for a library activity and uses the constant instead.
    For example, if a file named Employee.txt located in the InputData subfolder in the library project is used inside a Read File activity, provide the path as follows:
    UiPath.Constants.Project.Location+"InputData\Employee.txt"
    :information-source: Note: The constant must not be used in Invoke Workflow File activities inside libraries.

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

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

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

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

13 日前に更新


ライブラリについて


改善の提案は、API リファレンスのページでは制限されています

改善を提案できるのは Markdown の本文コンテンツのみであり、API 仕様に行うことはできません。