UI Automation のアクティビティ

最終更新日時 2024年12月20日

JS スクリプトを挿入

UiPath.Core.Activities.NInjectJsScript

説明

UiElement に対応する Web ページのコンテキストで JavaScript コードを実行します。

このアクティビティは [アプリケーション/ブラウザーを使用] アクティビティに追加する必要があります。

このアクティビティを [アプリケーション/ブラウザーを使用] アクティビティの外で使用するには、入力要素を指定する必要があります。

このアクティビティはオブジェクトリポジトリに対応しています。

プロジェクトの対応 OS

Windows - レガシ | Windows | クロスプラットフォーム

Windows - レガシ、Windows での設定

デザイナーパネル

[アプリ/ブラウザーで指定] をクリックして、ターゲットとして使用する UI 要素を指定します。

ターゲットを指定したら、メニュー ボタンをクリックします。以下のオプションが表示されます。
- 画面上でターゲットを指定 - ターゲットをもう一度指定します。
- ターゲットを編集 - 選択モードを開いて、ターゲットを設定します。
- 参考スクリーンショットを削除 - 対象のアプリケーションまたは Web ページのスクリーンショットを削除します。
- オブジェクトリポジトリに追加 - 現在の UI 要素をライブラリプロジェクトに追加し、オートメーションプロセス全体で要素を再利用することができます。
スクリプトコード - 実行する JavaScript のコードです。文字列でコードを直接入力できるほか、実行するコードを収めた .js ファイルへのフルパスを追加することもできます。下記の例のように、単一の匿名関数を記述する必要があります。
```
function (element, input) {
    return "result";
}function (element, input) {
    return "result";
}
```
```
async function (element, input) 
{
    const asyncResult = await new Promise((resolvePromiseCb) => 
    {
        const timeoutMs = 100;
        setTimeout(() => 
        {
            resolvePromiseCb("async_result");
        }, 
        timeoutMs);
    });
    return asyncResult;
}async function (element, input) 
{
    const asyncResult = await new Promise((resolvePromiseCb) => 
    {
        const timeoutMs = 100;
        setTimeout(() => 
        {
            resolvePromiseCb("async_result");
        }, 
        timeoutMs);
    });
    return asyncResult;
}
```
ここで、element は呼び出し元の UI ノードに対応する HTML 要素を表し、input は、呼び出し元によって提供される入力文字列を表します。
InputParameter - JavaScript コードの入力データです (文字列または String 型変数)。
スクリプトの出力の保存先 - JavaScript コードの結果の保存場所です。

プロパティパネル

共通

エラー発生時に実行を継続 - アクティビティでエラーが発生した場合でも、オートメーションを継続するかどうかを指定します。このフィールドでは、Boolean 値 (True、False) のみがサポートされています。既定値は False です。そのため、フィールドが空白でエラーが発生すると、プロジェクトの実行が停止します。値を True に設定すると、プロジェクトの実行はエラーに関係なく継続されます。
実行後の待機時間 - 現在のアクティビティが完了してから、次のアクティビティが何らかの操作を開始するまでの遅延時間を秒単位で指定します。既定値は 0.3 秒です。アクティビティとアクティビティの間に遅延を追加すると、次のアクティビティを開始する前に、現在のアクティビティを確実に終了できる時間を確保できます。
実行前の待機時間 - 前のアクティビティが完了してから、現在のアクティビティが何らかの操作を開始するまでの遅延時間を秒単位で指定します。既定値は 0.2 秒です。アクティビティとアクティビティの間に遅延を追加すると、次のアクティビティを開始する前に、現在のアクティビティを確実に終了できる時間を確保できます。
表示名 - デザイナーパネルに表示される、アクティビティの名前です。表示名は、ターゲットを指定すると自動的に生成されます。
タイムアウト - エラーを発生させる前にアクティビティの実行を待機する時間を秒単位で指定します。既定値は 30 秒です。

入力

入力パラメーター - デザイナーパネルの [入力パラメーター] の説明をご覧ください。
スクリプトコード - デザイナーパネルの [スクリプトコード] の説明をご覧ください。
ターゲット - ターゲット要素です。ターゲット要素を設定する必要があります。画面で指定する前は、このフィールドは (null) に設定されています。ターゲットを指定すると、指定した要素に関連するすべてのプロパティが表示されます。
- CV コントロールの種類 - Computer Vision で識別するコントロールの種類を指定します。
- CV テキスト - Computer Vision で識別するテキストを指定します。
- あいまいセレクター - あいまいセレクターのパラメーターです。
- ネイティブテキスト - UI 要素の識別に使用されるテキストです。
- レスポンシブ対応の Web サイト - レスポンシブ対応の Web サイトのレイアウトを有効化します。
- 厳密セレクター - UI 要素に対して生成される厳密セレクターです。
- ターゲットメソッド - 要素の識別に使用するセレクターの種類です。このプロパティには、ドロップダウンメニュー内の任意の組み合わせを設定できます。
  - None
  - 厳密セレクター
  - あいまいセレクター
  - 画像
  - ネイティブテキスト
  - Computer Vision - ターゲットメソッドとして Computer Vision を使用するには、[プロジェクト設定] > [Computer Vision] に移動し、正しいサーバーエンドポイントを設定する必要があります。このフィールドはそのままにして、既定で入力されている「UiPath Cloud」を使用するか、他のパブリックエンドポイントを選択して別の値を入力できます。別の値を入力する場合、サーバーリージョンまたは独自のオンプレミスサーバー専用のエンドポイントを選択します。
    Computer Vision をターゲットメソッドとして使用するもう 1 つの方法は、[ローカルサーバーを使用] を [True] に設定することです。これは、UiPath.ComputerVision.LocalServer パッケージがプロジェクトにインストールされていることを意味します。ローカルサーバーが有効な場合、サーバーの値は上書きされます。ただし、ローカルサーバーはクロスプラットフォームプロジェクトでは利用できません。
- 可視性を確認 - UI 要素が表示されているかどうかを確認します。ドロップダウンメニューの次の 3 つのオプションのいずれかを選択できます。
  - なし - 可視性を確認しません。
  - 対話型 (あいまいセレクター用) - 既定のオプションです。要素が表示される可能性があるかどうかを確認します。確認時、ページをスクロールしないと表示されない、他のアプリで隠れている、アプリケーションが最小化されているという点は無視されます。この確認は、DOM に存在するものの表示されていない非表示の要素をターゲット要素として設定しないようにする場合に便利です。
  - 完全に表示されている - UI 要素が表示されるかどうかを確認します。
- ページの読み込みを待機 - アプリケーションが入力を受け入れる準備が完了するまで、アクションの実行を待機します。ドロップダウンメニューの次の 3 つのオプションのいずれかを選択できます。
  - なし - ターゲットの準備ができるまで待機しません。
  - 対話型 - アプリの一部のみが読み込まれるまで待機します。
  - 完了 - アプリ全体が読み込まれるまで待機します。
- ウィンドウセレクター (アプリケーションインスタンス) - アプリケーションウィンドウに使用されるセレクターです。[ウィンドウアタッチモード] が [アプリケーションインスタンス] に設定されている場合にのみ適用されます。

入力/出力要素

入力要素 - アクティビティの実行対象となる UI 要素で、UIElement オブジェクトに保存されます。このフィールドでは UIElement オブジェクトのみがサポートされています。このオブジェクトは、他の UI Automation アクティビティの [出力要素] プロパティフィールドから取得できます。
出力要素 - ターゲット UI 要素を出力して、UIElement オブジェクトに保存し、他のアクティビティで同じ要素をターゲットとして使用できるようにします。

その他

プライベート - オンにすると、変数および引数の値が Verbose レベルでログに出力されなくなります。このフィールドでは、Boolean 値 (True、False) のみがサポートされています。既定値は False です。

オプション

実行環境 - スクリプトを実行する JavaScript 環境です。ドロップダウンメニューから、以下の 2 つのオプションのいずれかを選択します。
- Isolated - スクリプトは HTML 要素にはアクセスできますが、ページ変数やページコードにはアクセスできません。スクリプト実行がページと競合しないようにする場合は、このオプションを使用します。これが既定の選択です。
- Page - スクリプトは HTML 要素、ページ変数、ページコードにアクセスできます。ページ変数 (例: jQuery $) へのアクセス、またはページコードの操作 (例: window.alert) が必要な場合は、このオプションを使用します。MV3 拡張機能に固有の既知の問題を修正するには、このオプションを使用する必要があります。
すべての [JS スクリプトを挿入] アクティビティの [実行環境] プロパティは、[プロジェクト設定] から変更できます。

出力

スクリプトの出力 - JavaScript コードから返される文字列の結果です。

クロスプラットフォームでの設定

画面上でターゲットを指定 - ターゲットとして使用する UI 要素を指定します。

ターゲットを指定したら、プラスボタンをクリックします。以下のオプションが表示されます。
- 画面上でターゲットを指定 - ターゲットをもう一度指定します。
- ターゲットを編集 - 選択モードを開いて、ターゲットを設定します。

スクリプトコード - 実行する JavaScript のコードです。文字列でコードを直接入力できるほか、実行するコードを収めた .js ファイルへのフルパスを追加することもできます。下記の例のように、単一の匿名関数を記述する必要があります。

function (element, input) {
    return "result";
}function (element, input) {
    return "result";
}

async function (element, input) 
{
    const asyncResult = await new Promise((resolvePromiseCb) => 
    {
        const timeoutMs = 100;
        setTimeout(() => 
        {
            resolvePromiseCb("async_result");
        }, 
        timeoutMs);
    });
    return asyncResult;
}async function (element, input) 
{
    const asyncResult = await new Promise((resolvePromiseCb) => 
    {
        const timeoutMs = 100;
        setTimeout(() => 
        {
            resolvePromiseCb("async_result");
        }, 
        timeoutMs);
    });
    return asyncResult;
}

ここで、element は呼び出し元の UI ノードに対応する HTML 要素を表し、input は、呼び出し元によって提供される入力文字列を表します。

その他のオプション

タイミング

実行前の待機時間 - 前のアクティビティが完了してから、現在のアクティビティが何らかの操作を開始するまでの遅延時間を秒単位で指定します。既定値は 0.2 秒です。アクティビティとアクティビティの間に遅延を追加すると、次のアクティビティを開始する前に、現在のアクティビティを確実に終了できる時間を確保できます。
実行後の待機時間 - 現在のアクティビティが完了してから、次のアクティビティが何らかの操作を開始するまでの遅延時間を秒単位で指定します。既定値は 0.3 秒です。アクティビティとアクティビティの間に遅延を追加すると、次のアクティビティを開始する前に、現在のアクティビティを確実に終了できる時間を確保できます。
タイムアウト - エラーを発生させる前にアクティビティの実行を待機する時間を秒単位で指定します。既定値は 30 秒です。
エラー発生時に実行を継続 - アクティビティでエラーが発生した場合でも、オートメーションを継続するかどうかを指定します。このフィールドでは、Boolean 値 (True、False) のみがサポートされています。既定値は False です。そのため、フィールドが空白でエラーが発生すると、プロジェクトの実行が停止します。値を True に設定すると、プロジェクトの実行はエラーに関係なく継続されます。

オプション

実行環境 - スクリプトを実行する JavaScript 環境です。ドロップダウンメニューから、以下の 2 つのオプションのいずれかを選択します。
- Isolated - スクリプトは HTML 要素にはアクセスできますが、ページ変数やページコードにはアクセスできません。スクリプト実行がページと競合しないようにする場合は、このオプションを使用します。これが既定の選択です。
- Page - スクリプトは HTML 要素、ページ変数、ページコードにアクセスできます。ページ変数 (例: jQuery $) へのアクセス、またはページコードの操作 (例: window.alert) が必要な場合は、このオプションを使用します。MV3 拡張機能に固有の既知の問題を修正するには、このオプションを使用する必要があります。
すべての [JS スクリプトを挿入] アクティビティの [実行環境] プロパティは、[プロジェクト設定] から変更できます。

出力

スクリプトの出力 - JavaScript コードから返される文字列の結果です。

入力/出力

入力要素 - アクティビティの実行対象となる UI 要素で、UIElement オブジェクトに保存されます。このフィールドでは UIElement オブジェクトのみがサポートされています。このオブジェクトは、他の UI Automation アクティビティの [出力要素] プロパティフィールドから取得できます。
出力要素 - ターゲット UI 要素を出力して、UIElement オブジェクトに保存し、他のアクティビティで同じ要素をターゲットとして使用できるようにします。