- リリース ノート
- 基本情報
- セットアップと構成
- オートメーション プロジェクト
- 依存関係
- ワークフローの種類
- 制御フロー
- ファイルの比較
- オートメーションのベスト プラクティス
- ソース管理との連携
- デバッグ
- ログ
- 診断ツール
- ワークフロー アナライザー
- ワークフロー アナライザーについて
- ST-DBP-002 - 多数の引数
- ST-DBP-003 - 空の catch ブロック
- ST-DBP-007 - 複数のフローチャートレイヤー
- ST-DPB-010 - [ワークフロー] または [テスト ケース] の複数のインスタンス
- ST-DBP-020 - 未定義の出力プロパティ
- ST-DBP-021 - ハードコードされたタイムアウト
- ST-DBP-023 - 空のワークフロー
- ST-DBP-024 - 永続性アクティビティの確認
- ST-DBP-025 - 変数のシリアル化の前提条件
- ST-DBP-026 - [待機] アクティビティの使用
- ST-DBP-027 - Persistence のベスト プラクティス
- ST-DBP-028 - 引数のシリアル化の前提条件
- 変数
- 引数
- インポートされた名前空間
- コード化されたオートメーション
- トリガーベースの有人オートメーション
- レコーディング
- UI 要素
- セレクター
- オブジェクト リポジトリ
- データ スクレイピング
- 画像とテキストの自動化
- Citrix Technologies Automation
- RDP の自動化
- VMware Horizon の自動化
- Salesforce の操作の自動化
- SAP のオートメーション
- macOS の UI Automation
- ScreenScrapeJavaSupport ツール
- Webdriver プロトコル
- 拡張機能
- Test Suite - Studio
- トラブルシューティング
ライブラリについて
ライブラリとは、他のプロジェクトでアクティビティとして再利用できる 1 つ以上のワークフローを含むプロジェクトです。ライブラリはパブリッシュ時に nupkg ファイルとして保存され、パッケージ マネージャーから依存関係としてインストールできます。
「基本のライブラリを作成する」に記載されているように、たとえば、Excel スプレッドシートからデータを収集して他のシートに追加するライブラリを作成できます。さらに、このライブラリをパッケージ化して他のプロセスでアクティビティとして使用できます。
任意のプロセスまたはテスト オートメーション プロジェクトをライブラリとして抽出して、他のプロジェクトで再利用できます。たとえば、テスト オートメーション プロジェクトを変換して、そのテンプレートを他のオートメーション プロジェクトで使用できます。
ライブラリで定義した引数が、ライブラリが依存関係としてインストールされているプロジェクトのアクティビティのプロパティになります。
アクティビティをプロジェクトで使用するときの外観と動作を設定するには、ライブラリの [プロジェクト] パネルでワークフロー ファイルを右クリックして、[アクティビティのレイアウト] を選択します。アクティビティのプロパティ ウィンドウに、ライブラリの対応 OS (Windows - レガシ、Windows、クロスプラットフォーム) に応じて、さまざまなオプションが表示されます。
左側のメニューで [アクティビティのプロパティ] を選択し、以下を入力します。
- 表示名 - [アクティビティ] パネルに表示されるアクティビティの名前です。
- ツールチップ - ライブラリがインストールされているプロジェクトの [アクティビティ] パネルおよびデザイナー パネル内のアクティビティ上でホバーしたときに表示されるツールチップです。
- ヘルプ リンク - デザイナー パネルでアクティビティを選択してキーボードの F1 キーを押したときに開くヘルプ リンクです。
- SVG アイコン - アクティビティ名の横に表示する SVG アイコンです。
- 色 - デザイナー パネル内のアクティビティの強調表示色です。
ワークフロー ファイルで定義されている引数は、左側のメニューの [アクティビティのプロパティ] に表示されます。
-
生成されたプロパティをカスタマイズするには、プロパティを選択し、次のように設定します。
- 表示名 - アクティビティに表示されるプロパティのラベルです。
- ツールチップ - アクティビティのプロパティ上でホバーしたときに表示されるツールチップです。
-
入力の種類 - プロパティの入力の種類です。プロパティのデータ型の既定の入力オプションを使用するか、データ型に応じて入力オプションを選択できます。
- Boolean - [既定]、[トグル (既定)]、[条件ビルダー]、[ラジオ ボタン] を使用します。
- 数値 (int、double、decimal、long、short、sbyte、byte、ulong、ushort、unit、float) - 既定値を使用、数値エディター、ドロップダウン。ドロップダウンの場合、[値] フィールドでキーボードの Enter を押して、個別の各値を入力します。
- 文字列 - 既定値を使用、テキスト作成ツール (既定)、リッチ テキスト作成ツール、ドロップダウン、オートコンプリート、ラジオ ボタン。ドロップダウン、オートコンプリート、ラジオ ボタンの場合、[値] フィールドでキーボードの Enter を押して、個別の各値を入力します。
- String[] - 既定値を使用、文字列配列。
- 日付時刻 - 既定値を使用、日付と時刻。
- 期間 - 既定値を使用、期間。
- ディクショナリ - 既定値を使用、ディクショナリ。
- その他すべての種類 - 既定値を使用、入力。
- プレースホルダー - 入力データの値が選択されていない場合に表示するプレースホルダー テキストです。
- 必須 - このプロパティを必須にするかどうか。
- 詳細設定にのみ表示 - プロパティをアクティビティの [詳細オプション] セクションにのみ表示するかどうか。[詳細オプション] セクションのプロパティは、カテゴリで整理することもできます。
- 複数の関連プロパティをグループ化するためのカテゴリを追加するには、ウィンドウの左下の [新しいカテゴリ] を選択します。カテゴリは、生成されたアクティビティの [詳細オプション] セクションでのみ利用可能で、展開または折りたたむことができます。カテゴリが空の場合、[保存] をクリックしてウィンドウを閉じると、そのカテゴリは削除されます。
-
プロパティやカテゴリの順序を変更したり、プロパティをカテゴリに追加したりするには、リスト内で項目をドラッグ アンド ドロップします。
- ライブラリに Integration Service のアクティビティが含まれるまたは Integration Service アクティビティが含まれるワークフローが呼び出される場合、これらのアクティビティで使用されるコネクションとその他のアクティビティ プロパティは、アクティビティのレイアウトを設定する際に個別のエンティティとして表示されます。Integration Service のコネクションやプロパティを並べ替えて分類したり、プロパティの表示名やツールチップを編集したりできます。
注:
- コード化されたワークフローを呼び出すワークフローを呼び出した場合、コネクションとプロパティの構成が機能しない場合があります。
-
コネクションを使用するライブラリ アクティビティが含まれるプロセスでは、そのライブラリに属しておらず、同じコネクションを利用するアクティビティをプロセスに追加すると、2 番目のアクティビティによってライブラリ アクティビティの設定が上書きされます。
左側のメニューで [アクティビティのプロパティ] を選択し、以下を入力します。
- ツールチップ - ライブラリがインストールされているプロジェクトの [アクティビティ] パネルおよびデザイナー パネル内のアクティビティ上でホバーしたときに表示されるツールチップです。
- ヘルプ リンク - デザイナー パネルでアクティビティを選択してキーボードの F1 キーを押したときに開くヘルプ リンクです。
ワークフロー ファイルで定義されている引数は、左側のメニューの [アクティビティのプロパティ] に表示されます。
-
生成されたプロパティをカスタマイズするには、プロパティを選択し、次のように設定します。
- 表示名 - アクティビティに表示されるプロパティのラベルです。
- ツールチップ - アクティビティのプロパティ上でホバーしたときに表示されるツールチップです。
- 必須 - このプロパティを必須にするかどうか。
- 詳細設定にのみ表示 - プロパティを [プロパティ] パネルにのみ表示するかどうか。選択すると、そのプロパティは、生成されたアクティビティのデザイナー パネルには表示されません。
-
アクティビティ内でのプロパティの表示順序を変更するには、リスト内でプロパティをドラッグ アンド ドロップします。
注:- ライブラリの場合には、
""
ではなく、変数に NULL 値を割り当てるためにNothing
を使用することが推奨されます。これは、パッケージ化されたライブラリをプロジェクトへの依存関係として使用する場合の矛盾を回避するためです。 System.Activities.ActivityBuilder
オブジェクトの ImplementationVersion プロパティはサポートされていません。このプロパティの値を設定すると、引数が保存されません。[デザイナー] パネルの空白領域を選択すると、このオブジェクトが [プロパティ] パネルに表示されます。
- ライブラリの場合には、
ライブラリ プロジェクトの設定を行うには、[プロジェクト] パネルで [設定] をクリックして、[プロジェクト設定] ウィンドウを開きます。
[全般] タブで、以下のオプションを利用できます。
- 名前 - プロジェクトの名前を編集します。
- 説明 - プロジェクトの説明を編集します。
- プロジェクト タグ - 新しいタグを作成するか、Orchestrator で既に定義されているタグを再利用して、1 つ以上のタグをプロジェクトに追加できます。タグにはラベルとプロパティ (キーと値のペア) の 2 種類があります。タグはパブリッシュされるパッケージに含まれており、プロジェクトの説明と分類に役立ちます。詳しくは、「オートメーション プロジェクトについて」をご覧ください。
- Automation Hub URL - プロジェクトにリンクされている Automation Hub のアイデアの URL です。詳しくは、「プロジェクトを Automation Hub のアイデアにリンクする」をご覧ください。
-
パッケージのアイコン - 必要に応じて、プロジェクトのカスタム アイコンを定義します。ファイルを参照して選択するか、最大 1MB の
ico
、jpeg
、jpg
、またはpng
ファイルへのパスまたはパブリック URL を入力します。プロジェクトがパブリッシュされると、アイコンは Studio の [パッケージを管理] ウィンドウでパッケージの横に表示されます。
- アクティビティの数式をコンパイル - [はい] に設定すると、ライブラリ内でアクティビティの数式がすべてコンパイルされ、パッケージ化されます。これにより、実行時間が短縮されます。Windows - レガシ ライブラリでのみ使用できます。
- すぐに実行可能にする - [はい] に設定すると、実行時の JIT コンパイルを高速化するために、生成されるアセンブリを最適化します。Windows - レガシ ライブラリでのみ使用できます。
- 実行時の依存関係を分離 - ロボットのパフォーマンスを向上させ、パブリッシュしたパッケージのサイズを縮小するため、ライブラリはデザイン パッケージとランタイム パッケージに分離されています。Studio ではデザイン パッケージが使用され、Robot ではスリムな実行パッケージが使用されます。
- ソースを含める - これまで非公開になっていたワークフローを含むすべての
.xaml
ソースをライブラリ パッケージに含めるには、[はい] に設定します。Windows - レガシ ライブラリの場合、ファイルは生成されるアセンブリ ファイル内、およびlib\net45
フォルダーの.nupkg
ファイル内に保存されます。Windows およびクロスプラットフォームのライブラリの場合、ファイルはcontent
フォルダーの.nupkg
ファイル内に保存されます。
- 設計時パッケージと実行時パッケージが分離されているため、Studio 2023.4 でパブリッシュしたカスタム ライブラリは、以前のバージョンの Studio との互換性は保証されません。
- 設計時パッケージはパブリッシュ時にランタイム パッケージに置き換えられるため、プロジェクトには設計時パッケージのみをインストールできます。ランタイム パッケージのみをインストールすると、Studio で予期しない問題が発生します。
- 2023.10.0 以降の Studio で設計時パッケージとランタイム パッケージが分離されるのは、以下の場合のみになります。
- コンパイル プロセス中に
ViewModels.dll
ファイルが生成される。ViewModels.dll
ファイルは、ライブラリ内の少なくとも 1 つのワークフロー ファイルに対して ViewModel アクティビティのプロパティを設定するときに、Windows ライブラリおよびクロスプラットフォーム ライブラリに対して生成されます。 - [実行時の依存関係を分離] オプションが有効化されている。
- コンパイル プロセス中に
ライブラリを使用するときは、以下の制限事項を考慮してください。
-
NuGet の制約によるもの:
- Windows 環境パス変数を使用して、ユーザーが制限したサブフォルダーを含む場所にライブラリをパブリッシュすることはできません。
- パブリッシュされたライブラリのリリース ノートは、Orchestrator でのみ表示されます。
- 名前に特殊文字を使用している
.xaml
ファイルが含まれているライブラリは、正常にパブリッシュできない場合があります。 - ライブラリに同じ名前の
.xaml
ファイルと引数が含まれる場合、そのライブラリをパブリッシュすることはできません。 - [ワークフロー ファイルを呼び出し] アクティビティが含まれ、[分離] オプションが選択されている場合、Windows - レガシ対応のライブラリ プロジェクトをパブリッシュすることはできません。パブリッシュしようとすると、[出力] パネルにエラー メッセージが表示されます。この制限は、Windows またはクロスプラットフォーム対応のライブラリには適用されません。
- [ワークフロー ファイルを呼び出し] アクティビティを使用する際には、呼び出されるファイルがライブラリ プロジェクトと同じフォルダーにあることを確認してください。
- [対話型ワークフローを起動] アクティビティはライブラリではサポートされません。
- ライブラリ内で [ワークフロー ファイルを呼び出し] を使用して、そのライブラリ自体を参照する機能はサポートされていません。
-
ファイル パスを入力として受け入れるアクティビティがライブラリに含まれる場合、ライブラリがインストールされているプロジェクトでパスが正しく解決されるよう、パスを参照する場合はグローバル定数 UiPath.Constants.Project.Location を追加します (大文字と小文字を完全に一致させてください)。これにより、ライブラリ アクティビティの実行開始時に
Environment.CurrentDirectory
からライブラリ フォルダーへの変更が無効化され、代わりに定数が使用されます。たとえば、ライブラリ プロジェクトの InputData サブフォルダーにある Employee.txt という名前のファイルが [ファイルを読み込み] アクティビティ内で使用されている場合は、次のようにパスを指定します。
UiPath.Constants.Project.Location+"InputData\Employee.txt"
注: この定数は、ライブラリ内の [ワークフロー ファイルを呼び出し] アクティビティでは使用しないでください。 - ライブラリがインストールされているプロジェクト フォルダーの場所を参照するには、ライブラリへのパスを引数として渡します。
- 新しいプロジェクトを開くか、作成します。
- [すべてのパッケージ] カテゴリで、ライブラリを保存するフィードを選択し、パッケージをインストールします。
- [OK] を選択します。パッケージがプロジェクト定義に追加されます。
- [アクティビティ] パネルのカスタム カテゴリに、このアクティビティが表示されます。
プロジェクトへのライブラリのインストールに関する考慮事項
- クロスプラットフォーム対応のライブラリは、クロスプラットフォーム プロジェクトと Windows プロジェクトにインストールできます。Windows - レガシ ライブラリと Windows ライブラリは、対応 OS (バージョン) が同じプロセスにのみインストールできます。
- 2019.10.1 以前のバージョンの Studio で作成したライブラリおよび 2019.10.1 以降のバージョンの Studio からパブリッシュしたライブラリから、カスタム アクティビティを含むプロジェクトを実行すると、エラーが発生する可能性があります。その場合は、もう一度ライブラリを作成してパブリッシュする必要があります。
- [ワークフローをインポート] を使用してライブラリを含むワークフローをライブラリ プロジェクトに追加した場合、そのライブラリで参照される依存関係はインポートされません。
- 同じカスタム ライブラリの 2 つのバージョンをプロジェクトにインポートすると、2 番目にインポートしたライブラリにのみ含まれるカスタム アクティビティは、最初にインポートしたライブラリを削除しないかぎり、[アクティビティ] パネルに表示されません。
-
ライブラリ名にピリオド (
.
) を使用すると、[アクティビティ] パネルでは、ライブラリが入れ子になったグループに分割されて表示されます。