Language Reference

1.はじめに

1.1 目的

このドキュメントは、T-Plan Robot がサポートするスクリプト言語の完全な仕様を提供します。 その目的は、このツールとそのテストフレームワークを使用して自動化スクリプトを書く人に、完全な構文と機能のリファレンスを提供することです。スクリプト言語はJavaスクリプトAPIと緊密に連携しているため、Javaスクリプトの設計における補完的な機能リファレンスとしても意図されています。
この文書で説明されている言語のスクリプトはTPRスクリプトと呼ばれる。Java Script APIに基づくスクリプトはJavaスクリプトと呼ばれる本ドキュメントで定義される言語によるスクリプトはTPRスクリプトと呼ばれます。Java Script APIに基づくスクリプトはJavaスクリプトと呼ばれます。
本ドキュメントでは、スクリプトの要件、解析および処理ルール、言語構造、ならびに文、式、コマンド、画像比較メソッドなどの特定要素の構文について記述します。

1.2 概要

T-Plan Robot は、自動化スクリプトを記述するためのシンプルなスクリプト言語をサポートしています。これは Linux/Unix のシェルスクリプトにやや似た、構造化された手続き型言語です。以下のような、現代のプログラミング言語でよく知られた構造や要素をサポートしています：

• 変数(グローバルとローカルの両方）、

• 数値演算および論理式式、

• 手続きパラメータを持つ実行とインクルードコマンドと組み合わせて、関数やサブルーチンのライブラリを作成することができます、

• ループや条件構造言語リファレンスそしてif/else,

• 一連の機能コマンド数値戻り値.

T-Plan Robotは、ほとんどの一般的なリモートおよびローカルデスクトップ技術で動作するように設計されているため、スクリプト言語がサポートするコマンドは、おおよそ4つの機能領域に分類されます：

1. デスクトップコマンドデスクトップへの接続や切断、マウスやキーボードの入力（キーを押す、テキストを入力する、マウスを動かす、クリックする、ドラッグする、ホイールする）などのクライアントとサーバー間の通信を行います。

2. 管理および実行制御コマンドスクリプトの実行制御（一時停止、停止、デスクトップ画像解析、指定時間または特定のイベントの待機）に必要なインフラストラクチャを提供し、変数、ライブラリ、外部OSコマンドコールをサポートします。

3. レポートコマンド自動テストの出力を定義し、ユーザーに報告します。このカテゴリのコマンドでは、たとえば、デスクトップ画像またはその一部のスクリーンショットを撮影したり、レポートを作成したり、電子メールを送信したり、関連するテスト管理ツールに結果をアップロードしたりすることができます。

4. I/O コマンドさまざまなデータソースからの入力やデータソースへの出力を扱います。

一部のコマンドの動作は、ユーザー設定によってカスタマイズされる場合があります。このようなパラメータは実装固有のものであり、必ずしもこのドキュメントの一部を構成するものではありません。設定可能な値があるかどうかを調べるには、T-Plan Robot GUIのPreferencesウィンドウを開き、Pluginsセクションの下にコマンド設定パネルがあるかどうかを確認してください。スクリプト言語は高速で簡単な自動化の方法を提供しますが、機能が限られており、オブジェクト指向のアプローチに欠けています。このため、T-Plan Robot バージョン 2.0 では Java Script API を導入し、このリファレンスで指定されたコマンドの機能にアクセスするメソッドの呼び出しを通じて、純粋な Java でスクリプトを記述できるようにしました。そのため、Javaに固執するつもりであっても、この仕様を参照する必要があります。詳細についてはJava APIドキュメント、特にJavaスクリプトの開発スクリプトは、Javaソース・コードのスニペットを埋め込んでカスタマイズすることもできます (Javaコードブロックの章を参照)。Javaでコード化されたカスタム・アクションで言語を拡張するもう1つの方法は実行コマンドコマンドです。v2.2以降、Javaのパラメトリック呼び出しをサポートしています。

1.3 Robot機能

T-Plan Robotは機能的に豊富で成熟した製品であり、以前のバージョンで開発された言語仕様の上に構築されています。一般論として、T-Plan Robot は旧バージョンの上にさらに機能を追加し、その言語はレポートジェネレーター、画像比較アルゴリズム、デスクトップクライアントなどの追加コマンドやサービスプロバイダーで拡張されています。以前の製品バージョンでデザインされたスクリプトはT-Plan Robot言語と互換性があります。

2. 言語構文

2.1 言語構造

T-Plan Robot の言語はテキストベースのプログラミング言語であり、スクリプトは通常プレーンテキストファイルとして保存されます。以下の一般的なルールが適用されます：

• ISO8859-1 (Latin-1) 文字を推奨する。ISO8859-1(Latin-1)文字が推奨されます。このセット以外の文字をコマンド引数やパラメータ値に使用することもできますが、特定のリモートデスクトップクライアントとそのプロトコルの機能によってサポートが異なります。ISO8859-1以外の文字を使用する前に、クライアントのドキュメントを読んでください。

• このドキュメントに明示的に記載されていない限り、言語は大文字と小文字を区別しません。

スクリプトは次の規則に従って解釈されます：

• スクリプトは一行ずつ処理されます。スクリプトは一行ずつ処理されます。仕様で明示されていない限り、1つのコマンドや式を複数行に分割することはできません。

• 行には、先頭または末尾に任意の数の空白文字（スペース、タ ブレーターなど）を含めることができます。それらは、処理を進める前に切り取られます。

• 空行は無視される。

• ハッシュ '#' で始まる行はコメントとみなされ、無視されます。バージョン2.3以降では、ダブルスラッシュ'//'で始まるJava/C++スタイルのコメントも受け付けます：

# これはコメントです
// これはコメントです。

• 上記の規則で排除されない他のテキスト行には、コマンド、プロシージャーヘッダー、プロシージャーコール、if/else/for文、またはその終端である右中括弧（'}'）など、スクリプト言語の要素が1つ含まれている可能性があります。このようなテキスト行は、それぞれ次のように処理される：

1. テキストは、1つ以上の空白によってトークンに分割される。テキストは、1 つ以上のスペースによってトークンに分割されます。スペースが先行し、2 つ の二重引用符 ("...") で囲まれたテキストは、1 つのトークンと見なされます。エスケープされた二重引用符 (\") はトークンの先頭または末尾を示すものとは見なされず、以降の処理では二重引用符に置き換えられます。identifier=value'または'identifier="value with spaces"'の形式を持つ文字列は、1つのトークンとみなされ、さらに識別子と値のペアに解析されます。

   例:
   This is a text containing spaces
   - 'This', 'is', 'a', 'text', 'containing', 'spaces' の6つのトークンに解析される。

   This "is a text" containing spaces
   - 'This', 'is a text', 'containing', 'spaces' の4つのトークンに解析される。

   This text contains "double quote (\")"
   - 'This', 'text', 'contains', 'double quote (")' の4つのトークンに解析されます。

   Var SAMPLE_VAR_1="スペースを含む値" SAMPLE_VAR_2=no_spaces "NO_VAR=not_a_variable"
   - 4つのトークンに解析されます：Var」、「SAMPLE_VAR_1="空白を含む値"」、「SAMPLE_VAR_2=no_spaces」、「NO_VAR=not_a_variable」です。2番目と3番目のトークンは、さらに識別子と値のペアに解析される。

   この設計では、末尾にバックスラッシュを含む値を指定することはできません。

   Var SAMPLE_VAR="これはバックスラッシュです ୧"

   末尾の'୧'シーケンスは、バックスラッシュの後に閉じる二重引用符ではなく、エスケープされた二重 引用符として解釈されるため、コンパイラはエラーを報告します。

   Var SAMPLE_VAR="これはバックスラッシュ %26bs; "です。

2. 最初のトークンは、コマンド名またはプロシージャー名とみなされ、コマンドおよびプロシージャーテーブルと照合されます。コマンド名は大文字と小文字を区別しません。

3. さらなる処理と構文検証は、コマンド/プロシージャ・ハンドラによって実行されます。Command Syntax と Procedures の章で説明する。

2.2 時間値

コマンド引数 Wait コマンドの引数や他のコマンドのwait/timeout/delayパラメータなどの時間値は、以下の構文をサポートしている：

• 「1」は1ミリ秒として解析される、

• 「1s」は1秒、

• 「1m」は1分、

• 「1h」は1時間、

• 「1d」は1日。

• 「1w」は1週間

• 「1M」は1ヶ月

• 「1y」は1年

浮動小数点変数は英語フォーマットでのみ使用可能で、例えば '3.5h' は3.5時間（3時間30分）として解析されます。時間値には数値式を含めることができます。Numeric Expressions の章を参照してください。

例:

Wait "1.5d"

– 1日半（36時間）待つ。

Press Ctrl+C wait=5s

– Ctrl+Cを押して5秒間一時停止。

2.3 変数

変数は Var と Eval コマンドで作成することができる。変数は大文字と小文字を区別する名前と値を持つ。Var/Evalコマンドを含む）動的な内容を必要とするあらゆる場所で、変数を参照することができます。T-Plan Robotのプリプロセッサは、コマンド行を解析する前に{<var_name>}を<var_name>変数の値に置き換えます。

典型的な例

Var PATH=/tmp
Typeline "mkdir -p {PATH}; cd {PATH}"

Var 1="test"'のような、数字だけの変数名は避けてください。これらの変数はプロシージャー・パラメーター用に予約されており、プロシージャーを実行すると警告なしに書き換えられてしまいます。

変数が定義されていない場合、置換は行われません。以下の例では、変数定義がコメントアウトされているため、'cd /tmp'よりも'cd {PATH}'とタイプされます：

# var PATH=/tmp
Typeline "cd {PATH}"

プリプロセッサはネストされた変数参照をサポートします。この機能は、マッチの座標がSEARCH_X<数値>として保存される画像比較メソッド'search'の複数のマッチを処理するために必要であり、ループの中で変数名を動的に生成する必要があります。次の例はそのような使い方を示しています。リモートデスクトップからアイコンを検索し、表示されたアイコンをクリックするとします：

Compareto "search.png" method=search
for(i=1; {i}<{_SEARCH_MATCH_COUNT}+1; i={i}+1) {
# ネストされた変数は、接尾辞とインデックスから変数名を構成する
 Mouse click to=x:{_SEARCH_X{i}},y:{SEARCH_Y{i}} 
 }

T-Plan Robot は、オブジェクト指向プログラミング(OOP)におけるメンバクラスとローカル変数に似たグローバル 変数とローカル 変数の概念もサポートしています。変数のタイプは明示的に宣言されませんが、コードのどこで作成されるかに依存します：

1. スクリプト本体に作成された変数はグローバル変数とみなされ、定義した時点からスクリプトの実行が終了するまでアクセス可能です。

2. 構造化されたコードブロック（プロシージャ、if/else、for文）内で作成された変数はローカル変数とみなされ、そのコードブロック内（ネストされたブロックを含む）でしか使用できません。

ローカル変数はグローバル変数を上書きすることはできません。つまり、コードブロック内でVarコマンドやEvalコマンドを実行し、その変数名がすでに存在するグローバル変数と一致した場合、同じ名前のローカル変数を定義するよりも、むしろグローバル変数を変更する方がよいということです。次の例は、その原則を示しています。

# グローバル変数
Var GLOBAL=global
If (1 == 1) {
  # ローカル変数を作成し、GLOBALの値を'modified'に変更する。
  Var LOCAL=local GLOBAL=modified
  If (1 > 0) {
    Var LOCAL2=local2
    # ここで、GLOBAL、LOCAL、LOCAL2 が利用可能である。
    # コマンドは "GLOBAL=modified, LOCAL=local, LOCAL2=local2" とタイプする。
    Type "GLOBAL={GLOBAL}, LOCAL={LOCAL}, LOCAL2={LOCAL2}"
  }
  # ここで、GLOBALとLOCALは利用可能であり、LOCAL2はもう存在しない。
  # コマンドは "GLOBAL=変更済み, LOCAL=local, LOCAL2={LOCAL2}" とタイプする.
  Type "GLOBAL={GLOBAL}, LOCAL={LOCAL}, LOCAL2={LOCAL2}"
}
# ここで、GLOBALは利用可能であり、LOCALとLOCAL2はもう存在しない。
# コマンドは "GLOBAL=modified, LOCAL={LOCAL}, LOCAL2={LOCAL2}" とタイプする.
Type "GLOBAL={GLOBAL}, LOCAL={LOCAL}, LOCAL2={LOCAL2}"

同じルールが Include と Run コマンドでロードされたスクリプト内で定義された変数にも同じルールが適用されます。T-Plan Robotは、スクリプトから参照できる定義済み（明示的とも呼ばれる）変数のセットを提供します。これらの変数には、実行開始日、デスクトップサーバーのホスト名、実行されたスクリプトの名前など、様々な有用なデータが含まれています。定義済み変数の完全なリストについては Var コマンド仕様を参照してください。変数値は、CLI を使用してスクリプト実行時にオーバーライドできます。で指定されている v/-variable パラメータを参照してください。CLI Optionsドキュメントを参照してください。これにより、特定のスクリプト実行をパラメトリック化したり、スクリプトコード内の機密情報（ユーザー名、パスワード...）の漏洩を回避したりすることができます。CLIで設定すると、変数は「読み取り専用」になり、スクリプト実行中ずっとその値が固定されます。スクリプト内で実行されるこの変数を変更する Var/Eval コマンドはすべて無視され、その値には影響しません。これは、明示的な（定義済みの）変数を含む、あらゆる変数に適用されます。

2.4 プロシージャ

T-Plan Robot は簡単なプロシージャをサポートしています。プロシージャは、その名前を呼び出すことで実行できる、必要な形式で記述された言語要素の名前付きブロックです。プロシージャは、ヘッダ、ボディ、右中括弧で終わります。

プロシージャの書式は

Procedure <procedure_name> {
   command1
   command2
   ...
   commandN
}

以下のルールが適用されます：

• プロシージャー名は大文字と小文字を区別せず、他のコマンド名や言語要素名と衝突してはなりません。v3.0.1以降、二重引用符で囲まれている場合、名前にスペースが含まれていても構いません：

Procedure "Perform action A" {
   ...
}
...
"Perform action A"

• 左中括弧'{'は、プロシージャーヘッダーと同じ行になければなりません。

• 終端の右中括弧 '}' は、1行に1つでなければなりません。

• プロシージャー定義は、すでに定義されている同名のプロシージャーを上書きします。

• プロシージャーは、その定義の後にスクリプトの任意の場所で呼び出すことができます。

• 他のスクリプト（ファイル）で定義されたプロシージャは Include コマンドで取り込むことができます。

プロシージャー呼び出しには、以下のようにスペースで区切られたパラメータをいくつでも渡すことができます：

<procedure_name> parameter1 "parameter2 with spaces" ... parameterN

パラメータは、'0', '1' ... 'N'という名前の変数として利用できます。インデックス0の最初の変数には、常にプロシージャー名が格納されます。プロシージャが受け付けるパラメータは、プロシージャのヘッダのどこにも宣言されていないことに注意してください。

バージョン2.1以降、_PROCEDURE_ARG_COUNT 変数から多くの入力引数が利用できるようになりました。これらは、パラメータの数に応じて動作を分岐させたり、省略されたパラメータにデフォルト値を代入したりするために使用されます。

次の例は、可変画像フォーマットでスクリーンショットを作成する簡単なプロシージャの書き方と呼び出し方を示しています。デフォルト値の代入（Var extension=png）は、パラメータ代入（Var extension={2}）の後に指定しなければならないことに注意してください。これは、正しいコマンド構文を検証するために、if/else構造に関係なくコンパイル時にすべての変数代入を実行するコンパイラの制限によるものです。

# プロシージャの定義。期待されるパラメータは以下の通り：
# 1} ... ファイル名(拡張子なし)
# 2} ... 画像の拡張子(jpg, jpeg, pngのいずれか).省略時のデフォルトは "png"。
procedure take_screenshot {
 Var  extension={2}
 if ({_PROCEDURE_ARG_COUNT} == 1) {
 Var extension=png
 }
  Screenshot {1}.{extension} desc="このスクリーンショットは {0} というプロシージャによって作成されました。"
}

take_screenshot image1 jpg
take_screenshot image2

プロシージャは常に、プロシージャ本体内で最後に実行されたコマンドの終了コードを返します。特定の終了コードでプロシージャを終了するには Exit コマンドを scopeラメータを procedure. 例を以下に示します：

# プロシージャの定義
Procedure exit2 {
 Exit 2 scope=procedure
}

# 手続き呼び出し
exit2

if ({_EXIT_CODE} == 2) {
# exit2 が 2 を返すため、ここにあるコードはすべて実行されます。
}

パラメータがないと、コードが正しいかどうかを判断できないため、プロシージャ定義時にプロシージャの内容がコンパイルされることはありません。T-Plan Robot Enterprise は、代わりにプロシージャ呼び出しをコンパイルします。例えば

take_screenshot image3 tiff

と入力すると、T-Plan Robot はこの行でエラーを報告します。なぜなら 'tiff' は Java がサポートしていない画像形式であるため、例のプロシージャ本体の Screenshot コマンドはコンパイルエラーを投げるからです。

2.5 フォールバック手順

T-Plan Robot バージョン 2.3 では、いわゆるフォールバック手続きが導入されました。これは予約された名前の手続きで、特定の条件(イベント)が満たされたときに自動的に呼び出されます。フォールバック手続きは、それ以外は標準的な手続きであり、一般的な手続き規則がすべて適用されます。above が適用されます。要するに、(1)名前の大文字と小文字は区別されません。Include または Run (3)プロシージャは、それを呼び出すコードの前に定義されていなければなりません。

• DisconnectFallback と 呼ばれるプロシージャは、VNCサーバへの接続がクラッシュしたときに、initフェーズ（コマンドの内部）か、それ以降に呼び出されます。Connectコマンドの内部)、またはサーバが終了(kill)したときやネットワークエラーが発生したときなど、それ以降の任意のタイミングで呼び出されます。コマンドの呼び出しは Disconnect コマンドの呼び出しは、予期された接続の終了であるため、プロシージャを開始しません。Connectがフォールバック・プロシージャ本体で呼び出された場合、無限接続ループを防ぐために、失敗時にプロシージャを再度呼び出すことはありません。スクリプト実行中の通常操作フェーズで接続のクラッシュが検出されると、現在実行中のコマンドが終了した直後にプロシージャが呼び出されます。このような場合、サーバーに正しく転送されたデータの範囲が不明なため、プロシージャを安全なリカバリ（再接続とスクリプトの再開を意味する）に使用できない可能性があることに注意してください。これは、例えばテキスト入力の途中でクラッシュが発生し、接続に失敗する前に何文字が正常に入力されたかを判断できない場合に問題となります。

• ComparisonFailureFallbackと 呼ばれるプロシージャが Compareto Command または Waitfor Command のマッチ/ミスマッチが失敗し、onfail または ontimeout パラメータで明示的なフェイル・アクションが指定されていない場合に、ComparisonFailureFallback と呼ばれるプロシージャが実行されます。プロシージャ本体内で"{1}"として取得できる最初のプロシージャ引数には、常に呼び出し元の比較コマンドの数値終了コードが含まれます。これは通常、オブジェクトが見つからない場合は "1"、1つ以上のテンプレート画像が見つからないか、読み取ることができない場合は "2 "となります。

次の例は、フォールバック手続きの使用方法を示しています。どちらも単に特定の終了コードでスクリプトを終了します。比較の方は、さらに、後でデバッグできるようにスクリーンショットを作成します。この例は、他の適切なアクションを実行するように簡単に拡張できます。Sendmail コマンドによる電子メールの送信や Pause.

Procedure DisconnectFallback {
 Exit 3
}

Procedure ComparisonFailureFallback {
 Screenshot comparison_failure.png
 Exit {1}
}

// スクリプト本体
Connect localhost:1 password=welcome
Compareto button.png method=search
// ...

バージョン 7.2.4 では、BrowserFailureFallback プロシージャがサポートされました。スクリプトで定義すると、ブラウザのopen/find/closeコマンドが失敗するたびに呼び出されます。これは、3つの追加引数を公開します：

{1} はコマンドの数値終了コード、
{2} は操作を示します。これは、無関係な呼び出しを除外するために使用できます。

• 失敗したコマンドが "Browser open/close" の場合、"open" または "close" に設定されます。

• 失敗したコマンドが "Browser find " で、"elaction" パラメータが指定されていない場合、引数は "find" に設定されます。

• そうでなければ、引数は失敗したエレメントアクションを指定します。"click"、"submit"、"clear"、"type"、"select" のいずれかです。

{3} はエラーメッセージで、通常は実行ログに記録されるものと同じです。

以下はその例です（Chromiumプラグインが必要です）：

Procedure BrowserFailureFallback {
  Log "Failed action: {2} (exit code: {1})"
  Log "Reported error: {3}"
}

Browser open url="https://www.t-plan.com" browser="chromium"

// このコマンドは、間違ったボタンテキストに対して失敗し、"BrowserFailureFallback "プロシージャを呼び出します。
Browser find class="elementor-button-text" text="Why T-Plans" timeout="5s"

2.6 数値表現

数値式は v1.3 からサポートされています。

浮動小数点変数は英語形式（例：「1.25」）で記述してください。

'5s'(5秒)のような時間変数は、time修飾子が式の最後にある場合を除き、受け付けられません。例

• 正解：Wait 5+5s

• 不正解：Wait 5s+5s

サポートされている数値演算子

• 括弧 '(' および ')'

• プラス '+'

• マイナス '-'

• 単項マイナス '-' (負の数)

• 乗算 '*'

• 除算 '/'

• モジュロ除算 '%'

• 累乗演算子 '^'

数値式は、言語内で数値を表す場所であればどこでも使用できます。

# 1 時間待つ - ミリ秒単位
Wait "1*60*60*1000"

# 画像を検索し、その左上隅から10ポイント離れた位置をクリックする
Compareto "pattern.png" method="search2"
Mouse click to="x:{_SEARCH_X}+10,y:{_SEARCH_Y}+10"

数値式に基づいて変数を定義するには Eval コマンドの代わりに Var 例えば、'Eval HOUR_IN_MS=1*60*60*1000'である。

2.7 ブール式

論理式はif/elseやforのような構文を容易にします。以下の演算子がサポートされています：

• 括弧 '(' および ')'

• 大'>'、大 '>='、小 '<'、小'<='。これらの演算子は数値引数を必要とします。

• '==' と等しく、'!=' または'<>'と等しくない。引数の少なくとも1つが数値でない場合（二重引用符で囲まれた文字列）、プレーンな文字列比較が実行されます。例

  • 'yes == no' の結果は偽となる。

  • 'yes != no'の結果は真になります。

  • どちらの引数も数値に変換でき、数値が等しいので、'1.0 == 1' の結果は真となります。

• 演算子 '&&' と '||' - 論理的な "and" と "or"。これらの演算子はブール引数、つまり他の式を必要とします。例

  • 式 '1 > 0 || yes != no' は、2つの式のどちらかが真であるため、真となります。

  • 式 '1 > 0 && yes != no' は、一方の式が偽なので偽となります。

バージョン2.2以降では、変数の存在や文字列の比較を行う演算子もサポートされています：

• 単項演算子 'exists <variableName>' は変数の存在をテストする。例

  • 式 'exists _REPORT_FILE'は、スクリプトがReportコマンドでレポートを作成する場合に真になります。

• 演算子 'contains' は、最初の文字列引数がもう一方の引数を含むかどうかをテストします（大文字と小文字が区別されます）。例

  • 式 '"{_MACHINE}" contains "sourceforge"'は、接続されているVNCサーバー名に 'sourceforge' が含まれている場合に真になります。

• 演算子 'hasphrase' は、最初の文字列がもう一方の文字列を含むかどうかを検証します(7.2.2以降)。”contains” と似ていますが、改行や不要なスペースに寛容です。これにより、OCRで認識されたテキストを画面上で簡単に評価することができます。例

  • 式 '"{_TOCR_TEXT}" hasphrase "Hello world I am here"' は、複数行に分割されているか、複数のスペースが含まれているかに関係なく、先に実行された OCR の結果のテキストに指定されたフレーズが含まれていれば真になります。

• 演算子 'startswith' は、最初の文字列引数がもう一方の引数で始まっているかどうかをテストします（大文字小文字を区別します）。例

  • 式'"{_DISPLAY}" startswith "localhost"' は、接続されているVNCデスクトップ名が ‘localhost’ で始まる場合、例えば ‘localhost:1’ のように真になります。

• 演算子 'endswith' は、最初の文字列引数が他の文字列引数で終わっているかどうかをテストします（大文字と小文字を区別します）。例

  • 式'"{_DISPLAY}" endswith ":3"' は、接続されている VNC サーバーがポート 5903 で動作している場合 (これは通常、デスクトップ名の ':3' ディスプレイ番号で示されます) に真になります。

• オペレータ 'matches' は、最初の文字列引数をjava.util.regex.Pattern 準拠の正規表現と比較します。例

  • 例 '"{_DATE}" matches "201008[12][1-5]" は、現在の日付が2010年8月11日から15日の間、あるいは21日から25日の間にある場合に真

ブール式は、次の例に示すように、if/elseとfor構文でのみ使用されます。また、ブール式は Eval コマンドに渡すこともできます。

# リモートデスクトップ上の画像を探す
Compareto "pattern.png" method=search

# 画像が見つからなかった場合は終了します、
if ({_EXIT_CODE} > 0) { 
  Exit 1
}

詳細は If/Else Statement および For Statement の章をお読みください。

2.8 関数

関数はリリース5で導入されました。これらの関数は、if/else文やfor文、コマンド、その他この仕様で数値表現をサポートするコマンド・パラメータなど、ブーリアン式や数値式が期待される場所であればどこでも使用することができます。 Eval コマンドや、この仕様で数値式をサポートしているその他のコマンド・パラメータなどです。関数名は大文字と小文字を区別しません。

例えば、以下のfor文は10回繰り返し処理を行います：

for (i=0; i<MAX(6,10,9); i=i+1) {
  ...
}

サポートされている関数（カスタム関数が必要な場合はサポートにお問い合わせください）：

2.9 If/Else 文

T-Plan Robotは、Javaで使用されるものと類似した機能と構文を持つif/else文をサポートしています。フォーマットは次のとおりです

if (<boolean expression>) {
    <commands>
} else if (<boolean expression>) {
    <commands>
} else {
    <commands>
}

'else if'および'else'分岐は省略可能です。'else if'分岐の数に制限はありませんが、'else'構文は1つだけ存在できます。注意：囲み中括弧'{'と}'は、上記で示されている通り、関連するif/else/else ifキーワードと正確に同じ行に記述する必要があります。

構造化ブロック全体を終了させる右中括弧'}'は唯一の例外で、1行に1つでなければなりません。例

# リモートデスクトップ上の画像を探す
Compareto "pattern.png" method=search

# 画像が見つからなかった場合は終了します、
if ({_EXIT_CODE} > 0) {
  Exit 1

# 画像がそれ以上見つかった場合、スクリーンショットを撮り、HTMLレポートに警告を追加します。
} else if ({_SEARCH_MATCH_COUNT} > 1) {
  Screenshot unexpected.png
  Warning "Unexpected behavior - the template image was found
{_SEARCH_MATCH_COUNT} times!" image=unexpected.png
}

If/Else 文は、他の構造化プログラミング言語と同様に、ネストしたりFor 文など他の構文と組み合わせたりすることができます。

2.10 For ステートメント

T-Plan Robot は for 文をサポートしており、特定の条件が満たされる限り、値の範囲を反復したり、ループしたりすることができます。for文には2つの一般的な形式があります。

1.条件付き for 文

for 文の最初の型は、指定された論理式の結果が真である限り実行されます：

for (<statement1>; <boolean expression>; <statement2>) {
     <commands>
}

ブール式はすべてのループの前に評価されるので、ループ内のコマンドは、式が最初からfalseであれば、まったく実行されません。

ステートメント1とステートメント2は Eval コマンドを使って評価され、'<変数>=<数値式>'のような構文になります。これらは空でも構いません。以下の例は等価であり、0から5までの変数'index'の値をループします：

for (index=0; {index}<6; index={index}+1) {
  Type {index}
}

Eval index=0
for( ; {index} < 6; ) {
   Type {index}
   Eval index={index}+1
}

バージョン2.3以降では、文のヘッダー内の変数呼び出しが中括弧を省略する、より単純な構文もサポートしています：

for(index=0; index<6; index=index+1) {
}

2.あらかじめ定義された値の集合を反復処理するfor文

この書式では、あらかじめ定義された値の集合を繰り返し処理することができます：

for <変数名> in <スペースで区切られた値のリスト> {
<commands>
}

次の例では、"I speak a English, Spanish, Brazilian Portuguese. "という文章を入力します。

Type "I speak "
for language in English Spanish "Brazilian Portuguese" {
    if ("{language}" == "Brazilian Portuguese") {
        Type "{language}." 
    } else {
        Type "{language}, " 
    }
}

変数で指定することもできます。バージョン3.0.1以降では、変数で指定したスペースを含む値をサポートしています。次のコードは、変数で値セットを指定した前の例を示しています。

変数呼び出しはダブルクォーテーションで囲んではなりません。

Type "I speak " 
Var VALUES="English Spanish \"Brazilian Portuguese\""
for language in {VALUES} {
    if ("{language}" == "Brazilian Portuguese") {
        Type "{language}." 
    } else {
        Type "{language}, " 
    }
}

for文の実行は、コマンドによって中断することができます。Break コマンドで中断できます。現在のループは Continue コマンドでスキップできます。ループが入れ子になっている場合、break/continue コマンドは最も内側のfor文に適用されます。

次の例では、for 文と Waitfor Command を組み合わせて、リモートデスクトップが更新を停止するまで実行を継続する方法を示します。

# 無限ループ
for (; 0 == 0; ) {
# リモート画面が少なくとも20% 更新されるまで待つ。
# 10秒間更新されなかった場合、ループを抜けます。
 Waitfor update extent=20% timeout="10s" ontimeout="break"
}

2.11 戻り値

v1.3 以降、すべてのコマンドは_EXIT_CODEという変数として利用可能な整数値を返します。0（ゼロ）は通常成功を意味し、それ以外の数値は失敗を意味します。定義された終了コードの値とその意味については、特定のコマンドのドキュメントを参照してください。

戻り値（「終了コード」とも呼ばれる）は、スクリプトの実行を制御し、予期される結果と予期されない結果の両方を処理する方法を定義するために効果的に使用することができます。例えば compareto コマンドは、例えば画像比較が成功した場合は0を返し、そうでない場合は0以外の値を返します。例えば Waitfor Command コマンドは、期待されるイベントを受信すると0を返し、タイムアウトに 達すると0以外の値を返します。 以下の例は、これらの戻り値の使い方を示しています。

# Alt+F2 でGnomeのプログラム実行ウィンドウを開く。
Press Alt+F2 wait=3s

# Gnomeテキストエディタを起動する
Typeline gnome-text-editor

# リモートデスクトップの更新を待つ
Waitfor update extent=30% timeout="10s"

# もし Waitfor が0以外の値を返した場合、タイムアウトに到達した # と判断されます。
# テキストエディタが開けなかった可能性がある
If ({_EXIT_CODE} > 0) {

# スクリーンショットを撮る
  Screenshot failure.png

# スクリーンショットをEメールでテスターに送る
  Sendmail to="tester@dummyserver.com" from="robot@dummyserver.com" server="http://mail.dummyserver.com" subject="Gnome editor failed to open!" attach="{_REPORT_DIR}/failure.png"

# 実行を一時停止し、テスターが修正するのを待つ
 Pause "Paused because Gnome Text Editor failed to start" 
}

If/else、for、break 呼び出しは値を返さないことに注意してください。これらのコマンドの後に _EXIT_CODE 変数にアクセスすると、最後に実行されたコマンドの終了コードが格納されます。

2.12 Java コードブロック

JavaコードブロックはTPRスクリプトからJavaコードを直接呼び出すことを可能にします。これは、スクリプト言語にこだわりたいが、特定のカスタム機能が必要な場合をサポートするために設計されました。

Javaコードブロックを正しく動作させるには、"java -jar robot.jar"コマンドではなく、"java -classpath <libs> com.tplan.robot.ApplicationSupport" コマンドを使ってJDK上でRobotを実行するようにしてください。後者の構文は、環境によってはJavaコンパイラの'CLASSPATH'への入力に失敗し、Javaソースコードのコンパイルと実行に失敗します。詳細はリリースノートの startup chapter を参照してください。

Javaコード・ブロックの一般的な構文を以下に示します。import句のサポートはv2.2で提供されたことに注意してください。以前のバージョンでは、クラスを完全修飾名で参照するか、環境設定preferencesで管理されるテストクラステンプレートにインポートを追加する必要があります。

java {
  <import clauses>
  <Java code>
} endjava

このような各ブロックは内部的に DefaultJavaTestScript クラスを拡張した Java スクリプトに変換され、ブロック内の Java コードはその test() メソッドに挿入されます。クラス・テンプレートは Java コード・ブロック構成で公開され、Preferences ウィンドウからカスタマイズできます。次の例はその例です：

java {
  import java.util.Date;
  System.out.println("Current date: "+new Date());
} endjava

import com.tplan.robot.scripting.*;
import java.io.*;
import java.util.*;
import java.util.Date;

public class SomeDynamicName extends DefaultJavaTestScript {
  public void test() {
    System.out.println("Current date: "+new Date());
  }
}

このメカニズムには、いくつかの実用的な影響があります：

• Java コードブロックは Java コンパイラへのアクセスを必要とするため、T-Plan Robot は Java Development Kit (JDK) 上で動作するか、有効な JDK インストールパス (v2.3.3 以降) で設定されている必要があります。もしツールがJava Runtime Environment (JRE)だけで動作し、JDKが利用できない場合、コンパイラはエラーを報告します。このドキュメントの第1章を参照してください。Release Notes 章を参照してください。

• スクリプト内でJavaコード・ブロックを使いすぎないようにしてください。スクリプトとツール全体のパフォーマンスが低下する可能性があります。プリコンパイルされたJavaコードの再利用可能なパラメトライズされた部分を作成したい場合は Run 機能を探します。

• デフォルトでは、テンプレートは com.tplan.robot.scripting、java.io、java.util パッケージのすべてのクラスをインポートします。他のパッケージのクラスを使いたい場合は、Javaコードの前に import 句を置きます。他の方法としては、完全修飾名（例えば java.awt.Point など）でクラスを参照するか、Java コード・ブロックの環境設定でクラス・テンプレートにインポートを追加します。テンプレートの方法を選択した場合は、スクリプトを別のマシンに移行するときに、必ずそれを再適用してください。

• 各 Java コード・ブロックはスタンドアロンのJavaクラスとして動作するため、あるブロックで作成されたローカル変数やオブジェクトは、別のブロックでは表示されません。複数の Java ブロックでオブジェクトを共有する必要がある場合は、それらをコンテキストに格納します。コンテキストは基本的にマップであり、スクリプトのコンパイルや実行の間ずっと存在し、重要なオートメーション・フレームワーク・オブジェクトへの参照を保持します。オブジェクトをコンテキストに格納するには getContext().put() を使用し、オブジェクトを取得するには getContext().get() を使用します。すでに存在するフレームワークオブジェクトの参照を上書きしないように、必ず一意のキーを使用してください。詳細については、ScriptingContext インタフェース仕様を参照してください。

• Javaコードブロックは、コンテキストのgetContext().getVariable()とgetContext().setVariable()メソッドを通して、TPRスクリプトとグローバル変数を共有することができます。コードブロックは DefaultJavaTestScript クラスを継承しているので、スクリプト言語のコマンドに対応するメソッドを呼び出すこともできます。

次の例では、変数の共有について説明します。スクリプトはまず、テンプレート・パスを "C:/templates" に設定します。Javaコードはコンテキストを通してパスを取得し、ディレクトリ内のすべての PNG ファイルをリストアップし、FILE<n> と呼ばれる番号付き変数として、ファイル・カウンタFILECNTとともにコンテキスト変数に格納します。TPR スクリプトが再開すると、リストされたファイルを繰り返し、各 PNG ファイルに対して画像比較を実行します。

Var TEMPLATE_DIR="C:\templates"

# この行はJavaコードによって入力される変数のダミー値を宣言します。
# コンパイラが for() ループやCompareToコマンドでエラーを報告するのを防ぎます。
Var FILECNT=0 FILE1=dummy.png

java {
  File files[] = getContext().getTemplateDir().listFiles();
  int i = 0;
  for (File file : files) {
    if (file.isFile() && file.getName().endsWith(".png")) {
      i++;
      getContext().setVariable("FILE"+i, file.getName());
      }
    }
  getContext().setVariable("FILECNT", Integer.toString(i));
} endjava

for (i=1; {i}<{FILECNT}+1; i={i}+1) {
  Compareto "{FILE{i}}" method=search
}

3.コマンド構文

3.1 デスクトップコマンド

3.1.1 AI

説明

AI - AIと対話する（8.2以降）。

"AI Chat" は、AIにメッセージを送信し、その応答を_AI_RESPONSEスクリプト変数に保存します。現在のデスクトップ画面の画像やテキストファイルを添付するには、screenと attach パラメータを使用します。

AIの応答は3つの方法でテストできます：

• “text" およびオプションの "distance" パラメータを使用して、AI応答が特定の語句を含んでいることを確認します。 応答が一致しない場合、スクリプトは終了します 。

• より柔軟なテキストマッチングを行うには、"pattern"正規表現にマッチする応答を検索する。応答が一致しない場合、スクリプトは終了 します。

• “text” も "pattern" も指定しなかった場合、応答はスクリプト変数 _AI_RESPONSE に保存され、スクリプトの続行が許可されます。その後、if/else を使用して変数をテストすることができます。 論理式 contains"、"startswith"、"endswith"、または "matches" などのブール式を使用して変数をテストすることができます。もうひとつの方法は 文字列コマンド(Stringコマンド）でテキストを解析することです。.
  以下の 例セクションをご覧ください。

利用方法

ai chat [message=<text>] [ai=<Claude|OpenAI>] [screen=<true|false>] [attach=<file(s)>] [text=<pattern>] [distance=<number>] [pattern=<regexp>]

• 赤色は 必須パラメータです。

オプション

message=<text>

• メッセージテキスト（"質問"）、例えば "Is there a dog on the screen?"。

ai=<Claude|OpenAI>。

• オプションのAI名。"Claude" または "OpenAI" のいずれかです。。この名前は通常、複数のAIが設定されていて、特定のAIをターゲットにしたい場合にのみ指定します。名前が指定されていない場合、コマンドは設定されているAIを使用するか、両方が設定されている場合はClaudeを使用します。

screen=<true|false>

• true "を指定すると、接続されているデスクトップ画像のコピーをAI質問に添付します(オプション)。デフォルト値は "false"(画面を添付しない)です。

attach=<ファイル>

• オプションのファイル、または質問に添付するファイルのコロンまたはセミコロンで区切られたリスト。これは以下のものに限られます：

  • Javaでサポートされている画像ファイル (PNG、JPG、BMP、GIF、TIFF、WBMP)

  • プレーンテキストファイル、およびXML、HTMLなどの可読テキストコンテンツを含むファイル。

[text=<パターン>］

• AIの回答を照合するためのオプションの大文字文字(「含む」)。例えば、"dog "という値を指定すると、AI応答が "dog "という単語を含む場合は合格となりますが、"DOG" や "Dog" を含む場合は不合格となります。寛容なマッチングには、"distance "または "pattern "パラメータを使用します。text "および"pattern "パラメータは相互に排他的であり、一度に使用できるのは1つだけです。

[distance=<数値>](距離=<数値>)

• 許容テキスト検索を行うために”text”パラメータと組み合わせてオプションの距離を使います。。パラメータがデフォルト値0(距離なし)に設定されている場合、コマンドはプレーン文字列検索に戻り、提供された文字列の最初の出現箇所を引数テキストで検索します。

  許容（ファジー）テキスト検索は、距離値が 1 以上の場合に実行されます。テキストは、指定された文字列と十分に類似した文字列の出現を検索します。許容度（類似度）はレーベンシュタイン距離に基づいています。これは、一方の文字列を他方の文字列に変換するのに必要な最小の編集回数として定義され、許容される編集操作は1文字の挿入、削除、置換です。この距離は、最大で何文字が省略されるか、または正しく認識されないと、サンプルテキストが等価であるとみなされるかをおおよそ規定しています。
  例えば、"dog "の1文字を置換すると"fog "になるため、"text=dog distance=1" のパラメータでは、"There is fog" という応答がマッチします。

[pattern=<正規表現>]

• java.util.regex.Pattern に準拠した正規表現で応答を検索します（オプション）。. "の正規表現は、デフォルトでは行末を除くすべての文字にマッチします。この動作は、コマンドの環境設定で変更することができます。
  text "と"pattern "パラメータは互いに排他的であり、一度に使用できるのは1つだけです。

例

• 画面上に犬がいることを確認し、いない場合はスクリプトを終了してください。

Ai chat message="Does the screen show a dog? Answer just \"yes\" or \"no\"." screen=true ai=OpenAI pattern=[Yy]es

• 画面上に犬がいることを確認し、その結果に基づいて行動してください。

Ai chat message="Does the screen show a dog? Answer just \"yes\" or \"no\"." screen=true ai=OpenAI
if ("{_AI_RESPONSE}" matches "[Yy]es") {
    // There's a dog on the screen -> do something
    ...
} else {
    // There's no dog -> do something else
    ...
}

3.1.2 Browser

Browser - Selenium 駆動のウェブブラウザを自動化します（v5 以降）。技術と設定ステップの概要は、別の documentでまとめられています。コマンドは以下のアクションをサポートします：

• “browser_open” 選択されたウェブブラウザを開き、指定されたウェブページをロードします。ブラウザはローカルでもリモートでもかまいません（Selenium Grid、6.3以降でサポート）。バージョン 8 以降、コマンドは新しいタブやウィンドウを開くこともできます。

• “browser_find” 指定された条件でウェブページの要素（HTML タグ）を検索し、オプションのアクション（クリック、タイプ、サブミット、クリア）を適用します。

  • コマンドがアクションを指定せず、要素が見つからない場合は、スクリプトを続行します。検索結果（見つかった/見つからなかった）は、コマンドの終了コードと要素の属性を含む_WEB変数の存在によってスクリプトに示されます。

  • コマンドがアクションを指定し、要素が見つからない場合、スクリプトは終了します。この動作は Click コマンドと Drag コマンドと一致しています。

  • 要素が存在し、継続する場合にその要素にアクションを適用する "ようなアクションをスクリプトで実行するには、2つの "Browser find "コマンドを使用します。

• "browser_switch" は、タブやウィンドウを切り替えたり、それらを記述する変数を更新したりします。v8からサポートされています。

• “browser_close” タブ、ウィンドウ、あるいはブラウザ全体を閉じ、 Selenium セッションを終了します。

リリース 8 から、ほとんどのブラウザコマンド操作は、利用可能なタブとウィンドウを記述する変数のセットを次のように入力します。追加パラメータなしで "Browser switch" を実行することで、強制的に更新することもできます：

SYNOPSIS

ローカルブラウザ：

Browser open browser=<browser_code> [url=<web_page>] [args=<CLI_arguments>] [opt-<name>=<value>]

リモート・ブラウザ：

Browser open browserName=<browser_code> hub=<hub_address> [url=<;web_page>]

すでに開いているブラウザで新しい URL を開く：

Browser open url=<webpage> [target=<self|window|tab>]

*赤色は必須パラメータ

オプション

browser=<browser_code>

– ブラウザのコードネーム。現在サポートされている値は以下の通りです：

• "ie" - Microsoft Internet Explorer

• "edge" - Microsoft Edge

• "firefox" - Firefox (Gecko)

• “chrome" - Google Chrome

• "safari" - Safari（Mac OS X）

• "chromium" - プラグインのインストールが必要 Chromium Web Driver プラグインがインストールされている必要があります (v7.0+)

url=<ウェブページ>

• 読み込むウェブページ。例："https://www.t-plan.com"。

args=<CLI_引数>

• ブラウザの種類によってサポートされている場合、ブラウザプロセスに渡される CLI 引数。v7.0 からサポートされています。詳細は seleniumの説明を参照してください。

opt-<名前>=<値>

• ブラウザの種類がサポートしている場合に、ブラウザプロセスに渡されるプリファレンス値。v7.0 からサポートされています。例えば、Chromeは "download.default_directory" 環境設定を使ってデフォルトのダウンロードディレクトリを設定します。ダウンロードを C:\MyStuff にリダイレクトするには、opt-download.default_directory="C:\MyStuff" を 使用してください。

hub=<ハブアドレス>

• Selenium Grid の ハブアドレス。

browserName=<browser_name>

• ハブが認識するブラウザ名。

target=<self|window|tab>

• 指定したウェブページを開く場所。"self" (現在のウィンドウで開く)、"window" または "tab" (新しいウィンドウ/タブで開く) のいずれか。デフォルト値は "self"。v8 以降でサポートされています。

Browser find  [timeout=<time_interval>]  [elaction=<action>]  [elnumber=<element_number>]  [eltext=<text>]  [elindex=<dropdown_item_index>]  [elvalue=<dropdown_item_value>] [continue=<true|false>]  [<attributes>]

オプション

timeout=<time_value>

– 要素を探し続ける任意の時間です。。有効な time_valuesでなければなりません。

• タイムアウトが指定されていない場合、コマンドは要素を一度だけ探します。

• タイムアウトが指定され、それが0より大きい場合、コマンドは時間が経過するか要素が見つかるまで要素を探し続けます。

elaction=<アクション>

– 結果の要素に適用するオプションのアクション。検索によって複数の要素が生成された場合、elnumberパラメータを使用してターゲット要素を選択することができます。サポートされるアクションは以下の通りです：

• "click" - 要素をクリックします。リンクやボタンなどのクリック可能な要素にのみ適用されます。

• “type" -eltextパラメータで指定したテキストを入力します。text要素にのみ適用されます。

• "clear" - 要素のテキストをクリアします。text要素にのみ適用されます。

• "submit" - フォームを送信します。

• "select" - 表示テキスト（eltext）、項目インデックス（elindex）、または "option" HTMLタグの "value " 属性で指定された値（elvalue）のいずれかによって、ドロップダウン項目を選択します。

elnumber=<要素番号>

– elaction で指定されたアクションで対象とする要素の序数。デフォルト値は1です(最初の要素を使用します)。要素数が elnumber より小さい場合、コマンドはエラーを投げます。

eltext=<テキスト>

– elaction アクションが "type" の場合、パラメータはtext要素に入力するテキストを指定します。アクションが "select" の場合、パラメータは選択されるドロップダウンの可視テキストを指定するために使用されます。 elaction=type パラメータとともに使用する必要があります。

elindex=<dropdown_item_index>

– 選択するドロップダウン項目のインデックス。インデックスは0から始まります。”select" HTML タグで表されるドロップダウン要素にのみ適用可能。

elvalue=<ドロップダウン項目の値>

– 検索・選択されるドロップダウン項目の値。”option" HTMLタグの "value "属性で指定します。ドロップダウン要素（"select" HTML タグ）にのみ適用可能。

continue=<true|false>

– 失敗した場合の処理方法を指定します。要素が見つからず、このパラメータが指定されていないか false の 場合、コマンドはスクリプトを終了します。このパラメータがtrueの場合、スクリプトの続行が許可され、コマンドは0以外の終了コードを返します。

-次のような name=value ペアの形式の属性 (検索条件) のリスト：

• "xpath=<xpath_expression>" XPath式による検索を行います。このオプションを使用する場合、他の属性を指定することはできません。

• "css=<css_selector> CSS セレクタで検索します。このオプションを使用する場合、他の属性を指定することはできません。

• "id=<element_id>" 要素IDで検索します。

• "class=<class(es)>" CSS クラス、または要素が属するクラスの空白区切りのリスト。

• "tagname=<tag_name>" ”a", "div", "img" などの HTML タグ名。

• "text=<text>"正確な要素テキスト。

• "parttext=<partial_text>"-". テキストが指定された部分テキストを含む要素を検索します。要素のテキストは親要素に継承されるため、これらの基準は一意ではないことに注意してください。例えば、ページ全体のテキストを取得するには、"HTML" または "body" タグを検索します。

• "link=<link_text>" 指定されたテキストのリンクを検索します。

• "partlink=<partial_link_text>" テキストが指定された文字列を含むリンクを検索します。

• Selenium がサポートするパラメータに加えて、コマンドは任意の HTML タグの属性とその値を受け入れます。たとえば、フォームのボタンを名前で識別するにはname=<name> を使います。

HTML 属性の概要については Mozilla dev docs を 参照してください。属性のサポートはブラウザによって異なり、認識できないものもあります。

Browser switch[id=<window_ID>] [title=<title_or_part>] [number=<window_number>] [url=<URL_or_part>] [continue=<true|false>] です。

• タイトル、URL、番号、ウィンドウIDのいずれかで識別される特定のタブまたはウィンドウに切り替えます。識別パラメータが指定されていない場合、コマンドは browser_varsを更新します。

OPTIONS

id=<id=<window_ID>

• ウィンドウ/タブID。Seleniumが各タブやウィンドウに割り当てる一意の文字列です。ウィンドウ変数から利用可能なIDを取得する利ことができます　browser_vars.

title=<title_or_part>

• ウィンドウ/タブのタイトルまたはその一部。利用可能なタイトルの一覧は browser_vars を参照してください。タイトルの検索では大文字と小文字が区別されます。例えば、「Google」というタイトルのタブがある場合、title="Goo "を使ってそのタブに切り替えることができます。指定したタイトルに一致するタブが複数ある場合は、最初に見つかったタブが選択されます。一致するタブが見つからない場合、"continue=true "パラメータが指定されない限り、コマンドはスクリプトを終了します。

number=<window_number>

• 1(1)から始まるウィンドウ/タブの序数。ウィンドウの順番はSeleniumによって決定され、通常は作成された順番を反映します。現在利用可能なウィンドウの数は_BROWSER_WINDOW_COUNTbrowser_varsによって反映されます。 利用可能なウィンドウの数が要求された数より少ない場合、"continue=true" パラメータが指定されない限り、コマンドはスクリプトを終了します。

url=<URL_or_part>

• ウィンドウ/タブのURLまたはその一部。利用可能なURLの一覧は browser_vars を参照してください。検索では大文字と小文字が区別されます。例えば、"https://www.google.com" のタブがある場合、url="google "を使って切り替えることができます。指定したタイトルに一致するタブが複数ある場合は、最初に見つかったものが選択されます。一致するタブが見つからない場合、"continue=true "パラメータが指定されない限り、コマンドはスクリプトを終了します。

continue=<true|false>

• 失敗時の処理方法を指定する。ターゲットウィンドウまたはタブが見つからず、このパラメータが指定されていないか、falseの 場合、コマンドはスクリプトを終了します。このパラメータがtrueの場合、スクリプトの続行が許可され、コマンドは0以外の終了コードを返します。

Browser close
*赤色は必須パラメータを示します。

オプション

scope=<tab|all>

• 閉じるスコープ。all" はデフォルトで、ブラウザ全体 (すべてのタブとウィンドウ) を閉じ、Selenium 接続を終了します。tab "の値は、現在のタブまたはウィンドウだけを閉じ、残りのタブまたはウィンドウがない場合にのみ接続を終了します。

例

Browser open browser=edge url="https://t-plan.com"

3.1.3 Connect

説明

Connect - デスクトップに接続する。プロトコル、ホスト名または IP アドレス、オプションのポートが引数 URL に指定されます。接続が確立されると、暗黙の変数_MACHINE と_DISPLAY の暗黙の変数が更新されます。

サーバー接続のための中央障害ポイントの設定方法については、 DisconnectFallback Fallback Procedures を参照してください。

SYNOPSIS

connect <URL> [user=<user>] [password=<password>] [force=<false|true>] [onpass=<command>] [onfail=<command>] [params=<parameters>] [paramseparator=<delimeter>]

• 赤は必須パラメータを示します。
  

オプション

URL

-引数は既知の connectionmanager (v4.2以降)、または <protocol>://<host_or_IP>[:<port>] の形式で有効なURLでなければなりません。プロトコルは、サポートされているプロトコルコードのいずれかと等しくなければなりません。T-Plan Robotはデフォルトで7つのクライアント (プロトコル) をサポートしています：

1. RFB (Remote Frame Buffer) v3.3クライアント (プロトコルコード "rfb")。これはVirtual Network ComputingまたはVNCとしてよく知られています。このクライアントは互換性があり、TightVNC、RealVNC、UltraVNC などの RFB v3.3 準拠のVNCサーバーに接続できます。テスト環境は Release Notes#vnc ドキュメントを参照してください。クライアントの実装の詳細は vnc.

2. Static Image (プロトコルコード "file"; v2.2以降) では、ファイルから画像を読み込み、ライブデスクトップと同じようにテストすることができます。クライアントは、PNG、BMP、WBMP、GIF など、Javaに準拠したすべてのロスレス画像フォーマットをサポートしています。ファイルが更新されるとクライアントが画像を再読み込みするメカニズムがあるので、ファイルシステム内の画像にグラフィカルな出力を生成するアプリケーションのテストにも使用できます。接続 URL は "file://<image_path>" という標準的な形式で、相対パスや ZIP ファイルやJARファイルにバンドルされた画像を特別に扱います。詳細は staticimage.

3. Android over ADB（プロトコルコード "adb"、3.1以降）により、Android Debug Bridge（ADB）経由でAndroidデバイスを自動化できます。詳細は android.

4. ローカルデスクトップ（プロトコルコード「java」、3.2以降）では、ローカルデスクトップ上に表示されるアプリケーションやシステムコンポーネントを自動化できます。詳細は local.

5. iOS Mirror（プロトコルコード "apple"、3.3以降）では、AirPlayスクリーンミラーリングとVNCサーバーを組み合わせて、iOSデバイス（iPhone、iPad）を自動化できます。プレーンなVNC接続と比較して、このソリューションは画面パフォーマンスが非常に速く、ゲームやグラフィックプログラムなどのOpenGLコンテンツをサポートしています。詳細は ios.

6. iOS Over Xcode （プロトコルコード "xcode"、4.3.1以降）は、WiFiネットワークとLightning USBケーブルを介してMac OS Xマシンの両方に接続されたiOSデバイスの自動化を可能にします。詳細は xcode.

7. RDP Server （プロトコルコード "rdp"、4.3以降）は、Microsoft Terminal Servicesとしても知られるRDPプロトコルによる自動化をサポートします。詳細は rdp.

ポートが明示的に指定されていない場合、デフォルトはプロトコル固有のウェルノウンポートになります。例えば、RFB/VNCサーバーはデフォルトで5900番ポート、Java RMIは1099番ポート、RDP（Windows Terminal Services）は 3389 番ポートで起動します。Linux/Unix上で動作するVNCに接続したい場合、デフォルトのRFBポートはX-Windowsサーバーによって占有されているため、通常は5901以上のポートを指定する必要があります。

URL にプロトコルが省略されている場合、スクリプトのデフォルトはRFB（VNC）である。この場合、ポート番号は、ポート番号から5900を引いた表示番号として扱われます。直接ポートを指定する場合は、ダブルコロンで指定します。例えば、"localhost:1 "と "localhost::5901" の両方は、ポート5901 で動作する同じローカルVNCサーバーを参照します。標準的なURL形式の同じアドレスは、"rfb://localhost:5901" です。

user=<username>
デスクトップを認証するためのユーザー名(ID)。このパラメータは将来の使用やサードパーティの拡張のために予約されており、現在サポートされているプロトコルでは使用されません。

password=<password>
デスクトップサーバーを認証するためのパスワード。サーバーがパスワードを必要としないように構成されている場合、このパラメータは無視されます。

force=<false|true>

同じサーバーとポート(ディスプレイ)がすでに接続されている場合、再接続は行われません(force=false)。現在の接続を強制的に終了してサーバーに再接続するには、このパラメータをtrueに設定します。デフォルト値は false です。

onpass=<コマンド>
。サーバーへの接続に成功したときに実行するコマンド。単一のコマンドでなければなりません。一連のコマンドを呼び出すには、プロシージャまたは後続のIf/Else Statementコマンドの終了コードをテストします。

onfail=<command>
-Connectが接続に失敗したときに実行するコマンド。単一のコマンドでなければなりません。一連のコマンドを呼び出すには、プロシージャまたは後続のIf/Else Statementコマンドの終了コードをテストする。

params=<param_name_and_value_pairs>
-カスタムクライアントパラメータのリスト。このオプションは、paramseparator オプションと一緒に、現在サポートされているプロトコルでは使用されておらず、将来の使用やカスタム拡張のために予約されています。これらは、サードパーティのクライアントプラグインへの汎用的なログインデータの転送をサポートするためのものです。リストには、カンマ(',')または paramseparator 引数で指定されたカスタムセパレータで区切られた、任意の数のパラメータ名と値のペアを含めることができます。

例えば、2つのパラメータ PARAM_A=value_A と PARAM_B=value_B を指定する場合、引数は "PARAM_A,value_A,PARAM_B,value_B" のようになります。
paramseparator=<delimeter>
-params 引数で指定されたパラメータ名と値のリストのためのオプションのセパレータ。指定しない場合、デフォルトはカンマ(",")。

戻り値

コマンドは、成功すると 0 (ゼロ) を返し、指定されていない理由で接続に失敗すると 1 を返します。UltraVNCサーバがMSログオンを要求するなど、サポートされていない認証方法で失敗した場合、コマンドは値10を返します。

例

Connect rfb://localhost:5901 password=テスト

Connect localhost:1 password=テスト

Connect localhost::5901 password=テスト

これら3つの例はすべて同じで、ローカルマシンのディスプレイ番号1(ポート5901)で動作するVNCサーバーに接続されています。パスワード認証は期待されます。これはLinux/Unixシステムで典型的で、ポート5900は通常X-Windowsサーバーが占有し、VNCサーバーは通常ポート5901以上で動作します。

Connect "Local VNC"

• connectionmanagerに登録されている「ローカルVNC」接続に接続します。サーバーURLとパスワードは接続レコードから読み込まれます。

Connect rfb://mywindows.companyxy.com:5902 password=mypassword force=true onfail="exit 2"

-mywindows.companyxy.com というサーバー上で動作しているRFB（VNC）サーバーに接続します。ツールがすでにこのサーバーに接続されている場合は、セッションを終了して再接続する。接続に失敗した場合は、終了コード 2 でスクリプトの実行を終了します。

Connect File://C:￤Screen.png

• 指定された画像を読み込み、デスクトップの代わりに表示します。

Connect file://C:￤testdata￤mages￤images.jar!/data/screen.png

• 指定したJARファイル(ZIPも可)内の/data/screen.pngとしてzip圧縮された画像を読み込み、デスクトップの代わりに表示します。

Connect file://screen.png

• 指定された画像を読み込み、デスクトップの代わりに表示する。URLは相対URLのため、画像は製品のインストールパスから読み込まれます。

Connect file://{_SCRIPT_DIR}/screen.png

• このコマンドを呼び出しているスクリプトと同じフォルダにある画像を読み込んで、デスクトップの代わりに表示します。

Connect rfb://mywindows.companyxy.com:5902 password=mypassword force=true onfail="exit 2"

-mywindows.companyxy.comというサーバー上で動いているRFB（VNC）サーバーに接続する。ツールがすでにこのサーバーに接続されている場合は、セッションを終了して再接続する。接続に失敗した場合は、終了コード 2 でスクリプトの実行を終了します。

Connect adb://default

• USBケーブルでローカルPCに接続された最初のAndroidデバイスに接続します。

Connect adb://MB104PY14322

• 指定したシリアル番号のAndroid端末にUSBケーブルで接続します。

Connect java://localhost

• ローカルのデスクトップに接続します。

Connect apple://192.168.1.2:5901

-iOSデバイスに ios 接続します。この例では、デバイスがネットワークに接続され、指定されたIPアドレスを持ち、5901番ポートでVNCサーバーを実行していると仮定しています。

3.1.4 Disconnect

説明

Disconnect - デスクトップ・サーバとの接続を切断します。接続がない場合、コマンドは何もしません。接続が切断されると、定義済みの変数 _MACHINE と _DISPLAY はクリアされます。

利用方法

disconnect

戻り値

このコマンドは、切断に成功すると0（ゼロ）を返し、切断に失敗すると1を返します。

例

Disconnect

-現在接続しているデスクトップから切断します。

3.1.5 ジェスチャー

ジェスチャー - タッチスクリーンジェスチャーをデザインして実行します（v6.2以降）。これは、以下のようなモバイルデバイス接続でのみサポートされています：

• Android Over ADB

• xcode

このコマンドは以下の動作をサポートします：

• Gesture press 指定した位置で指を押したことをジェスチャバッファに記録します。

• Gesture Move 指定した指の新しい場所への移動（ドラッグ）を記録します。

• Gesture Release 指定した指のリリースを記録します。

• Gesture Save 指定した名前でジェスチャを保存し、ジェスチャバッファをクリアする。

• Gesture Execute 接続デバイス上でジェスチャを実行し、ジェスチャバッファをクリアする。

• Gesture Clear ジェスチャバッファをクリアして、新しいジェスチャを設計できる状態にします。これは保存されたジェスチャには影響しません。バッファはデフォルトで "ジェスチャ実行"および "ジェスチャ保存"によってバッファがクリアされるので、通常はこのコマンドは必要ありません。

典型的なジェスチャーのシナリオ

1. 押す」、「動かす」、「離す」のアクションを組み合わせてジェスチャーをデザインします。複数の指を使うジェスチャーは、常に並行して実行されます。例えば、1本指のL字ドラッグなどです：

   JS

   Gesture press finger=0 to=x:200,y:200
   Gesture move finger=0 to=x:200,y:500
   Gesture move finger=0 to=x:350,y:500
   Gesture release finger=0 

2. 一度だけのジェスチャーはすぐに実行され、破棄されることがあります：

   JS

   Gesture execute 

3. ジェスチャーを再利用したい場合は、まずジェスチャーを保存し、いつでも名前を付けて実行できます：

   JS

   Gesture save name=L-shape
   Gesture execute name=L-shape

4. 保存されたジェスチャーは、カスタム位置から開始することができます。 デフォルトのジェスチャー開始位置は、最も低い指IDの「プレス」位置です（通常は指番号0ですが、許可された範囲内で任意の指番号を付けることができます）。たとえば、この例では [200,200] です。350,200]より右から開始させるには、次のようにします：

   JS

   Gesture execute name=L-shape start=x:350,y:200

   移動したジェスチャーがスクリーンに収まることを確認してください。そうしないと、このコマンドはジェスチャをスクリーン境界にトリミングし、ジェスチャの機能を変更する可能性があります。

SYNOPSIS

press finger=<fingerID> to=x:<X-coordinate>,y:<Y-coordinate>
*赤い色は必須パラメータを示します。

オプション

finger=<指ID>

• 指のID。サポートされる指の最大数は接続とデバイスに依存しますが、通常は5以上です。

to=x:<X座標>,y:<Y座標>

• 指を押す位置。

move finger=<fingerID> to=x:<X-coordinate>,y:<Y-coordinate>
※ 赤色は必須パラメータです。

オプション

finger=<fingerID>

• 指のID。サポートされる指の最大数は接続とデバイスに依存しますが、通常は5以上です。

to=x:<X-座標>,y:<Y-座標>

• 最後の位置から指を移動（ドラッグ）する場所。

release finger=<fingerID>
*赤い色は必須パラメータを示します。

オプション

finger=<fingerID>

• 指のID。サポートされる指の最大数は接続とデバイスに依存しますが、通常は5以上です。

save name=<name> clear=<true|false>
※ 赤色は必須パラメータを示します。

オプション

name=<name>

• ジェスチャー名。ジェスチャー名は大文字と小文字を区別します。同じ名前を繰り返し使用すると、元のジェスチャーが上書きされます。

保存されたジェスチャーは、「clear」アクションやパラメータによって消去されることはありません。作成した時点からスクリプトが終了するまで使用できます。環境用の標準ジェスチャのセットを作成するには、名前を付けたジェスチャのライブラリ（スクリプト）を作成し、スクリプトにリンクするには Includeまたは Runコマンドを使用してスクリプトにリンクします。

clear=<false|true>

• ジェスチャバッファをクリアして、新しいジェスチャを設計できるようにするかどうかを示します。クリアすると、これまでに記録されたすべての「押す」「動かす」「離す」アクションが破棄されます。保存されたジェスチャには影響しません。デフォルト値は 'true' (バッファをクリア) です。

ジェスチャの実行 name=<name> start=x:<X-coordinate>,y:<Y-coordinate> duration=<time> clear=<true|false> count=<number> wait=<time>
*赤色は必須パラメータ

オプション

name=<名前>

• 実行するジェスチャー。スクリプトによって作成され、「Gesture save」によって保存された既存のジェスチャの名前でなければなりません。ジェスチャー名は大文字と小文字を区別します。

ジェスチャ名が指定されていない場合、コマンドはジェスチャバッファの内容を実行します、

start=x:<X座標>;,y:<Y座標>

• カスタム開始点からジェスチャを実行します。デフォルトのジェスチャ開始ポイントは、最も低い指IDの「押す」位置です（通常は指#0ですが、許可された範囲内で任意の指番号を付けることができます）。このパラメータを使用すると、画面上の別の場所からジェスチャーを実行できます。

再配置されたジェスチャーがスクリーンにフィットしない場合、コマンドはそれをスクリーンの境界線にトリミングします。これは予期しない結果につながる可能性があります。

duration=<時間>

• ジェスチャの継続時間。値はミリ秒か有効な時間でなければなりません。Time Values.デフォルト値は 500 ミリ秒 (0.5 秒) です。

clear=<false|true>

• ジェスチャバッファをクリアして、新しいジェスチャを設計できるようにするかどうかを示します。クリアすると、これまでに記録されたすべての「押す」「動かす」「離す」アクションが破棄されます。保存されたジェスチャには影響しません。デフォルト値は 'true' (バッファをクリア) です。

count=<数値>

• ジェスチャを実行する回数。デフォルト値は1（1回実行）。

wait=<時間>

• ジェスチャが実行された後に待つ時間。次のコマンドが「Wait <time>」であった場合と同じ効果があります。値はミリ秒数か有効な値でなければなりません。Time Values. デフォルト値は0（待機しない）です。スクリプトは、_GESTURE_WAIT 変数に希望の遅延を設定することで、デフォルト値を設定できます。

Gesture clear
*赤色は必須パラメータを示します。

オプション

なし。

例

Gesture press finger=0 to=x:125,y:202
Gesture release finger=0 
Gesture save name=press
Gesture execute name=press duration=1s

– 指定した場所を1秒間長押しする。

Gesture press finger=0 to=x:300,y:200
Gesture press finger=1 to=x:100,y:500
Gesture move finger=1 to=x:500,y:500まで
Gesture release finger=1
Gesture release finger=0 
Gesture save name=rotate
Gesture execute name=rotate

• 一本の指を長押ししながら、もう一本の指をその下の水平方向にドラッグする。

• これは例えばGoogleマップを回転させます。

3.1.6 モバイル

モバイルコマンドは7.1からサポートされている。このコマンドは Android Over ADB および xcode 接続でモバイル固有の機能を提供します。

このコマンドは、別々の製品として提供されていた従来の Androidと iOSの 拡張機能（プラグイン）に取って代わるものです。その目的は、モバイルデバイスの自動化のための共通言語を提供し、プラグインのインストールによるオーバーヘッドを回避することです。iOSとAndroidのオペレーティングシステムの性質が異なるため、すべてのモバイルコマンド機能が両方の接続で同じようにサポートされているわけではありません。例えば、ファイルのダウンロードとアップロードはAndroidでのみサポートされ、キーボードマップの操作はiOSに固有です。両プラットフォームを対象とした単一のスクリプトを作成する場合は、本文書の機能互換性に関する注意事項に注意してください。

サポートされている操作の完全なリストは次のとおりです：

このコマンドは、レガシープラグインの拡張機能に加え、モバイル検索と呼ばれる新機能を提供します。これは、属性（テキスト、タイプなど）によってデバイス画面上のUIコンポーネントを特定し、そのプロパティを取得し、オプションでアクションを適用（クリック）することができます。これは、iOSとAndroidがXMLドキュメントの形でUIコンポーネントのツリーを取得する機能に基づいています。これは Browser コマンドがSelenium駆動のウェブブラウザでコンポーネントを特定するのとよく似ています。

• Mobile findの利点は信頼性である。とは異なり Image Search V2 (または Text OCR (“tocr”) と異なり、画面上の標準的なUIコンポーネントをより正確かつ確実に特定することができます。

• 欠点は、スピード （XML階層の検索が遅い）と、グラフィカル出力（ゲーム）やモバイルウェブブラウザコンテンツのようなカスタムコンテンツを識別できないことです。

コンポーネントを識別するために使用されるアルゴリズムは、次のような画像比較コマンドにもさらされます。 Compareto Command と Waitfor Command と呼ばれるメソッドとして"モバイル".passrate"パラメータは使用されず、このメソッドでは無視されます。将来のリリースで変更される可能性がありますが、"cmparea "も無視されます。

SYNOPSIS

Mobile alert action=get

-モバイルデバイスの画面上にアラートウィンドウがあるかどうかをテストします。

Mobile alert action=dismiss [button=<button>] [text=<text_to_type>] [accept=<true|false>].

• アラートを解除する。アラートがない場合は何もしません。

オプション

action=<get|dimiss>

• アラートアクション名。現在サポートされている値は以下の通りです：

• "get" - モバイルデバイスにアラートが表示されているかどうかをテストします。アラートがある場合、このメソッドは_MOBILE_ALERT_TEXT、_MOBILE_ALERT_BUTTON_COUNT、_MOBILE_ALERT_BUTTON[n]変数にアラートテキストとボタンの数、およびそれらのラベルを入力します。

• "dismiss" - アラートを終了します。オプションで、ボタン、テキスト 、およびaccept パラメータを使用してアラートを閉じる方法を指定できます。
  

button=<ボタン>

• アラートを解除するボタンの名前(オプション)。以前の「モバイルアラート action=get」の呼び出しによって_MOBILE_ALERT_BUTTON[n]変数に格納されたボタン名のいずれかを使用することができます。ボタンが指定されていない場合、コマンドは1つを選択します。

text=<text_to_type>

• アラートを解除する前にアラートのテキストフィールドに入力するテキスト(オプション)。アラートにテキストフィールドがない場合、このパラメータは無視されます。

accept=<true|false>

• ボタンが指定されていない場合、このパラメータを使用して、アラートを受け入れるかキャンセルするかを指定します。これはアラートに2つ以上のボタン（例えば「OK」と「キャンセル」）が含まれている場合にのみ考慮されます。このパラメータが省略された場合、コマンドはアラートを閉じる方法を選択します。

戻り値：

「get」アクションはアラートがなければ0、警告がなければ1を返します。「解散」アクションは、アラート解散に成功した場合に0を返し、そうでなければ1を返します。

Mobile app

戻り値

このコマンドは常に0を返します。

Mobile find [timeout=<time_interval>] [action=<action>] [number=<element_number>]【continue=<true|false>】【<attributes>】。

• 端末画面上のUI要素を指定された属性で検索 し、オプションでクリックします。要素の属性は、_MOBIlE _FIND接頭辞を持つ変数に格納されます。 クリックが必要な場合は、continueパラメータを使用して、要素が見つからないときにスクリプトをクラッシュさせるか、続行させるかを決定します。

要素検索アルゴリズムは、次のような画像比較コマンドにも公開されています。 Compareto と Waitfor. mobile "と呼ばれるメソッドを探してください。

オプション

timeout=<時間値>

• 要素を探し続けるオプションの時間。有効な time_values.

• タイムアウトが指定されない場合、コマンドは要素を一度だけ探します。

• タイムアウトが指定され、それが0より大きい場合、コマンドは時間が経過するか要素が見つかるまで要素を探し続けます。

action=<アクション>

• 結果の要素に適用するオプションのアクション。検索によって複数の要素が生成された場合は、numberパラメータを使用してターゲット要素を選択できます。サポートされるアクションは以下のとおりです：

• "click" - 要素をクリックします。リンクやボタンなどのクリック可能な要素にのみ適用されます。

number=<要素番号>

• actionで指定したアクションで対象とする要素の序数。デフォルト値は1(最初の要素を使用)。要素数がnumberより小さい場合、コマンドはエラーを投げてスクリプトを終了します。

continue=<true|false>

• 失敗した場合の処理方法を指定します。要素が見つからず、このパラメータが指定されていない場合、またはfalseの 場合、コマンドはスクリプトを終了します。このパラメータがtrueの場合、スクリプトの続行が許可され、コマンドは0以外の終了コードを返します。

<属性>

-属性（検索条件）のリスト：

• "xpath=<xpath_expression>" のようなname=valueペアの形式の属性（検索条件）のリスト。 XPath式による検索を行います。このオプションを使用する場合、他の属性を指定することはできません。

• "type=<button|input|text>" を指定します。 要素のタイプ。"button" (任意の認識されたタイプの標準ボタン)、"input" (編集可能なテキストコンポーネント)、または "text" (静的テキストを表示するコンポーネント) のいずれか。

• "text=<text>"正確には要素のテキスト。

• "parttext=<partial_text>"-". 指定された部分テキストをテキストに含む要素を検索します。上記のパラメータに加えて、コマンドは任意のUI階層ツリーの属性とその値を受け付けます。このような検索は、iOSまたはAndroidに固有のものとなります。例えば、現在Androidにフォーカスしているものを特定するにはfocused=trueを使用します。

戻り値：

actionパラメータなしで呼び出された場合、このコマンドは少なくとも 1 つの要素が見つかれば 0 を返し、見つからなければ 1 を返します。特定された要素の数は _MOBILE_FIND_COUNT 変数に格納され、個々の要素の属性は
MOBILEFIND_ 接頭辞を持つ番号付き変数として公開されます。

actionパラメータが存在し、アクションが要素に正常に適用されると、コマンドは0を返します：

• continueが 指定されていないかfalseの 場合、コマンドはエラーを投げてスクリプトを終了します。

• continueがtrueの場合、スクリプトの実行は続行され、コマンドは 1 (要素が見つからなかった) または 2 (番号で指定した要素と一致する要素が見つからなかった) を返します。

Mobile install [file=<app_file>] [reinstall=<true|false>]

*赤色は必須パラメータ

• 指定されたローカルファイルからアプリケーションをデバイスにインストールします。成功すると、コマンドは _MOBILE_INSTALLED_ID 変数にアプリケーションIDを格納し、これを使用してアプリケーションを起動、終了、アンインストールします。

OPTIONS

file=<アプリファイル>

• Androidアプリケーション・ファイル（.apk）へのパス。

reinstall=<true|false>

• trueを指定すると、アプリがすでにデバイスに存在する場合、強制的に再インストールされます。

を返します：

コマンドは、正常に完了した場合は 0 を返し、そうでない場合はエラーをスローしてスクリプトを終了します。

Mobile keyboard action=get

• 変数 _MOBILE_KEYBOARD_VISIBLE にtrue/falseを代入し、ソフトキーボードが表示されているかどうかを示します。このコマンドは0を返すか、キーボードのステータスの決定に失敗した場合（サポートされていないOS、...）スクリプトを終了します。

Mobile keyboard action=show

-Androidのみ：デバイスにソフトキーボードを表示しようと試み、その結果を終了コードで示します。この機能は、編集可能なUIコンポーネントが現在フォーカスされているかなどの条件に左右されるため、失敗することが多いことに注意してください。結果のリターンコードを必ずテストしてください。コマンドは、キーボードのステータスを決定するのに失敗した場合（サポートされていないOS、...）、エラーを投げてスクリプトを終了することがあります。

Mobile keyboard action=dismiss  [keys=<semicolon_separated_list>]

• デバイス上に現在表示されているソフトキーボードの終了を試み、その結果を終了コードで示します。keysパラメータはiOSでのみ必要で、Androidでは不要で無視されることに注意してください。このコマンドは、キーボードの状態を判断できない場合（サポートされていないOSなど）、エラーを投げてスクリプトを終了することがあります。

Mobile keyboard action=load [file=<map_file>]。

-iOSのみ：保存されているキーボードマップを 読み込みます 。ファイルが利用できないか、形式が正しくない場合、コマンドはエラーを投げてスクリプトを終了します。

Mobile keyboard action=remap

-iOSのみ：現在表示されているソフトキーボードを即座にリマップします。ソフトキーボードが表示されていないか、予期しないエラーが発生した場合、コマンドはエラーをスローし、スクリプトを終了します。

*赤色は必須パラメータです。

オプション

action=<get|show|dismiss|load|remap>

• アクション名。"get"、"show"、"dismiss"、"load"、"remap "のいずれか。

file=<マップファイル>

• キーボードマップファイル (.keymap) へのパス。

keys=<セミコロンで区切られたキー>

• キーボードを閉じるためにタップするセミコロンで区切られたキー名のリスト。このパラメータはiOSでのみ必要で、Androidでは無視されます。

を返します：

返される終了コードとエラースローについては、各アクションの説明を参照してください。

Mobile kill [id=<application_id>] [force=<true|false>] [timeout=<time_interval>] [log=<true|false>]

-指定したアプリケーションを終了させるか、最終的にバックグラウンドに送ります。

オプション

id=<アプリケーションID>

• アプリケーションID。iOSの場合はアプリケーションバンドル名で、例えばSafariブラウザの場合は"com.apple.mobilesafari "と なります。Androidでは、Chromeアプリの"com.android.chrome "の ようにアプリケーションパッケージのみ（"kill "アクションと "uninstall " アクション）、または "com.android.chrome/com.google.android.apps.chrome.Main "のようにパッケージの後にスラッシュとアクティビティ（"start " アクション）が続きます。 アプリケーションIDが指定されていない場合、コマンドは、"Mobile install"（Androidのみ）の呼び出しによって最近インストールされたアプリケーション、または"Mobile app "の 呼び出しによって提供されたアプリケーションを強制終了します。 MOBILE_ACTIVE_ID変数).現在表示されているアプリを終了するには、"Mobile app "コマンドと"Mobile kill "コマンドを連続して使用します。アプリケーションIDが解決できない場合、コマンドはエラーを投げてスクリプトを終了します。

force=<true|false>

• trueを指定すると、コマンドはアプリを強制終了させようとします。内部実装はターゲットOSに依存するため、このフラグが無視されることもあります。デフォルト値はtrueです。

timeout=<時間値>

• シェルコマンドが終了するまでの待機時間(オプション)。有効なtime_values.シェルコマンドによってアプリが強制終了されるAndroidでのみ使用されます。iOSでは無視されます。

log=<true|false>

• trueを指定すると、デバッグのために操作の出力を実行ログに記録します。デフォルト値はfalseです。

を返します：

コマンドは 0 を返します。

Mobile orientation action=get

- MOBILE_SCREEN_ORIENTATION_NAME 変数と _MOBILE_SCREEN_ORIENTATION 変数に、現在の画面の向きの名前とコードを代入します。名前は「Portrait」（コード0）、「LandscapeLeft」（1）、「UpsideDown」（2）、「LandscapeRight」（3）。

Mobile orientation action=set [set=<orientation>]

• 赤は必須パラメータ

• 画面の向きを設定し、"get "アクションと同じ変数を入力します。

オプション

action=<get|set>

• アクション名。"get "または"set "のいずれか。

set=<オリエンテーション>

• 名前または数値コードで特定されるターゲット方向。使用可能な値は、"Portrait"(コード0)、"LandscapeLeft"(1)、"UpsideDown"(2)、および"LandscapeRight"(3)です。Androidは、画面の向きをジャイロスコープが示す向きにリセットする「Auto」（コード4）もサポートしています。

戻り値：

コマンドは 0 を返す。

Mobile pull [remote=<リモートファイル>] [local=<ローカルファイル>］

*赤色は必須パラメータ

-Androidのみ：デバイスからローカルファイルシステムにファイルをプル（ダウンロード）します。

オプション

remote=<リモートファイル>

• デバイス上のファイル。

local=<ローカルファイル>

• ローカルファイルシステム内のファイル。

を返す：

コマンドは成功すると0を返し、失敗するとエラーを投げてスクリプトを終了します。

Mobile push [local=<local_file>] [remote=<remote_file>]

*赤色は必須パラメータ

-Androidのみ：デバイスにファイルをプッシュ（アップロード）します。

オプション

local=<ローカルファイル>

• ローカルファイルシステム内のファイル。

remote=<リモートファイル>

• デバイス上のファイル。

戻り値：

コマンドは成功すると0を返し、失敗するとエラーを投げてスクリプトを終了します。

Mobile shell [command=<command>] [remote=<remote_file>] [timeout=<time_interval>] [log=<true|false>]

*赤色は必須パラメータ

-Androidのみ：デバイス上でシェルコマンドを実行する。コマンド出力は_MOBILE_OUTPUT変数に格納されます。

オプション

command=<コマンド>

• 実行するシェルコマンド。

timeout=<時間値>

• シェルコマンドが終了するまでの待機時間(オプション)。有効な time_values.

log=<true|false>

• trueを指定すると、デバッグのために操作の出力を実行ログに記録します。デフォルト値はfalse です。

を返します：

コマンドは成功すると0を返し、失敗するとエラーを投げてスクリプトを終了します。

Mobile start [id=<application_id>] [timeout=<time_interval>] [log=<true|false>]

• デバイス上でアプリケーションを起動する。タイムアウトが指定されない限り、アプリの起動コマンドはキックオフされますが、アプリが正しく表示されるかどうかを確認する努力は行われません。コマンドは終了コードによって、起動処理が正しく実行されたかどうかを示し MOBILE_OUTPUT変数にエラー出力を入力します。アプリが起動して画面に表示されたことを確認するには、タイムアウトパラメーターを使用します。

OPTIONS

id=<アプリケーションID>

• アプリケーションID。iOSの場合はアプリケーションバンドル名で、例えばSafariブラウザの場合は"com.apple.mobilesafari "と なります。Androidの場合は、パッケージの後にスラッシュとアクティビティが続く必要があります。AndroidでアプリケーションIDが指定されていない場合、コマンドは「Mobile install」の呼び出しによって最近インストールされたアプリケーションを起動します（IDは IDは_MOBILE_INSTALLED_ID変数から取得されます）。アプリケーションIDが解決できない場合、コマンドはエラーを投げてスクリプトを終了します。

timeout=<時間値>

• シェルコマンドが終了するまでの待機時間(オプション)。有効な time_values.

log=<true|false>

• trueを指定すると、デバッグのために操作の出力を実行ログに記録します。デフォルト値はfalseです。

戻り値：

タイムアウトパラメータが指定されていない場合、または 0 に設定されている場合、コマンドはアプリケー ションをキックオフして 0 を返します。

タイムアウトが 設定されると、コマンドは、指定された時間内にアクティブなアプリと引数のidをテストすることで、アプリが起動し、画面に表示されていることを確認します。アプリが表示されない場合は、エラーがスローされ、スクリプトが終了します。

Mobile uninstall [id=<application_id>]

-Androidのみ：デバイスからアプリケーションをアンインストールします。操作に失敗した場合、_MOBILE_OUTPUT 変数にその理由が入力されます。

オプション

id=<アプリケーションID>

• アプリケーションID。Chromeアプリの場合は "com.android.chrome " の ようにAndroidアプリのパッケージのみ、または "com.android.chrome/com.google.android.apps.chrome.Main "のようにパッケージの後にスラッシュとアクティビティ（"start "アクション）が続く。アプリケーションIDが指定されていない場合、コマンドは「Mobile install」の 呼び出しによって最近インストールされたアプリケーションをアンインストールします（IDは 変数 _MOBILE_INSTALLED_ID から取得されます。).現在表示されているアプリをアンインストールするには、「Mobile app」と「Mobile uninstall id="{_MOBILE_ACTIVE_ID}"」の一連のコマンドを使用します。アプリケーション ID が解決できない場合、コマンドはエラーを投げてスクリプトを終了します。

戻り値：

このコマンドは、成功すると 0 を返し、失敗すると 1 を返します。アプリ ID を解決できない場合、または予期しない I/O エラーが発生した場合は、エラーをスローしてスクリプトを終了します。

3.1.7 Mouse

説明

Mouse - マウス・イベントを実行します。このコマンドは、マウス・ポインタの移動、マウス・クリック、マウス・プレス、マウス・リリース、ドラッグ、マウス・ホイール・イベントなど、さまざまなマウス・アクションを自動化することができます。このコマンドは、マウス押下、マウス移動、マウスリリースイベントのシーケンスで構成されるカスタムドラッグにも対応しています(2.0.2以降)。構成されたイベント（クリック、ドラッグ）が失敗する場合は、マウスコマンドの環境設定でキャリブレーションパラメータを確認してください。

現在のマウスポインタの座標は、スクリプトの_MOUSE_X and _MOUSE_Y dynamic variables を通して利用できます。

SYNOPSIS

mouse [<modifier_1>+...+<modifier_N>+] <event_id> [btn=<button_name>] [modifiers=<modifier_1>+...+<modifier_N>] [to=[x:<x>][,y:<y>]] [from=[x:<x>][,y:<y>]]  [center=[x:<x>][,y:<y>]]  [start=<number>]  [end=<number]  [count=<number>] [wait=<time>]

• 赤色は必須パラメーターを示します。

オプション

modifier

-Shift、Alt、Ctrlをプラス「+」記号で区切った任意の組み合わせ。

event_id

-サポートされるイベント

• • "move"、任意の移動先からターゲットポイントへのマウスポインタの移動、

  • "click"、指定されたマウスボタンを使用したターゲットポイントでの1回以上のクリック、

  • "press"、マウスボタンの押下（リリースなし）、

  • "release"、マウスボタンのリリース（論理的には、その前に押下イベントが必要）、

  • “drag” 指定されたマウスボタンを使って、任意の移動先からターゲットポイントまでマウスをドラッグします、

  • “swipe”、タッチディスプレイを持つデバイス(AndroidやiOSデバイスなど)のためにタイミングを調整したマウスドラッグ、

  • “wheelup”、1つまたは複数のマウスホイールの回転ステップを上向きにする(ホイールがユーザーから離れる方向に回転する)、”

  • “wheeldown”、1つまたは複数のマウスホイールの回転ステップを下向きにする(ホイールがユーザーに向かって回転する)、

  • "pinch"、2本の指がタッチスクリーン上で共有された中心点に向かって移動する1つ以上のピンチイベント（"pinch close "とも呼ばれる）。このイベントは特定の環境でのみサポートされています。ios接続タイプ、

  • "zoom"、2本の指がタッチスクリーン上の共有中心点から離れる1つ以上のズームイベント（"pinch open "とも呼ばれる）。このイベントは特定の環境でのみサポートされています。ios 接続タイプで接続されている T-Plan Server を実行している Apple iOS デバイスなどでサポートされています。

btn

-このパラメータは、クリック、プレス、リリース、またはドラッグするマウスボタンを識別するために使用されます。許可される値は"left"、"middle"、"right "です。

修飾子

-このパラメータは、マウスイベントの修飾子を指定する別の方法を提供します（もう1つの方法は、イベントIDの前に修飾子を置くことです）。値はShift、Alt、Ctrlの任意の組み合わせで、「Ctrl+Alt+Shift」のようにプラス「+」記号で区切って指定します。修飾子がイベント ID と一緒に指定されている場合は、このパラメータが優先されます。

to=[x:<x>][,y:<y>]

-ターゲット座標。

• • イベントが "move "の場合、マウスポインタの移動先（ターゲットポイント）を定義します。

  • イベントが "click"、"press"、"release"、"wheelup"、または "wheeldown "の場合、マウスポインタはまずこの位置に移動され、関連するアクションが実行されます。

  • アクションが "drag "または "swipe "の場合、マウスポインタは実際の位置から(またはfromオプションで指定された位置から)このターゲット位置までドラッグされる。

座標は'x:<x>,y:<y>' の書式を持ち、各座標はピクセル単位（例えば'x:225'）またはパーセント単位（例えば'x:23%'）で指定できます。x または y が省略された場合、現在のマウスポインタの位置が不足する座標の決定に使用されます。

from=[x:<x>][,y:<y>]

-開始座標。

• アクションが"drag "または"swipe "の場合、マウスポインタはこの位置からtoオプションで指定された座標までドラッグされます。

• イベントが"click"、"press"、"release"、"wheelup"、"wheeldown "の場合、このパラメータは無視されます。

座標は'x:<x>,y:<y>' の書式を持ち、各座標はピクセルで指定するか（'x:225'など）、パーセンテージで相対的に指定します（'x:23.5%'など）。相対座標が整数でない場合は丸められます。x または y が省略された場合、現在のマウスポインタの位置が不足する座標の決定に使用されます。

center=[x:<x>][,y:<y>]

-ピンチ/ズームの中心点(オプション)。ピンチ」および「ズーム」アクションにのみ使用されます。パラメータが省略された場合、アクションのデフォルトは画面中央になります。

座標は'x:<x>,y:<y>'の形式で、ピクセル単位（'x:225'など）または相対座標（'x:23.5%'など）で指定します。相対座標が整数でない場合は丸められます。x または y が省略された場合、現在のマウスポインタの位置が不足する座標の決定に使用されます。

start=<number> end=<number>

-ピンチ/ズームの開始距離と終了距離。pinch" と "zoom" アクションにのみ使用されます。パラメータは常に一緒に指定する必要があります。省略した場合、アクションは中心点の位置と現在のスクリーンサイズに基づいてデフォルト値を計算します。

距離は、ジェスチャーの開始時（"start"）と終了時（"end"）に指が何ピクセル離れているかを指定します。
イベントが "pinch "の場合、指が互いに近づくため、開始時の距離は終了時の距離よりも当然大きくなければなりません。
ズーム "イベントの場合は逆の設定が必要です。距離は、指が互いに近づきすぎないように（最低でも 30 ピクセル）、または画面の境界線に 10 ピクセル以上近づかないように指定する必要があります。

count=<数値>

-マウスイベントを何回実行するか。デフォルト値は1。この値はclick、wheel、pinch、zoomイベントでのみ意味を持ち、他のイベントタイプでは無視されます。

wait=<time>

-イベント送信後の待ち時間。以下のコマンドが'Wait <time>' であった場合と同じ効果を持つ。値はミリ秒数か有効な値でなりません。Time Values.デフォルト値は0（待機しない）です。スクリプトは、"Var _MOUSE_WAIT=1s" のように、_MOUSE_WAIT変数に希望する遅延時間を代入してデフォルト値を設定することができます。

戻り値：
コマンドは成功すると0（ゼロ）を返し、I/Oエラーなどで失敗すると1を返します。

例

Mouse click count=2

• 現在のマウスポインタ座標でマウスをダブルクリックする。

Mouse move to=x:25,y:122

• マウスポインタを指定された座標に移動する。

Mouse move to=x:{_MOUSE_X}+50

• マウスポインタを現在の位置から右に50ピクセル移動する。

Mouse drag from=x:10%,y:450 to=x:22.5%,y:450 wait=2s

• マウスポインタを指定された開始位置から目的位置までドラッグし、2秒間待ちます。x座標は相対形式で指定します。ディスプレイの解像度が例えば800x600ピクセルの場合、'x:10%'は'x:60'に、'x:22.5%'は'x:135'になります。

Mouse swipe from=x:161,y:124 to=x:161,y:226

• タッチスクリーンを開始位置から目的位置までスワイプする。

Compareto "icon.png" method=search onfail="Exit 1"
Mouse move to=x:{_SEARCH_X}+10,y:{_SEARCH_Y}+10
Mouse press 
Mouse move to=x:{_SEARCH_X}+110 wait=500
Mouse release

{画像比較によって位置が特定されたオブジェクトに適用される「合成ドラッグ」の例。スクリプトはまず、icon.png テンプレートで表されたオブジェクトをデスクトップから探します。見つかったら、マウスポインタをその領域（各方向にプラス10ピクセル）に移動させ、押下、移動、リリースイベントのシーケンスを使ってオブジェクトを右に100ピクセルドラッグします。

Mouse pinch

• 画面をピンチする。現在の接続がピンチをサポートしている場合、現在のアプリケーションがズームアウトされます。

Mouse zoom center=x:220,y:450 start=125 end=180

• 画面を拡大します。現在の接続がピンチに対応している場合、現在のアプリケーションを拡大表示します。このコマンドは、カスタム中心点と開始距離と終了距離を使用します。

3.1.8 Paste

Paste - システムのクリップボードを使ってテキストをペースト（挿入）します。キーボードでテキストを一文字ずつ入力する代わりに、このコマンドはテキストをクリップボードにコピーし、Ctrl+V（Mac OS XではCommand+V）を押してシステムの貼り付けアクションをトリガーすることをシミュレートします。これは、Type/Typelineでキーボードからテキストを入力するよりもはるかに高速です。

このコマンドは、以下のようなクリップボード操作をサポートしている接続を対象としています。local のようなクリップボード操作をサポートしている接続を対象とします。それ以外の接続の場合、コマンドは黙ってTypeコマンドの機能に戻ります。

SYNOPSIS

paste <text>[wait=<time>] [count=<number>]

• 赤は必須パラメータを示します。

オプション

text

-貼り付けるテキスト。テキストにスペースまたは等号「=」が含まれる場合は、二重引用符で囲む必要があります。 「これはスペースを含むテキストです。」テキストに二重引用符文字を含める必要がある場合は、その前にバックスラッシュを置きます。 「これは二重引用符 - \"" です。バックスラッシュの後に二重引用符を表示する必要がある場合は、「\\"」を使用します。 "これはバックスラッシュの後に二重引用符が続きます - \\""。

サポートされているテキスト文字は、デスクトップクライアント（プロトコル）によって制限されます。たとえば、RFB（VNC）プロトコルは、Latin-1（ISO 8859-1）文字セット以外の文字を転送できません。逆に、ネイティブJavaクライアントは、文字セットに関係なく、ローカルのキーボードで生成できる文字だけを転送することができます。詳細については、特定のクライアントのドキュメントをお読みください。

wait=<time>

-テキストが貼り付けられた後の待ち時間。テキストが貼り付けられた後の待機時間。これは、次のコマンドが'Wait <time>と言った場合と同じ効果を持ちます。値はミリ秒数か有効なTime Valuesでなければなりません。.

count=<数値>

-コマンドを何回繰り返すかです。デフォルト値は1 (1回だけ貼り付ける)。

戻り値

コマンドは成功すると0（ゼロ）を返し、I/Oエラーなどで失敗すると1を返します。

例

Paste "hello world!"

-'hello world!' を貼り付ける。

3.1.9 Press

説明

Press - キーをデスクトップに送る。キーボードのキーを押すことに似ています。

SYNOPSIS

press [<modifier_1>+...+<modifier_N>+]<key | modifier> [location=<standard|numpad|left|right>] [release=<true|false>] [count=<number>] [wait=<time>]

• 赤は必須パラメータです

オプション

key

-押すべきキーボードのキーの名前。ほとんどのキー名はキーボードに書かれているものに対応しています。例えば'A'、'Insert'、'Tab'などです。キーは修飾子のみで構成されることもあります。キーの大文字と小文字は区別されず、どのような文字でも指定することができます。

キー名は、java.awt.event.KeyEventクラスで宣言されているVK_キーコード定数から内部的に派生します。例えば、VK_ENTER定数があるので、キー名は "ENTER"、"Enter"、"enter "となります。キー名は実行時にJava Reflection APIを使用してKeyEventクラスから抽出されるため、T-Plan Robotを実行するJavaのバージョンによってサポートされるキーの範囲が異なる場合があります。サポートされるキー名の完全な マップは Supported Keys Windowから取得できます。

キーの前には、プラス「+」記号で区切られたShift、Alt、Ctrl修飾子の任意の組み合わせを付けることができます（例：「Ctrl+Alt+Delete」）。修飾名は大文字と小文字を区別しません。

修飾名は特定の物理キーに対応するものであり、それらが表す文字に対応するものではないことに注意してください。例えば、標準的な「-」マイナスキーを押すと、数字キーとは異なる内部キーコードが生成されます。これらの2つのケースは、「Press -」（標準）と「Press SUBTRACT location=numpad」（numpad）という2つのPressコマンドでも表すことができます。ほとんどの場合、ターゲットシステムはこれらを同じように解釈するが、失敗する場合もあります。例えば、コントロールプラス（「Press Ctrl++」）は、[Press Ctrl, Press '+', Release '+', Release Ctrl]というシーケンスとして生成されます。このようなキーの組み合わせは、標準の'+'ASCII文字(0x2b)を取得するためにShiftキーも押す必要があるUSキーボードでは作成不可能であるため、このシーケンスはデスクトップによって正しく解釈されるかもしれませんし、解釈されないかもしれません。キーが認識されない場合は、代わりにテンキー（「Press Ctrl+ADD location=numpad」）を使ってみてください。特定の数字キーのキー名を取得するには、「Supported Keys」ウィンドウを開き、「Press a key...」テキストフィールドにフォーカスがある状態で押してください。location=numpadパラメータを指定することが推奨されますが、それがなくても動作する場合もあります。

このコマンドは、2.0.3以降、キー名以外にほとんどのASCII文字も受け付けます。”Press * “や”Press @”といったコマンドの使用も可能です。さらに、localion="numpad" パラメータによって、これらの文字を数字キーボードにマッピングすることもできます。例えば、テンキーの "0 "キーを押すには、"Press NUMPAD0 "を呼び出す必要がありましたが、新しいバージョンでは、より直感的な "Press 0 location=numpad "もサポートしています。これは、ADD（プラス'+'）、SUBTRACT（マイナス'-'）、MULTIPLY（アスタリスク'*'）、DIVIDE（スラッシュ'/'）、DECIMAL（ピリオド'.'）、SEPARATOR（カンマ','）などの他のテンキーにも適用されます。

転送可能なキーとキーの組み合わせは、デスクトップクライアント(プロトコル)によって 適用される制限に従います。例えば、RFB (VNC)プロトコルは、Latin-1 (ISO 8859-1)文字セット以外の文字を転送できず、WinやContextMenuのようなWindowsネイティブキーのサポートは、一部の製品でのみサポートされています。逆に、ネイティブJavaクライアントは、文字セットに関係なく、ローカルのキーボードで生成できる文字だけを転送することができます。詳細は Release Notes や特定のクライアントのドキュメントを読んでください。

location=<standard|numpad|left|right>

-キーの位置。このオプションが意味を持つのは、一般的なキーボードに複数回存在するキーだけです。そのようなキーの例としては、数字キー '0'-'9' (標準の位置とテンキー) や修飾キー (キーボード左右の Ctrl と Alt) があります。サポートされている位置の値は、標準（デフォルト）、テンキー、左、右です。このコマンドは、[key,location]ペアが意味を持つかどうかを検証しないことに注意。例えば、アルファベット文字はほとんどのキーボードに一度だけ存在し、論理的に有効な位置はデフォルトの標準のものだけです。しかし、ほとんどのクライアントは、locationをヒントとしてのみ使用し、適用できないキーでは無視します。

release=<true|false>

-2.3.4からサポート。このパラメータがある場合、コマンドは完全なプレリリースシーケンスの代わりに、キープレス(release=false)またはキーリリース(release=true)だけを実行します。これにより、長いキー押下や、押下とマウスの複合イベントを自動化することができます。このパラメータを使って押下をシミュレートする場合は、キーが不要になったときに適切にキーをリリースするようにしてください。

count=<数値>

-キーを何回送るべきか。。デフォルト値は1。複数の押下アクション間の遅延は、Press Command ユーザー設定の値によって定義されます。

wait=<時間>

-イベント送信後の待機時間。このパラメータは、押されたキー/キーにサーバーが反応するまでに時間が必要な場合に便利です。これは、以下のコマンドが'Wait <time>'.値はミリ秒か有効な値でなりません。Time Values.デフォルト値は0（待機しない）です。スクリプトは、"Var _PRESS_WAIT=1s" のように、_PRESS_WAIT変数に希望する遅延時間を代入することで、デフォルト値を設定することができます。

戻り値
コマンドは成功すると0（ゼロ）を返し、失敗すると1を返します。

例

Press Ctrl+Alt+Del

• デスクトップで Ctrl+Alt+Del キーを押す。

Press Tab count=5 wait=2s

• Tabキーを5回押し、2秒間待ってから次のコマンドに進む。

Press Ctrl location=right

• 右のCtrlキーを押す。

Var KEY_TO_PRESS=Alt+F4
<...>
Waitfor update area=x:340,y:220,w:240,h:160 extent=80% timeout=10s ontimeout="Var KEY_TO_PRESS=Right"
Press {KEY_TO_PRESS} wait=2s

• この例は、不要なポップアップ・ウィンドウを解決する方法を示しています。与えられた座標にウィンドウがポップアップしたら、'Press {KEY_TO_PRESS}''コマンドはAlt+F4を使って確実に閉じます。ウィンドウが表示されない場合、Altキーが押されますが、通常ウィンドウに害はありません。

3.1.10 Type, Typeline

説明

Type, Typeline - デスクトップ上にテキストを入力します。Typelineコマンドはテキストを入力してEnterを押すだけの便利なコマンドです。これは'Type <text>' と'Press Enter' の組み合わせと同じ効果があります。

SYNOPSIS

type <text> [wait=<time>] [count=<number>]
typeline <text> [wait=<time>] [count=<number>]

• 赤い色は必須パラメーターを示します。

オプション

text

-入力するテキスト。テキストにスペースまたは等号「=」が含まれる場合は、二重引用符で囲む必要があります。 「これはスペースを含むテキストです。」テキストに二重引用符文字を含める必要がある場合は、その前にバックスラッシュを置きます。 「これは二重引用符 - "" です。バックスラッシュの後に二重引用符を表示する必要がある場合は、「\"」を使用します。 "これはバックスラッシュの後に二重引用符が続きます - \""。

サポートされているテキスト文字は、デスクトップクライアント（プロトコル）によって制限されます。たとえば、RFB（VNC）プロトコルは、Latin-1（ISO 8859-1）文字セット以外の文字を転送できません。逆に、ネイティブJavaクライアントは、文字セットに関係なく、ローカルのキーボードで生成できる文字だけを転送することができます。詳細については、特定のクライアントのドキュメントをお読みください。

wait=<time>

-テキスト入力後の待機時間。このパラメータは、押されたキーにサーバーが反応するまでに時間が必要な場合に便利です。次のコマンドが「Wait <time>」であった場合と同じ効果があります。値はミリ秒単位の数値または有効なtime valueで指定する必要があります。デフォルト値は0（待機しない）です。スクリプトは、_TYPE_WAITまたは _TYPELINE_WAIT 変数に希望する遅延時間を設定することで、デフォルト値を設定することができます。

location=<standard|numpad|left|right>

-キーの位置。指定すると、コマンドは入力された文字を指定されたキーボードの位置にマッピングしようとします。サポートされている位置の値は標準(デフォルト)、テンキー、左、右ですが、このオプションが意味を持つのは、コマンドが受け付ける文字を含む唯一のキーボード部分であるテンキーだけです。

このパラメータのサポートは、モバイルデバイスのテストを容易にすることを意図しています。モバイルデバイス（特に携帯電話）の数字キーは多くの場合テンキーにマッピングされており、Pressコマンドで各キー入力を処理するのは不便です。例えば、携帯電話で電話番号+0123456789を入力して電話をかけるには、単に「Typeline +0123456789 location=numpad」と単純に記述できます。。

count=<数字>

-コマンドを何回繰り返すか。デフォルト値は1 (テキストを入力する/行を入力するのは1回だけ)。

戻り値

コマンドは成功すると0（ゼロ）を返し、I/Oエラーなどで失敗すると1を返します。

例

Type hello

• hello'とタイプする。

Typeline "mkdir /tmp/mydir" wait=2s

• アクティブな Linux/Unix ターミナルウィンドウでこのコマンドを実行すると、OS コマンド'mkdir /tmp/mydir'が起動し、次のコマンドに進む前に2秒間待つ。

Type "100*4" location=numpad

• 数字キーボードで数式を入力する。

Typeline "+111222333444" location=numpad

• 数字キーボードに数式を入力し、Enterを押す。テスト対象のシステムが、Symbian OSを搭載したNokia携帯電話など、テンキーにキーボードがマッピングされた携帯端末の場合、指定した番号に電話をかけます。

3.2 管理・実行制御コマンド

3.2.1 Alert

説明

Alert - ローカルマシンにアラートウィンドウをポップアップします。ウィンドウはカスタムボタンや編集可能なフィールドを含むようにカスタマイズすることができます。また、指定されたタイムアウト後に自己消滅させることもできます。

コマンドは以下の変数を入力：

SYNOPSIS

Alert <text> [title=<text>] [buttons=<list>] [fields=<list>] [values=<list>] [timeout=<time_value>] [location=x：<x_coord>,y:<y_coord>] [size=w:<width>,h:<height>]

• 赤色は必須パラメータ

オプション

<text>

-表示するテキスト。<html>で始まる場合はHTMLコードとして扱われます。

title=<text>

-ウィンドウタイトル（オプション）。

buttons=<list>

-ボタンのラベル、またはセミコロンで区切られたボタン名のリスト(オプション)。選択されたボタンの名前は_ALERT_BUTTON変数に返されます。パラメータが指定されない場合、ウィンドウには1つの「OK」ボタンが含まれます。

fields=<list>

-セミコロンで区切られたテキストフィールド名のリスト(オプション)。これにより、ユーザに値または値のセットを入力させるクエリを設計することができます。

values=<list>

-fields "で指定されたテキストフィールドの値をセミコロンで区切ったリスト（オプション）。同じ長さでなければならなりません。

timeout=<time_value>

-ウィンドウ処理のタイムアウト(オプション)。 time valueで指定する必要があります。指定しない場合、ウィンドウはユーザーが閉じるまで表示され続けます。。

location=x:<x_coord>,y:<y_coord>

-例えば "x:100,y:100"。7.0.4以降では、Xおよび/またはY座標は、現在のスクリーンサイズに対するパーセンテージとして指定することもできます。場所が指定されない場合、ウィンドウは画面の中央に配置されます。

size=w:<width>,h:<height>

-w:300,h:350 "のようなウィンドウサイズ(オプション)。例えば "w:300,h:350"。7.0.4以降では、幅や高さを現在のスクリーンサイズに対するパーセンテージで指定することもできます。サイズが指定されない場合、ウィンドウはコンテンツに合うようにサイズ調整されます。

戻り値

コマンドは選択されたボタンの番号を返します。

例

Alert "<html><body><center><h1>Login</h1></center>Please enter your credentials:</body></html>" buttons="OK;Cancel" fields="User name;Password"
if ("{_ALERT_BUTTON}" == "OK") {
   Var user="{_ALERT_FIELD_1}"
   Var password="{_ALERT_FIELD_2}"
   // Login code here
}

• ログイン・ウィンドウの例。アラートは次のようになります：

3.2.2 Break

説明

Break - 最も内側のforループを終了し、ループを囲む右中括弧 '}' の後の最初のコマンドに進みます。このコマンドをforループの外で使用すると、構文エラーが報告されます。

forコマンドをブレークせずに現在のループをスキップするには Continue コマンドを使用します。

SYNOPSIS

ブレーク

戻り値

このコマンドは終了コードを変更せず、前に実行されたコマンドによって返された値のままにします。

例

# 無限ループ
for(; 0 == 0; ) {

# リモート画面の更新を少なくとも20%待つ。
# 10秒間更新されない場合はループを中断します
 Waitfor update extent=20% timeout="10s" ontimeout="break"
}

• forとbreakを組み合わせて使う、Waitfor Commandと break を組み合わせて、リモートデスクトップが更新を停止するまで実行を保持します。

3.2.3 Click

説明

ClickはWaitfor matchとMouseコマンドの組み合わせです。コンポーネント画像、ソリッドカラーオブジェクト、またはテキストをデスクトップから探してクリックします。オブジェクトが見つからない場合はスクリプトを終了します。

SYNOPSIS

Click <comparison_method> [timeout=<time>] [cmparea=<[x:<x>][,y:<y>][,w:<width>][,h：<height>]>] [number=<component_number>] [btn=<button>][modifiers=<modifiers>] [count=<number>] [wait=<time>][<method specific options>]

• 赤色は必須パラメーターを示します

comparison_method

-サポートされているメソッドは以下の通り：

• 'image'(画像) - コンポーネントを画像もしくはImage Collectionsメソッドを使ってImage Search V2 メソッドを使用します、

• 'object' - メソッドを使って色でコンポーネントを検索します。Object Search ("object")メソッドを使用します、

• 'ocr' - OCR (tocr メソッド) を使用して画面上のテキストを認識し、指定された文字列またはパターンを見つけます。

共通オプション

timeout=<time>

-コンポーネントが画面に表示されるまでの最大待機時間を指定するタイムアウト。値はミリ秒単位の数値または有効なTime Valuesでなければなりません。デフォルト値は30秒です。

cmparea=[x:<x>],[y:<y>],[w:<width>],[h:<height>]

-比較を制限するデスクトップの矩形領域。このパラメータを省略すると、リモート デスクトップ全体が処理されます。領域の座標は「x:<x>,y:<y>,w:<width>,h:<height>」のフォーマットで、各座標はピクセル単位（例えば「x:225」）またはパーセント単位（「x:23%」）で指定できます。x,y,width,heightのいずれかが省略された場合、T-Plan Robotはフルスクリーンの値を用いて不足するパラメータを決定します(x:0, y:0, w:<screen_width>, h:<screen_height>)。

number=<component_number>

• クリックを適用する画面上のコンポーネントの番号。画面上のコンポーネント(オブジェクト)は、上から下、左から右の順にソートされます。デフォルト値は1（最初にあるコンポーネントをクリック）です。画面上で見つかったコンポーネントの数が指定した数より少ない場合、コマンドはスクリプトを終了します。

move=[x:<x>],[y:<y>]

-ターゲットオブジェクトの中心からの相対的なクリック位置を指定します(4.2以降)。これにより、オブジェクトそのものではなく、近くの場所をクリックすることができます。比較対象が画像の場合、このパラメータは画像を上書きします。Image Meta Dataを上書きし、画像の中心を基準点として使用します。例えば、"Click image template=button.png move=x:-40 "のコマンドは、ボタンの中心から40ピクセル左をクリックします。

btn=<ボタン>

-クリックするマウスボタン。指定可能な値は "left"、"middle" および "right" です。

modifiers=<修飾子>

-マウスイベント修飾子(オプション)。値はShift、Alt、Ctrlの任意の組み合わせで、「Ctrl+Alt+Shift」のようにプラス「+」記号で区切ります。

count=<数値>

-クリックする回数。デフォルト値は1。

continue=<数字>

-trueを指定すると、オブジェクトが見つからなかった場合にスクリプトを終了しない(4.2以降)。デフォルト値はfalse（失敗時に終了）。リリース4.4.2以降、コマンドは_CLICK_CONNECT変数の値も監視し、デフォルト値として使用します。例えば、スクリプト内のすべてのClickコマンドをデフォルトで終了させないようにするには、最初にこの変数をtrueに設定します("Var _CLICK_CONTINUE=true")。

step=<ステップ名>

-コマンドとのシンプルな統合。Stepコマンドとのシンプルな統合(4.2以降)。指定された場合、指定された名前のテストステップを作成し、結果は合格（オブジェクトが見つかりクリックされた）または不合格（オブジェクトが見つからなかった）です。

wait=<時間>

-クリック後の待ち時間。次のコマンドが「Wait <time_in_ms>」であった場合と同じ効果を持つ。値はミリ秒数か有効な値でなければならない。Time Values.デフォルト値は0（待機しない）である。スクリプトは、"Var _CLICK_WAIT=1s "のように、_CLICK_WAIT変数に希望の遅延を代入することでデフォルト値を設定することができます。

Click image template=<image_collection> [passrate=<pass_rate_in_%>] [<searchv2_specific_params>] [<click_common_params>]

• 赤色は必須パラメーターを示します。

特定のオプション - image

template=<image_collection>

-画像コレクション(Image Collections)- リモートデスクトップ画像と比較する、セミコロン（;）で区切られた1つ以上の画像ファイル名または画像を含むフォルダ。Linux/Unixでは、リストが誤って解析されるため、ファイル名にセミコロンを含めないでください。ファイル名は相対パス（例: img.png）または絶対パス（例: /root/report/img.png）のいずれでも指定可能です。相対パスを使用する場合、画像は_template_dirで定義されたディレクトリ内で検索されます。サポートされる画像形式はJavaのバージョンに依存します。Java 1.6では少なくともPNG、JPG、GIF、BMPがサポートされています。

テンプレート画像は、指定されたリスト順序でリモートデスクトップ画像と比較されます。テンプレートの比較で肯定的な結果（指定されたイベントに応じて、一致または不一致のいずれか）が得られた場合、条件は満たされたとみなされ、コマンドは終了コード0で終了し、リスト内の残りのテンプレートをスキップします。定義済み変数 _COMPARETO_TEMPLATE_INDEX は、マッチするテンプレート画像のインデックスを決定するために使われます。対応する変数の一覧は画像比較固有の変数を参照してください。

passrate=<pass_rate_in%>

-画像比較の通過率。0から100の間の数値を指定し、その後にパーセンテージを指定することもできます(例: "passrate=95 "または "passrate=95%")。このパラメータが省略された場合、デフォルトのsearch2通過率50%が使用されます。

search2_specific_params

-比較メソッドでサポートされるsearch2比較メソッドでサポートされる任意のパラメータ（オプション）。

Click object [<object_specific_options>] [<common_options>]。

特定のオプション - オブジェクト

オブジェクト固有パラメータ

-オブジェクト比較メソッドでサポートされる任意のパラメータ（オプション）。通常、少なくともオブジェクトの色を指定する必要があります。

Click ocr [<ocr_specific_options>] [<common options>]。

特定のオプション - ocr

tocr_specific_options

-比較メソッドでサポートされる Text OCR ("tocr")比較メソッドでサポートされる任意のパラメータ。textまたはpatternオプションを通して、クリックを適用するターゲットテキストを指定する必要がある。

戻り値

このコマンドは成功すると常に0を返し、失敗すると指定された比較メソッドのエラーコードを返してスクリプトを終了します。

例

Click image template="google_button.png"number="2"

• 画面上のgoogle_button.png画像で指定された2番目のボタンをクリックします。ボタンが見つからない場合、または画面上のボタンの数が2つ以下の場合、コマンドはスクリプトに失敗します。

Click object tolerance="10" color="255;0;0" max="w:20"

• 赤色で幅が20ピクセル以下のオブジェクトをクリックします。トレランスは、メソッドがより多くの赤の色合いを見つけることを保証します。

Click ocr text="Cancel" distance="1"

• OCRを使って画面上のテキストを読み取り、"Cancel "という単語をクリックします。この距離により、OCR エンジンが、たとえば「Cancel」などの 1 文字を省略したり、認識できなかったりしても、単語が確実に検出されます。

3.2.4 Compareto

Compareto - Compareto コマンドは、現在のリモート・デスクトップ・イメージと、指定されたイメージ比較方法を使用した単一のイメージまたはimage collectionの比較を 1 回だけ実行するためのものです。オプションのアクションは、"onfail" と "onpass" パラメータ、または if/else 構造を使用したコマンド終了コードのテストにより、結果に基づいて実行されます。T-Plan Robot 4.4.2Betaには6つの画像比較メソッドがあります。Image Comparison Capabilities章で詳しく説明します：

1. 画像検索 v2 (search2v3.0以降)は "search "メソッドの後継で、テンプレート画像(複数可)で表されるオブジェクトをデスクトップ画面から許容範囲内で検索します。

2. 画像検索 (searchv2.0以降)は、テンプレート画像(複数可)で表されたオブジェクトを、デスクトップ画面から許容範囲内で検索します。

3. オブジェクト検索 (objectv2.2 以降) は、画面上のオブジェクトを、単一の RGB カラーまたは類似のカラー範囲で検索します。

4. テキストOCR (ocr 2.2 以降) は、選択した OCR エンジンを使用して、デスクトップ画像の光学式文字認識 (OCR) を実行します。

5. 画像ベースのテキスト認識 (text 3.0以降) は、事前に保存された文字画像のコレクションを使用して、画面からテキストを抽出します。

6. ヒストグラム・ベースの比較（codedefault v2.0以降)は、デスクトップ画像と指定されたテンプレート画像のヒストグラムを比較するレガシーアルゴリズムです。

メソッド固有の変数の他に、コマンドは以下のようにCOMPARETO接頭辞付き変数のセットを入力します：

このコマンドはさらに、定義されていれば画像コレクションからロードされた画像の処理順序を制御する1つの入力変数をサポートします：

画像比較をより信頼性の高いものにするために、この章で列挙されている要素を考慮してください。 Image Comparison Recommendations の章を参照してください。画像比較の中央障害点を設定する方法については、 ComparisonFailureFallbackを参照してください。 Fallback Procedures.

コマンドによって生成されたHTMLレポートに比較結果を表示するには Report コマンドによって生成される Screenshot.画面がテンプレート画像と一致するまで待ちたい場合は、'Waitfor match'. Screenshot と 'Waitfor match' の両コマンドは、内部的に Compareto コマンドのメソッドを使用し、同じパラメーターをサポートします。

SYNOPSIS

compareto <image_collection>[passrate=<pass_rate_in_%>] [onpass=<command>] [onfail=<command>] [method=<comparison_method>] [methodparams=<custom_params>] [cmparea=[x：<x>][,y:<y>][,w:<width>][,h:<height>]] [<method_specific_params>]

• 赤色は必須パラメーターを示します

オプション

image_collection

-Image Collections- リモートデスクトップイメージと比較する 1 つ以上のイメージファイル名、またはイメージをセミコロン (';') で区切ったフォルダ。Linux/Unix では、ファイル名にセミコロンが含まれていないことを確認してください。ファイル名には、相対パス（img.png など）または絶対パス（/root/report/img.png など）を指定できます。相対パスを使った場合、画像は_template_dir variable.サポートされる画像フォーマットは、Javaのバージョンに依存します。Java 1.6では、少なくともPNG、JPG、GIF、BMPをサポートしています。

テンプレート画像は、指定されたリスト順序でリモートデスクトップ画像と比較されます。テンプレートの比較で肯定的な結果（指定されたイベントに応じて、一致または不一致のいずれか）が得られた場合、条件は満たされたとみなされ、コマンドは終了コード0で終了し、リスト内の残りのテンプレートをスキップします。定義済み変数 _COMPARETO_TEMPLATE_INDEX は、マッチするテンプレート画像のインデックスを決定するために使われます。対応する変数の一覧はimage comparison variablesを参照してください。

passrate=<pass_rate_in_%>

-画像比較の通過率。これは0から100の間の数値でなければならず、その後にパーセンテージ文字(例えば "passrate=95 "や "passrate=95%")を付けることもできます。このパラメータが省略された場合、メソッドまたはRobot環境設定で定義されたデフォルトの通過率が使用されます（デフォルト値は "default "メソッドで95%、"search "および "search2 "メソッドで100%）。

onpass=<コマンド>

-比較が成功した（選択されたメソッドが成功を報告した）ときに実行されるコマンド。単一のコマンドでなければなりません。一連のコマンドを呼び出して、プロシージャまたは 後続の If/Else Statement コマンドの終了コードをテストします。

onfail=<コマンド>

-比較に失敗した（選択されたメソッドが失敗を報告した）ときに実行されるコマンド。これは1つのコマンドでなければなりません。実行される一連のコマンドを定義する必要がある場合は、プロシージャを使用してください。

method=<comparison_method>

-画像比較に使用するメソッド（アルゴリズム）。の章で説明されているサポートされているメソッド名（コード）のいずれかでなければなりません。Image Comparison Capabilities章で説明されているサポートされているメソッド名(コード)のいずれか、またはプラグインインターフェイスで有効になっているサードパーティのメソッド名でなければなりません。省略した場合、コマンドはデフォルトのものを使用します。

methodparams=<custom_params>

-画像比較アルゴリズムに渡すカスタムパラメータ。T-Plan Robot 2.0のデフォルトの画像比較アルゴリズムはカスタムパラメータをサポートしていませんので、独自のアルゴリズムを作成しない限り、このパラメータを指定する必要はありません。

cmparea=[x:<x>][,y:<y>][,w:<幅>][,h:<高さ］

-比較を制限するデスクトップの矩形領域。このパラメータを省略すると、リモートデスクトップ全体が処理されます。領域座標の形式は「x:,y:,w:,h:'」で、各座標はピクセル単位（例えば「x:225」）またはパーセント単位（「x:23%」）で指定できます。x,y,width,heightのいずれかが省略された場合、T-Plan Robotはフルスクリーンの値を用いて足りないパラメータを決定します(x:0, y:0, w:, h:)。

メソッド固有のパラメータ

-サポートされるメソッド固有のパラメータのリストについては、個々の comparison methods のドキュメントを参照してください。

戻り値

このコマンドは、比較が成功した場合は0（ゼロ）、失敗した場合は1、テンプレート画像が見つからないか読み込めない場合は2を返します。

例

Compareto netscape.png passrate=95% onfail="exit 1"

• 現在のリモートデスクトップの画像と画像 netscape.png を「デフォルト」の画像比較方法で比較します。95%以上一致しない場合は、Exitコマンドを使用してスクリプトの実行を終了し、終了コード1を返します。

Compareto button1.png;button2.png method=search
if({_EXIT_CODE} == 0) {
 Mouse click to="x:{_SEARCH_X}+5,y:{_SEARCH_Y}+5"
}

• リモート・デスクトップ画像を検索して、button1.png またはbutton2.png のいずれかに一致するボタンを探します。見つかったらクリックする。このコマンドは、ボタンの真ん中をクリックするように、xとyの座標に5ピクセルを加えます。

compareto "search.png" method="search"
for(i=1; {i}<{_SEARCH_MATCH_COUNT}+1; i={i}+1) {
  # 入れ子の変数は、接尾辞とインデックスの変数名で構成される
  Mouse click to=x：{_SEARCH_X_{i}},y:{_SEARCH_Y_{i}}
}

• search.pngテンプレート画像で表されるアイコンをリモートデスクトップ画像から検索し、出現したアイコンをクリックします。

Var _TOCR_LINE_COUNT=0
Compareto  method="tocr"cmparea="x:33,y:2,w:200,h:22"
for (i=1; {i}<{_TOCR_LINE_COUNT}+1; i={i}+1) {
  Typeline "{_TOCR_LINE{i}}"
}

• OCR を使用して指定されたデスクトップ領域からテキストを抽出し、デスクトップにタイプします。

Compareto  method="tocr"cmparea="x:33,y:2,w:200,h:22" pattern="[aA]pplication.*"
if ({_EXIT_CODE} > 0) {
  Exit 1
}

• Tesseract OCRで認識されたテキストが「Application」または「application」のどちらかで始まらない場合、正規表現を使ってスクリプトを終了します。

Compareto  method="object"color="FF0000" draw="true"

• 画面上のすべての赤色のオブジェクト（RGB = (256, 0, 0)）を見つけ、GUIでハイライトします。

Compareto circle.pngmethod="object"color="00FF00" tolerance="100" passrate="80%" draw="true" rotations="30"

• circle.pngの画像と80%以上似ている緑色のオブジェクトをすべて見つけ、GUIでハイライトします。toleranceパラメータは、許容可能な緑色のパレットのサイズを定義します。rotationsパラメータが30に設定されているので、アルゴリズムは12度ステップ（360度÷30）で回転したオブジェクトを画面上で検索します。

3.2.5 Continue

説明

continue - 現在の最も内側のforループの繰り返しをスキップします。このコマンドがforループの外で使用された場合、構文エラーが報告される。4.1.3からサポートされています。

forループ全体をブレーク（終了）するにはBreakコマンドを使用します。

SYNOPSIS

continue

戻り値

このコマンドは終了コードを変更せず、前に実行されたコマンドによって返された値を残します。

例

# ループが偶数になる毎にXをインクリメントする(結果のSUMは5になる)
Var SUM=0
for (i=0; i<10; i={i}+1) {
  if ({i} % 2 == 1) {
    continue
  }
  Eval SUM={SUM}+1 
}

3.2.6 Date

説明

Date - 日付の読み取り、書き込み、計算を行います。このコマンドは、現在の日付、または入力された日付を解析し、オプションで時刻の増減を行い、結果を指定されたフォーマットで_DATE変数、または指定されたカスタム変数に保存します。

コマンドはこれらの変数に入力します：

SYNOPSIS

date [date=<date>] [informat=<pattern>] [outformat=<pattern>] [add=<time_value>] [var=<name>] .

オプション

date=<日付>

• 入力日付文字列（オプション）。指定しない場合、コマンドは現在の日付をデフォルト値とします。

informat=<パターン>

• 入力された日付を解析するために使用されるjava.text.SimpleDateFormatに準拠したフォーマット(オプション)。指定されない場合、指定がない場合、コマンドはデフォルトでPreferences ウィンドウのLanguage 画面で指定された _DATE フォーマットを使用します。

outformat=<パターン>

• 出力日付に使用するjava.text.SimpleDateFormatに準拠したフォーマット(オプション)。指定しない場合、コマンドはデフォルトで Preferencesウィンドウの言語 画面で指定された _DATE 形式を使用します。

add=<時間値>

• 入力日付に加算または減算する時間値（オプション）。例えば「-1d」の値は1日を差し引きます。

var=<名前>

• 出力日付を保存する変数名(オプション)。デフォルトは_DATEです。

戻り値

コマンドは、フォーマットが無効であるか入力日付の解析に失敗した場合に1を返し、それ以外の場合は0（成功）を返します。

例

日付 outformat="EEEE d MMMM y" var="TODAY"

• 今日の日付を指定された形式でTODAY変数に保存します。例：「2020年5月13日（水曜日）」

日付 add="-1d" outformat="EEEE" var="YESTERDAY"

• 昨日の曜日名を「YESTERDAY」変数に保存する。例：「火曜日」。。

日付 date="2020-05-08T00:00:00.000Z" informat="yyyy-MM-dd'T'HH:mm:ss.SSS" outformat="d/M/y" var="ISODATE"

• 指定されたISO日付を解析し、単純な日/月/年のフォーマットで "ISODATE "変数に保存します。

3.2.7 Drag

説明

DragはWaitfor matchとMouseコマンドの組み合わせです。イメージ、ソリッドカラー、またはテキストによって ソースコンポーネントをデスクトップから検索し、相対座標で指定された場所、または別のイメージ検索で指定されたターゲットコンポーネントにドラッグします。オブジェクトが見つからない場合はスクリプトを終了します。

コマンドはClickとよく似ています。

SYNOPSIS

Drag <comparison_method>[shift=x:<relativeX>,y：<relativeY>] [template2=<target_component_template>] [number2=<target_component_number>] [timeout=<time>] [cmparea=<[x:<x>][,y:<y>][,w:<width>][,h：<height>]>] [number=<component_number>] [btn=<button>] [modifiers=<modifiers>] [count=<number>] [continue=<true|false>] [step=<step_name>] [wait=<time>] [<method specific options>]

• 赤色は必須パラメーターを示します。

comparison_method

-サポートされているメソッドは以下の通りです：

• 'image' - コンポーネントを画像もしくはImage Collectionsメソッドを使ってsearch2メソッドを使用します、

• 'object' - メソッドを使って色でコンポーネントを検索します。objectメソッドを使用します、

• 'ocr' - OCR（メソッド）を使って画面上のテキストを認識し、指定された文字列またはパターンを検索します。tocrメソッド）を使用して画面上のテキストを認識し、指定された文字列またはパターンを検索します。

コモンオプション

timeout=<時間>

-コンポーネントが画面に表示されるまでの最大待機時間を指定するタイムアウト。値はミリ秒数か有効な値でなければならない。Time Values.デフォルト値は30秒です。

cmparea=[x:<x>][,y:<y>][,w:<width>][,h:<height>]

-比較を制限するデスクトップの矩形領域。このパラメータを省略すると、リモートデスクトップ全体が処理されます。領域の座標は、'x:<x>,y:<y>,w:<width>,h:<height>'のフォーマットで、各座標はピクセル単位（例えば、"x:225"）またはパーセント単位（"x:23%"）で指定できます。x,y,width,heightのいずれかが省略された場合、Robotはフルスクリーンの値を使って足りないパラメータを決定します(x:0, y:0, w:<screen_width>, h:<screen_height>)。

number=<コンポーネント番号>

• ドラッグを適用するスクリーン上のソースコンポーネントの番号。画面上に配置されたコンポーネント（オブジェクト）は、上から下、左から右の読み順にソートされます。デフォルト値は1（最初に配置されたコンポーネントをドラッグ）です。画面上で見つかったコンポーネントの数が指定された数より少ない場合、コマンドはスクリプトを終了します。

move=[x:<x>][,y:<y>]

-ターゲットオブジェクトの中心からの相対的なマウス押下開始位置を指定します(4.2以降)。これにより、オブジェクトそのものではなく、近くの位置からドラッグを開始することができます。比較対象が画像の場合、このパラメータは画像を上書きしclick pointを上書きし、画像の中心を基点として使用します。例えば、"Drag image template=button.png move=x:-40 shift=x:100,y:100 "のコマンドは、ボタンの中心から左へ40ピクセルの位置からドラッグを開始します。

btn=<ボタン>

-ドラッグするマウスボタン。指定可能な値は "left"、"middle" および "right" です。

modifiers=<修飾子>

-ドラッグ中に保持する修飾子(オプション)。値は Shift、Alt、Ctrl の任意の組み合わせで、プラス「+」記号で区切って指定します (例: "Ctrl+Alt+Shift")。

shift=x:<相対X>,y:<相対Y>

-コンポーネントを現在の位置からドラッグする場所を指定する相対座標。ターゲット(ドロップ)位置はtemplate2で指定することもできます。

template2=<target_component_template>。

-ドロップコンポーネント。指定すると、コマンドはsearch2を使用して指定されたコンポーネントの画像検索を行い、その場所にオブジェクトをドラッグします。画面上に複数のドロップコンポーネントがある場合、number2 パラメータを使用してドロップコンポーネント番号を指定できます。template2 が指定されている場合、shift パラメータは存在してはなりません。

number2=<target_component_number>

-ターゲットコンポーネントの通常の番号。画面上に配置されたコンポーネント(オブジェクト)は、上から下、左から右の読み順にソートされます。デフォルト値は1（最初に配置されたコンポーネントにドロップ）。画面上で見つかったコンポーネントの数が指定された数より少ない場合、コマンドはスクリプトを終了する。template2パラメータと共にのみ使用します。

continue=<番号>

-trueを指定すると、オブジェクトが見つからなかった場合にスクリプトを終了しない(4.2以降)。デフォルト値はfalse（失敗時に終了）です。リリース4.4.2以降、コマンドは_DRAG_CONNECT変数の値も監視し、デフォルト値として使用します。たとえば、スクリプト内のすべての Drag コマンドをデフォルトで終了しないようにするには、最初にこの変数を true に設定します ("Var _DRAG_CONTINUE=true")。

step=<ステップ名>

-コマンドとのシンプルな統合。Step コマンドとのシンプルな統合(4.2以降)。指定された場合、指定された名前のテストステップを作成し、結果は合格（オブジェクトが見つかり、ドラッグされた）または不合格（オブジェクトが見つからなかった）です。

wait=<時間>

-クリック後の待ち時間。次のコマンドが 'Wait <time_in_ms>' である場合と同じ効果があります。値はミリ秒数か有効な値でなければなりません。Time Values.デフォルト値は0（待機しない）である。スクリプトは、"Var _DRAG_WAIT=1s "のように、_DRAG_WAIT変数に希望の遅延を代入することでデフォルト値を設定できます。

Drag image template=<image_collection>[passrate=<pass_rate_in_%>] [<search2_specific_params>] [<common_options>].

• 赤色は必須パラメータ

特定のオプション - image

template=<image_collection>

-テンプレートimage collection- リモートデスクトップのイメージと比較する 1 つ以上のイメージファイル名、またはイメージをセミコロン (';') で区切ったフォルダ。Linux/Unix では、ファイル名にセミコロンが含まれていないと、リストが正しく解析されません。ファイル名には、相対パス（img.png など）または絶対パス（/root/report/img.png など）を指定できます。相対パスを使った場合、画像は_TEMPLATE_DIR variable.サポートされる画像フォーマットは、Javaのバージョンに依存します。Java 1.6では、少なくともPNG、JPG、GIF、BMPをサポートしています。

テンプレート画像は、指定されたリスト順序でリモートデスクトップ画像と比較されます。テンプレートの比較で肯定的な結果（指定されたイベントに応じて、一致または不一致のいずれか）が得られた場合、条件は満たされたとみなされ、コマンドは終了コード0で終了し、リスト内の残りのテンプレートをスキップします。定義済み変数 _COMPARETO_TEMPLATE_INDEX は、マッチするテンプレート画像のインデックスを決定するために使われます。対応する変数の一覧は画像比較固有の変数を参照してください。

passrate=<pass_rate_in%>

-画像比較の通過率。0から100までの数値を指定し、その後にパーセンテージを指定することもできます(例: "passrate=95 "または "passrate=95%")。このパラメータが省略された場合、デフォルトのsearch2の通過率50%が使用されます。

search2_specific_params

• 比較メソッドでサポートされる任意のパラメータ。search2比較メソッドでサポートされる任意のパラメータ (オプション)。

Drag object [<object specific options>] [<common_options>].

特定のオプション - OBJECT

object_specific_params

• オブジェクト比較メソッドでサポートされる任意のパラメータ（オプション）。通常、少なくともオブジェクトの色を指定する必要があります。

Drag ocr [<tocr_specific_options>] [<common_options>].

特定のオプション - OCR

tocr_specific_options

-比較メソッドでサポートされるtocr比較メソッドでサポートされるパラメータ。textまたはpatternオプションを通して、クリックを適用するターゲットテキストを指定する必要があります。

戻り値

このコマンドは成功すると常に0を返し、失敗すると指定された比較メソッドからのエラーコードを返してスクリプトを終了します。

例

Drag image template="lever.png" shift="x:100"

• 画面上の最初のレバーのコンポーネントを見つけ、右に100ピクセルドラッグします。

Drag image template="column.png" number="2" template2="column.png" number2="3"

• 2つの表の列を入れ替える例。このコマンドは、表の2番目の列のヘッダーを見つけ、それを3番目の列の上にドラッグします。列が見つからなかったり、画面上の列の数が3より少なかったりすると、コマンドはスクリプトに失敗します。

Drag object tolerance="10" color="0;255;0" max="w:20,h:20" shift="x:50,y:-100"

• 20x20ピクセル以下の緑色のオブジェクトを見つけ、右方向に50ピクセル、上方向に100ピクセルドラッグする。トレランスは、このメソッドがより多くの緑の色合いを見つけることを保証します。

Drag ocr text="Flower" shift="y:220"

• OCRを使って画面上のテキストを読み取り、"Flower "という単語を220ピクセル下にドラッグします。

3.2.8 Eval

Eval - 値が数値式として評価されるスクリプト変数を定義します。詳しくはNumeric Expressionsの章を参照してください。それ以外の動作はVarコマンドと全く同じです。

SYNOPSIS

eval<var_name_1>=<numeric_expression_1>\[<var_name_2>=<numeric_expression_2> ... <var_name_N>=<numeric_expression_N>].

• 赤色は必須パラメータ

オプション

変数名

• 変数の名前。大文字と小文字を区別し、スペースを含んではならない。

numeric_expression

• 数値式、または引数内のすべての変数呼び出しが解決された後に数値式になる文字列。空白を含む場合は、"1 + 1 "のように二重引用符で囲む必要がある。を参照してください。Numeric Expressions式の構文とサポートされている数値演算子の詳細については、このマニュアルの章を参照してください。

戻り値

バージョン2.3.2までのEvalコマンドは常に0（ゼロ）を返す。バージョン2.3.3以降では、数値式が正しく評価された場合は0を返し、式が評価できなかった場合（例えば、存在しない変数の呼び出しが含まれている場合）には0以外の値を返します。このメカニズムにより、値が正しく入力されたかどうかをテストし、_EXIT_CODEをチェックしてコードを分岐させることができます。if/else statementEXIT_CODE変数の値をチェックする。

例

評価  POSITION=2*(10+1)

• 値22の変数POSITIONを作成します。

Eval SUM={SUM}+10
if ({_EXIT_CODE} != 0) {
   Exit 1
}

• 既存の変数SUMを10増やす。変数が存在しない場合、スクリプトは終了コード1で終了します。

Var A=1 B=2C=3
// Varが変数呼び出しを解決し、 
// 文字列を  連結するので 、ABC1の値は "123+1 "という文字列になる。 
Var  ABC1="{A}{B}{C}+1"
// Evalが変数呼び出しを解決し、結果を評価するとき 
// 数値表現として 、ABC2の値は "124 "となる。 
Eval ABC2="{A}{B}{C}+1"

• この例は、VarコマンドとEvalコマンドがどのように変数値を構築するかの違いを示しています。

3.2.9 Exec

説明

Exec - OS のコマンドをローカルシステム(T-Plan Robot が動作するマシン)で実行します。引数は、Unix/Linux の 'ls -l' のような単一のコマンドでなければなりません。JavaとOSの間のインターフェイスの制限により、パイプや出力のリダイレクトはできません。出力をファイルに保存する必要がある場合は、outfileパラメータを使用する。パイプやリダイレクトを使用する必要がある場合は、コマンドをシェルスクリプトやバッチファイルに記述し、代わりに Exec コマンドがそれを呼び出すようにしてください。

コマンドラインインタープリタが提供するWindowsコマンドを実行する必要がある場合は、Execコマンドでインタープリタを指定する必要があります。これは、dir、cd、copy、md、mkdir、rd、rmdir、del、erase などのコマンドに当てはまります。コマンドの完全なリストはWindowsシステムによって異なり、Microsoftのサイトで入手できます。また、WikipediaのCOMMAND.COMのページも参考になる。Windowsで「dir」を実行する例は次のようになります：

Exec "cmd.exe /C dir"

基礎となるオペレーティング・システムを呼び出すにはそれぞれ多少のオーバーヘッドが必要なので、一連のOSコマンドを一度に実行する必要がある場合は、シェル・スクリプト（Linux/Unix）またはバッチファイル（MS Windowsの.bat）を作成する方が効率的です。次の例は、Windowsのスクリプト・ディレクトリにあるバッチファイル「list.bat」の呼び出しを示しています。このバッチファイルはパラメータとしてディレクトリを受け取り、その内容をdir.txtというファイルにリストアップする。スクリプトのパスにはスペースが含まれることがあるので、バッチファイルとパラメータの両方を二重引用符で囲む必要があります。

list.batファイル：

echo off dir %1 > %1dir.txt

Exec 呼び出し：

Exec "\"{_SCRIPT_DIR}\list.bat\"\Exec "{_SCRIPT_DIR}}list.bat" "

環境変数は、_ENV_ 接頭辞付き変数の形でスクリプトに表示されます。環境変数はスクリプトに_ENV_接頭辞付き変数の形で表示されます。 tool panel.

• リリース 7.2.9 までは、これらは読み込み専用で、変数の変更は Exec によって作成されたプロセスには渡されません。

• 7.2.10 以降では、プロセスに対してこれらの変数を設定することができます。

この例では、MS Windows 上での変数の設定を示します。echo コマンドは、実行ログに記録される変数の値を表示します：

Var _ENV_Hello=Hello！
Exec "cmd /c echo Var Hello value: %Hello%"
Log "{_EXEC_OUTPUT}"

次のプロセスで変更を戻す必要がある場合は、"Varg delete":

Varg delete name="_ENV_Hello"
Exec "cmd /c echo Var Hello value: %Hello%"
Log "{_EXEC_OUTPUT}"

Exec コマンドは、以下のように 4 つの _EXEC 接頭辞付き変数を入力します：

SYNOPSIS

Exec <command> \[count=<number>\]  \[nowait=<false|true>\]  \[onpass=<command>\]  \[onfail=<command>\]  \[outfile=<file_name>\]  \[wait=<time>\]  \[kill=<process(es)>\]{_}  {_}\[autokill=<false|true>\]
exec kill=<process(es)> \[wait=<time>\]

• 赤色は必須パラメータ

オプション

<command>

-ローカルシステムで実行するOSコマンド。OS固有の詳細についてはcommand descriptionを参照してください。

count=<数値>

-コマンドを何回実行するか。デフォルト値は1（1回実行）。

nowait=<false|true>

-OS コマンドが終了するまで Exec がスクリプトを待機させるかどうかを指定するフラグ (v3.4 以降でサポート)。デフォルト値は false で、待たせます。

値が true に設定されている場合、Exec コマンドは結果を待たず、プロセスが開始された直後にスクリプトが続行されます。EXEC_OUTPUT 変数と _EXEC_ERROR 変数は、Exec コマンドが呼び出したスクリプトに制御を戻すときに出力がわからないため、代入されません。EXEC_ERROR 変数は、基礎となる OS が指定されたコマンドの起動に失敗し、それを直ちに Robot に報告する場合に作成されます。

onpass=<コマンド>

-実行に成功した場合(終了コード0が返された場合)に実行されるT-Planロボットのコマンド。一つのコマンドでなければなりません。実行するコマンドのシーケンスを定義する必要がある場合は、Execコマンドの戻り値を基にしたプロシージャやif/else構文を使用してください。

onfail=<コマンド>

-実行に失敗した場合(ゼロ以外の終了コードが返された場合)に実行されるT-Planロボットのコマンド。一つのコマンドでなければなりません。実行する一連のコマンドを定義する必要がある場合は、Execコマンドの戻り値を基にしたプロシージャやif/else構文を使用してください。

outfile=<ファイル名>

-コマンド出力を保存するファイル名（オプション）。ファイル名だけを指定した場合は、現在の作業ディレクトリ(Robotを起動したディレクトリ)に作成されます。スクリプトの場所やロボットのインストールディレクトリからの相対パスを指定するには _SCRIPT_DIR または _INSTALL_DIR 変数を使います。例えば、出力ファイルをスクリプトフォルダに格納するには outfile="{_SCRIPT_DIR}out.txt" とします。

wait=<時間>

-コマンド実行後の待ち時間（オプション）。デフォルト値は0(待たない)。スクリプトは、"Var _EXEC_WAIT=1s "のように、_EXEC_WAIT変数に希望の遅延時間を代入することで、デフォルト値を設定することができる。

kill=<プロセス>

-指定された通常の番号、またはセミコロンで区切られた番号のリストで識別されるプロセスを kill します。v3.5.2 以降でサポートされています。execコマンドがnowait=trueで実行されるたびに、開始されたプロセスに普通番号を与えます。この番号を使用してプロセスを終了させることができます。nowaitパラメータを指定せずに起動されたプロセスや、nowait=falseで起動されたプロセスには、killは適用できません。このようなプロセスには番号も振られません。

Exec nowait=true "を複数回実行する複雑なスクリプトでは、_EXEC_PROCESS_ID変数からプロセス番号を知ることができます。例

// myapp.exeを起動し、そのIDを保存する。
Exec "myapp.exe" nowait="true"
Var MYAPP_ID="{_EXEC_PROCESS_ID}"
...
Exec kill="{MYAPP_ID}"

注意:Windowsでは、Windows OSが内部的にプロセスを整理してアクセスする方法のため、Exec Killを使って直接の子プロセスをkillすることしかできません。従って、サブ（孫）プロセスを殺すには、CMD taskkill を使ってください：実行 "cmd.exe /C taskkill /f /im <プロセス名>".

autokill=<false|true>

-スクリプト終了後にプロセスを kill するかどうかを指定するフラグ (v3.5.2 以降でサポート)。nowait=trueで起動されたプロセスにのみ適用される。デフォルト値は false (kill しない)。

戻り値

コマンドが正常に実行された場合は 0 (ゼロ) を返し、そうでない場合は OS コマンドの終了コードを返します。

例

Exec "ls -l"

• カレント・ディレクトリの内容をリストする（Unix/Linux）。このリストは_EXEC_OUTPUT変数で見ることができます。

Exec "date"
Screenshot image.png desc="This screenshot was taken on {_EXEC_OUTPUT}."

• スクリーンショットの説明にタイムスタンプを挿入するには、date OS コマンドを使用します（Unix/Linux）。

Exec "C:\Program Files\Internet Explorer\iexplore.exe http://www.google.com/" 
Exec "rundll32 url.dll,FileProtocolHandler http://www.google.com/"

• どちらのコマンドも、Windows上でInternet Explorerを起動し、Googleサイトを開くはずです。

Report index.html 
Exec "mozilla file://{_REPORT_FILE}"

-HTMLレポートを作成し、ローカル・マシンのMozillaブラウザで開く。変数_REPORT_FILEはコマンドによって入力されます。Reportコマンドによって入力され、レポートファイルのフルパスが格納されます。

// 操作対象のディレクトリ
Var DIR=/tmp

// ディレクトリの内容を表示する（Linux/Unix）。
// Windowsの場合は「ls」コマンドを"cmd.exe /C dir /B"に置き換えてください
Exec "ls {DIR}" 

// ディレクトリ一覧を行で分割する
String split "{_EXEC_OUTPUT}" pattern="\r?\n"

for (i=1; {i}<{_STRING_COUNT}+1; i={i}+1) {

  // 浮動小数点数をインデックスから置き換える（2.3.3以降では不要）
  String replace "{i}" pattern="[.].*" replacement=""

  Var f="{_STRING{i}}"

  // ファイルが.pngまたは.jpg画像の場合、3秒間表示する
  if ("{f}" endswith ".png" || "{f}" endswith ".jpg") {
    Connect "file://{DIR}/{f}" 
    Wait 3s 
  }
}

• ディレクトリに対して画像のスライドショーを実行します。ここでは Exec コマンドを呼び出してディレクトリの内容をリストアップし、"String split" を使って個々のファイル（1行に1ファイルを想定）にパースします。解析された文字列(ファイル名)は、既知の拡張子を持つ画像かどうかチェックされ、ロボットのデスクトップビューに3秒間表示されます。

3.2.10 Exit

Exit - スクリプト、プロシージャ、または構造化されたコードブロックを終了し、終了コードを返します。スクリプト実行中に 'process' スコープの exit コマンドが呼び出されると、T-Plan Robot は終了し、指定された終了コードをオペレーティングシステムに返します。T-Plan RobotCLI Optionsおよびそのautomatic script execution examplesのドキュメントを参照のこと。

SYNOPSIS

exit <exit_code_number>[scope=<process|file|procedure|block>] [desc=<description>]

*赤は必須パラメータを示します

オプション

exit_code_number

-必須の終了コード。整数値でなければなりません。ゼロ以外の値はエラーまたは予期せぬ結果や動作を示します。スクリプト全体を終了するためにコマンドが呼び出され、そのコマンドによって作成されたレポートファイルがある場合Reportコマンドによって作成されたレポートファイルでは、終了コード0が "passed/successful "として表示され、その他のコードはすべて失敗として表示されます。この終了コードは、基礎となるオペレーティングシステムにも渡され、サードパーティのフレームワークによってスクリプトが終了した理由を特定するために使用できます。

scope=<process|file|procedure|block>

-終了コマンドのスコープを制御します。デフォルト値はスクリプトの実行を終了するプロセスです。実行が自動化されており、実行中の自動化プロセスがない場合、コマンドはJVM（Java仮想マシン）も終了させ、指定された終了コードを基盤となるオペレーティングシステムに返します。

file値は、現在実行されているファイルを終了します。コマンドを使用して別のスクリプトからスクリプトを実行している場合、呼び出されたスクリプトのみが終了します。Runコマンドを使用して別のスクリプトからスクリプトが実行されている場合は、呼び出されたスクリプトのみが終了し、制御はマスター・スクリプトに戻されます。

procedure 値は、最も内側のプロシージャから終了する。プロシージャが実行されていない場合、Exit コマンドは無視される。

ブロック値は、最も内側の構造化されたコードブロック、つまりfor文のif/elseの1つから抜ける。コマンドがそのようなステートメントから呼び出された場合、それは無視されます。

desc=<説明>

-終了スコープが指定されていないか、プロセスと等しい場合にのみ使用されます。コマンドはその説明を_EXIT_DESC変数の下に保存し、レポートフレームワーク（例えばEnterprise Report Provider)によって取得され表示されます。.

戻り値

コマンドは引数として指定された終了コードを返します。

例

Exit 10

• 実行されたスクリプトを終了し、終了コードとして 10 を返します。

Typeline myapplication 
Waitfor update extent=40% timeout=20s ontimeout="Exit 2" cumulative=true

• これはExitコマンドの典型的な使い方です。ターミナル・ウィンドウからmyapplicationというGUIアプリケーションを起動したときの状況を示しています。myapplicationのウィンドウは、画面サイズの少なくとも40％に等しい固定サイズを持っているとします。GUIが正しく起動すれば、スクリプトは続行されます。そうでなければWaitforコマンドは20秒間待機し、終了コード2でスクリプトを終了します。

3.2.11 Imagedoctor

説明

Imagedoctor - Image Doctorウィザードの動作を制御します。v3.5以降でサポートされています。

SYNOPSIS

Imagedoctor <action>

• 赤い色は必須パラメータを示します

オプション

アクション

-アクションは以下のいずれかでなければなりません

• "on" - イメージドクターをオンにします、

• "off" - Image Doctor をオフにします、

• “skip" - 次の画像比較コマンドの失敗を無視します。これは、コマンドの前に Image Doctor をオフに設定し、コマンドの後に再びオンに設定することと同じです。

戻り値

コマンドは常に0（ゼロ）を返します。

例

Imagedoctor off

• イメージドクターをオフに設定します。オンに設定し直すまで、画像比較の失敗は処理されません。

Imagedoctor skip
Compareto  method="tocr"cmparea="x:33,y:2,w:200,h:22"
Compareto "search.png" method="search2"

• Image DoctorウィザードがOCRの失敗を無視するようにします。2番目の "search2 "比較は "skip "アクションの範囲外であり、Image Doctorがオンであれば、失敗した場合でも処理されます。

3.2.12 Include

説明

Include - 他のスクリプトまたはコンパイルされたJavaコードをインクルードします。

引数がこのドキュメントで説明されている言語のTPRスクリプトである場合、このコマンドはスクリプトからONLY手続きと変数を実行コンテキストにロードし、呼び出し元のスクリプトがそれらを利用できるようにします。この原則により、グローバルに使用される変数と手続きでライブラリを構築し、スクリプトにリンクすることができます。

引数がJARファイルやZIPファイル、クラスパス（.classファイルを含むディレクトリ構造）を意味するJavaリソースである場合、コマンドはそれをJavaクラスパスに追加し、そこに含まれるコンパイル済みJavaコードをインスタンス化できるようにします。このメカニズムはv2.2で導入され、コンパイルされたJavaスクリプトの動的ロードをサポートすることを目的としています。Run command.

クラスパスの動的な更新は、Java仮想マシン（JVM）インスタンス全体に影響することに注意してください。複数の自動テスト・プロセスがある場合、そのようなリソースをロードすると、そのクラスがすべての自動テスト・プロセスで即座に利用できるようになります。ファイルまたはパスがすでにクラスパス上に存在する場合、コマンドは何もせず、同じインクルード・コマンドを繰り返し呼び出しても何も害はありません。いったんリソースがロードされると、ファイル・システム内の最終的な変更はJVMと同期されません。つまり、Robotの実行中にリソースコードに変更を加えて再コンパイルすることはできません。

インクルードファイル名またはパスは、変数を通じて動的に指定することも可能です。これにより最終的に、ライブラリ名を外部から`-v`CLI Option経由で渡すことが可能となります。

SYNOPSIS

include <file_or_Java_resource>

• 赤い色は必須パラメータを示します。

オプション

file

-TPRスクリプトファイルまたはJavaリソース(JAR/ZIPファイルまたはクラスパス)を含めます。ファイル名には相対パス (sayHello.tpr など) または絶対パス (/root/scripts/sayHello.tpr など) を指定します。T-Plan Robot はファイルが存在し、読み込めるかどうかを毎回チェックします。script compilationが存在し、読み取れるかどうかをチェックし、読み取れない場合はエラーを報告します。ファイルは変数で指定することもできます (例を参照)。

戻り値

コマンドは常に0（ゼロ）を返します。指定されたファイルが見つからない場合、T-Plan Robot はゼロ以外の戻り値を返すのではなく、構文エラーを報告します。

例

Include sayHello.tpr

• このコマンドを呼び出しているスクリプトと同じディレクトリにある sayHello.tpr というスクリプトから、すべての変数とプロシージャを読み込みます。

Include /root/scripts/sayHello.tpr

• このコマンドを呼び出したスクリプトと同じディレクトリにある sayHello.tpr というスクリプトから、すべての変数とプロシージャを読み込みます。

Var PROFILE=profile1.tpr
Include {PROFILE}

• 変数で指定されたスクリプトを含めます。異なる構成のスクリプトがさらにある場合は、CLI から '-v PROFILE=profile2.tpr' を使用して別のスクリプトをインクルードできます。

Include C:\projects\TestLib\testlib.jar
Run mypackage.MyTestScript

-指定された場所から Java ライブラリ（JAR ファイル）をロードし、そこからスクリプト を実行する。この JAR ファイルには、有効な Java スクリプトである MyTestScript というコンパイル済みクラス (DefaultJavaTestScript クラスを継承しているか、少なくともJavaTestScript インターフェイスを実装している) を持つ "mypackage" というパッケージ (ディレクトリ) が含まれているものとします。詳細はRunを参照してください。

3.2.13 MoveTo

説明

Click コマンドと同様に、MoveTo は Waitfor matchとMouse moveコマンドの組み合わせです。コンポーネント画像、ソリッドカラーオブジェクト、またはテキストをデスクトップから探し、マウスポインタをそこに移動させます。オブジェクトが見つからない場合はスクリプトを終了します。

SYNOPSIS

MoveTo <comparison_method> [timeout=<time>] [cmparea=<[x:<x>][,y:<y>][,w:<width>][,h：<height>]>] [number=<component_number>] [modifiers=<modifiers>] [wait=<time>][<メソッ<method specific options>]。

• 赤色は必須パラメーターを示します

comparison_method

-サポートされているメソッドは以下の通り：

• 'image' - コンポーネントを画像もしくはimage collectionsメソッドを使ってsearch2メソッドを使用します、

• 'object' - メソッドを使って色でコンポーネントを検索します。objectメソッドを使用します、

• 'ocr' - OCR（メソッド）を使って画面上のテキストを認識し、指定された文字列またはパターンを検索します。tocrメソッド）を使用して画面上のテキストを認識し、指定された文字列またはパターンを検索します。

共通オプション

timeout=<時間>

-タイムアウトは、コンポーネントが画面に表示されるまでの最大待ち時間を指定します。値は数ミリ秒または有効なTime Valuesでなければなりません。デフォルトは30秒です。

cmparea=[x:<x>][,y:<y>][,w:<width>][,h:<height>]

-比較を制限するためにデスクトップの長方形の領域を制限します。。このパラメータを省略すると、リモート デスクトップ全体が処理されます。領域の座標は「x:<x>,y:<y>,w:<width>,h:<height>」の形式で、各座標はピクセル単位（たとえば「x:225」）またはパーセント単位（「x:23%」）で指定できます。x、y、width、heightのいずれかが省略された場合、アプリはフルスクリーンの値を使用して不足するパラメータを決定します（x:0、y:0、w:<screen_width>、h:<screen_height>）。

number=<コンポーネント番号>

– マウスを移動させる画面上のコンポーネントの番号。画面上のコンポーネント(オブジェクト)は、上から下、左から右の読み順にソートされます。デフォルト値は1（最初にあるコンポーネントをクリック）です。画面上で見つかったコンポーネントの数が指定された数より少ない場合、コマンドはスクリプトを終了します。

move=[x:<x>][,y:<y>]

-ターゲットオブジェクトの中心からの相対的な移動位置を指定します。これにより、オブジェクトそのものではなく、近くの位置にマウスを移動させることができます。比較メソッドがイメージの場合、このパラメータはイメージを上書きし クリックポイントを上書きし、画像の中心を基点として使用します。例えば、"MoveTo image template=button.png move=x:-40 "のコマンドは、ポインタをボタンの中心から左に40ピクセル移動させます。

modifiers=<修飾子>

-マウスイベント修飾子（オプション）。値はShift、Alt、Ctrlの任意の組み合わせで、プラス「+」記号で区切ります。

continue=<数字>

-trueの値では、オブジェクトが見つからなければスクリプトは終了しません。デフォルト値はfalse（失敗時に終了）です。コマンドはまた、_MOVETO_CONNECT変数の値を監視し、それをデフォルト値として使用します。たとえば、スクリプト内のすべてのMoveToコマンドをデフォルトで終了しないようにするには、最初にこの変数をtrueに設定します("Var _MOVETO_CONTINUE=true")。

step=<ステップ名>

-コマンドとのシンプルな統合Stepコマンドとのシンプルな統合。指定されると、指定された名前のテストステップを作成し、結果は合格（オブジェクトが見つかり、マウスポインタがそのオブジェクトに移動した）または不合格（オブジェクトが見つからなかった）です。

wait=<時間>

-移動が完了するまでの待ち時間。これは、次のコマンドが「Wait <time_in_ms>」であった場合と同じ効果を持ｖちます。値はミリ秒数か有効な値でなければなりません。time value.デフォルト値は0（待機しない）です。スクリプトは、「Var _MOVETO_WAIT=1s」のように、_MOVETO_WAIT変数に希望する遅延を入力してデフォルト値を設定することができます。

Moveto image template=<image_collection> [passrate=<pass_rate_in_%>] [<search2_specific_params>] [<common_options>]。

• 赤色は必須パラメーターを示します

特定のオプション - image

template=<image_collection>

-画像image collections- リモートデスクトップイメージと比較する 1 つ以上のイメージファイル名、またはイメージをセミコロン (';') で区切ったフォルダ。Linux/Unix では、ファイル名にセミコロンが含まれていないと、リストが正しく解析されません。ファイル名には、相対パス（img.png など）または絶対パス（/root/report/img.png など）を指定できます。相対パスを使った場合、画像は_TEMPLATE_DIR_ variable.サポートされる画像フォーマットは、Javaのバージョンに依存します。Java 1.6では、少なくともPNG、JPG、GIF、BMPをサポートしています。

テンプレート画像は、指定されたリストの順序でリモートデスクトップ画像と比較されます。テンプレートの比較で肯定的な結果（指定されたイベントに応じて、一致または不一致のいずれか）が得られた場合、条件は満たされたとみなされ、コマンドは終了コード0で終了し、リスト内の残りのテンプレートをスキップします。定義済み変数 _COMPARETO_TEMPLATE_INDEX は、マッチするテンプレート画像のインデックスを決定するために使われます。対応する変数の一覧は画像比較固有の変数を参照してください。

passrate=<pass_rate_in%>

-画像比較の通過率。0から100の間の数値を指定する必要があり、その後にパーセンテージを指定することもできます（例："passrate=95 "または "passrate=95%"）。このパラメータが省略された場合、デフォルトのsearch2通過率50%が使用されます。

search2_specific_params

-比較メソッドでサポートされる任意のパラメータ。search2 比較メソッドでサポートされる任意のパラメータ（オプション）。

Moveto object [<object_specific_options>] [<common_options>]

特定のオプション - オブジェクト

object_specific_params

-オブジェクト比較メソッドでサポートされるパラメータ（オプション）。通常、少なくともオブジェクトの色を指定する必要があります。

Moveto ocr [<Text OCR ("tocr")>] [<common_options>].

特定のオプション - ocr

tocr_specific_options

-比較メソッドでサポートされる Text OCR ("tocr")比較メソッドでサポートされる任意のパラメータ。text またはpattern オプションで移動先のテキストを指定する必要があります。

戻り値

コマンドは、成功すると常に0を返し、失敗すると指定された比較メソッドからのエラーコードを返してスクリプトを終了します。

例

Moveto image template="google_button.png"number="2"

• 画面上のgoogle_button.png画像で指定された2番目のボタンの中央に移動します。ボタンが見つからないか、画面上のボタンの数が2より少ない場合、コマンドはスクリプトを失敗させます。

Moveto object tolerance="10" color="255;0;0" max="w:20"

• 幅が20ピクセル以下の赤いオブジェクトを見つけ、マウス・ポインタをその中心に移動させます。トレランスは、メソッドがより多くの赤の色合いを見つけることを保証します。

Moveto ocr text="Cancel" distance="1"

• OCRを使って画面上のテキストを読み、"Cancel "の最初の単語に移動します。この距離により、OCRエンジンが1つの文字、たとえば「Cencel」などを省略したり認識できなかったりしても、その単語が確実に見つかります。

3.2.14 Pause

説明

Pause - スクリプトの実行を一時停止します。T-Plan Robot が GUI モードで実行されている場合、Pause ボタン/メニュー項目が選択され、ユーザーはボタンまたはメニュー項目の選択を解除することで実行を再開できます。

スクリプトがCLIモードで実行されている場合は、コンソールにメッセージが出力され、ユーザーはキーを押すことで実行を再開できます。

Pauseコマンドは、暴走が検出された場合などに実行を一時停止するために使用できます。

通常の方法では、エラー終了コード（'Exit 1'など）を指定してスクリプトを終了させますが、テスト・スイートによっては、責任者に電子メールを送信して実行を一時停止し、人間の助けを待つことを好む場合もあります。

SYNOPSIS

pause <description>

オプション

説明

-スクリプトが一時停止された理由の説明（オプション）。この説明はレポートに表示され（定義されている場合）、CLIモード実行の場合はコンソールに出力されます。

戻り値

コマンドは常に 0 (ゼロ) を返します。

例

Compareto "application.png" 
if({_EXIT_CODE} > 0) {
    # ヘルプのアラート - スクリーンショットをメールで送信して一時停止
    Screenshot runaway.png
  Sendmail to="tester@dummyserver.com" from="robot@dummyserver.com" server="mail.dummyserver.com" subject="Runaway behavior detected - see attached picture. Please help!" attach="{_REPORT_DIR}/runaway.png"
    Pause "Runaway behavior detected" 
}

-画像比較に失敗したら、スクリーンショットをテスターにEメールで送り、実行を一時停止します。

3.2.15 Run

Run - 別のスクリプトを実行します：

1. 本仕様書に記述された形式のTPR スクリプト(通常は .tpr ファイル)を実行します。T-Plan Robot は、呼び出されたスクリプトに書かれているのと同じようにコマンドを処理します。procedures,Variables,screenshotとreport generator実行されたスクリプトで定義されたコマンドは実行リポジトリに残り、Run コマンドが終了するとアクセスできるようになります。Exitスコープをfileに設定したコマンドを使用すると、Runで実行されたスクリプトからメインスクリプトに戻ることができます。

2. Java ソース・ファイル（.java ファイルでなければなりません。）DefaultJavaTestScript クラスを継承するか、少なくともJavaTestScript インターフェイスを実装した、有効な T-Plan Robot Java スクリプトでなければなりません。Run コマンドはソースコードをコンパイルし、クラスをインスタンス化し、その test() メソッドを実行します。この呼び出しにはJava コンパイラへのアクセスが必要なため、T-Plan Robot はJava Development Kit (JDK) 上で動作するか、2.3.3 以降でサポートされているJDK インストールへのパスが設定されている必要があります。）ツールが Java Runtime Environment (JRE)だけで動作し、JDK が利用できない場合、ツールはエラーを報告する。手順についてはリリースノートを参照してください。

3. Javaクラス名（バージョン2.2からサポート）。DefaultJavaTestScript クラスを継承するか、少なくともJavaTestScript インターフェイスを実装した、有効な T-Plan Robot Java スクリプトに対応する完全修飾 Java クラス名 (パッケージ名+クラス名) でなければなりません。このクラスは、デフォルト（パラメータなし）のコンストラクタを持たなければなりません。Run コマンドは、クラス名を指定してインスタンス化し、その test() メソッドを実行します。このメソッドは Java コードのコンパイルを伴わないため、パフォーマンス・オーバーヘッドが最小で非常に高速であり、実運用シナリオに推奨されます。
   コンパイルされたクラスコードは、3つの方法のいずれかで T-Plan Robot のクラスパスに配置する必要があります：

   • Include commandを通じてコード(JAR、ZIP、またはclasspath)を読み込みます。この方法により、スクリプトが動的にコードを読み込み、現在のJava/Robotインスタンスに利用可能にできます。

   • リリースノートに記載されているロボットのスタートコマンドの「-classpath」パラメータにJAR、ZIP、またはclasspathを追加します。これにより、そのコードは特定のJava/Robotインスタンスに利用可能になります。

   • Robotを実行するために使うJavaインストールの<java-home>\lib\ext)またはLinux/Unixの<java-home>/lib/extにコード付きのJARファイルを置いてください。これにより、このインストールから開始されたすべてのJavaインスタンス(およびすべてのRobotインスタンス)にコードが利用可能になります。

バージョン2.2では、<name>=<value>のペアで指定されたオプションのパラメータもサポートされています。これらのパラメータは、実行されるスクリプトまたはJavaクラス内でのみ有効なローカル変数として、実行されるスクリプトに公開されます。TPRスクリプトでは、パラメータは標準変数として名前で呼び出すことができます。Javaコードの側では、getContext().getVariable()メソッドや、ScriptingContextインターフェイスで定義された便利なメソッドgetVariableAsXXX()のセットを通して、パラメータを取得することができます。

実行コマンドは、コードの一般的なスニペット（ライブラリ）を実装したり、個々のテストケースのテストコードを分離したりするために効果的に使用できます。バージョン2.2で提供されたJavaサポートの強化により、パラメータ化されたJavaルーチンのライブラリを実装し、TPRスクリプトから呼び出すことができるようにななりました。これは、Plugin メカニズムを通さずにスクリプト言語にカスタム機能を追加する効率的な方法です。

概要

実行

run <file_or_class> [<param1>=<value1> ... <paramN>=<valueN>]

* 赤い色は必須パラメータを示す。

オプション

file

-ファイルは以下のいずれかです：

1. TPRスクリプトファイル(.tpr)またはJavaスクリプトファイル(.java)。このファイルは、現在のスクリプトファイルからの相対パス(例えば sayHello.tpr)、または絶対パス(/root/scripts/sayHello.tpr)のいずれかを指定します。 T-Plan Robotは、スクリプトの検証のたびに、このファイルが存在し、読み込めるかどうかをチェックし、読み込めない場合はエラーを報告します。

2. 完全修飾された Java スクリプトクラス名 (org.mytests.DoSomething など)。指定されたクラスは、Java クラスパス上になければなりません。詳細についてはcommand description.

<パラメータ>=<値>

– オプションのパラメータとその値のリスト。これらのパラメータは、ローカル変数の形で実行されるファイルで利用できるようになります。

戻り値

Run は常に最後に実行されたコマンドによって返されたコードを返します。指定されたファイルが見つからない場合、T-Plan Robot はゼロ以外の戻り値を返すのではなく、構文エラーを報告します。

例

Run sayHello.tpr

– このコマンドを呼び出しているスクリプトと同じディレクトリにある sayHello.tpr というスクリプトを実行します。

Run /root/scripts/sayHello.tpr

– root/scripts/ディレクトリにあるsayHello.tprというスクリプトを実行します。

Run /root/scripts/MyTest.java

– 指定された Java ソース・コード・ファイルを実行します。これは、com.tplan.robot.scripting.DefaultJavaTestScriptを拡張したクラスか、少なくともcom.tplan.robot.scripting.JavaTestScriptインタフェースを実装したクラスでなければなりません。こ の フ ァ イ ルは、 まず Java Compiler API を用いてバ イ ト コ ー ド 形式に コ ンパ イ ル さ れ、 次いで イ ン ス タ ン シエー ト さ れて実行 さ れます。これは、T-Plan Robot が JDK ディストリビューションの Java 上で実行されるか、JDK インストール (v2.3.3 以降) への有効なパスが設定されている場合にのみ機能します。

Run com.testsuite.MyDummyTestScript server="rfb://localhost:5901" pass="welcome"

– Javaスクリプト・クラスをインスタンス化して実行します。クラスはJavaクラスパス上になければならず、com.tplan.robot.scripting.DefaultJavaTestScriptを拡張するか、少なくともcom.tplan.robot.scripting.JavaTestScriptインタフェースを実装しなければなりません。コマンドラインの2つのパラメータは、変数としてコンテキストに挿入されます。

Var SCRIPT_TO_EXECUTE=sayHello.tpr
Run "{SCRIPT_TO_EXECUTE}"

– 変数で指定されたスクリプトを実行する。

3.2.16 String

String - テキストを処理または解析します。このコマンドは、引数のテキストにテキスト処理関数を適用します。contains"、"startswith"、"endswith"、"matches "といった基本的な文字列の "テスト "操作は、if/else文を通して実行することができます。boolean expressionsによるif/se文で実行することができますが、Stringコマンドはむしろ、1つ以上の操作のシーケンスからなる、より複雑なテキスト処理をターゲットにしています。

引数テキストにvariable callsが含まれている場合、それらはテキストが処理される前に解決（値に置き換え）されます。このコマンドは、_STRING接頭辞を持つ変数のセットを以下のように入力します：

操作の結果は、デフォルトで_STRING変数またはオプションの'var'パラメータで指定されたカスタム変数に保存されます。操作が複数の値を生成する場合（'split'操作など）、各値は _STRING1、_STRING2 などの番号付き変数、または 'var' パラメータで指定された名前から派生した同様の番号付き変数セットに保存されます。その後、値の数が_STRING_COUNT変数に保存されます。

コマンドの基本構造は以下の通りです：

String <操作> "<テキスト>" [<パラメータ>].

サポートされている操作をアルファベット順に以下に示します。これらの名前はほとんどの場合、java.lang.String Javaクラスのメソッド名に由来しています。

• indexof - string' パラメータで指定された部分文字列が最初に現れるテキスト内のインデックスを返します。v3.5.2以降では、このコマンドはtocr method.インデックスは0から始まります。指定された文字列が見つからない場合、結果は-1です。例えば、'String indexof "Demo text" string=text'は、_STRING変数を5に設定します。この操作は通常、'substring'と組み合わせてテキスト解析に使われます。与えられたテキスト内の部分文字列の存在をテストしたい場合、その位置に興味がない場合は、'contains'.ブール演算子を利用する方が簡単です。

• length - テキストの長さ（文字数）を返します。例えば、'String length "Demo" ' とすると、_STRING変数に4がセットされます。

• matches - java.util.regex.Pattern準拠の正規表現にテキストをマッチさせ、その結果をブール値（'true' か 'false'）で返します。例えば、'String matches "a20" pattern="[a-z][0-9]*" ' は _STRING 変数を 'true' に設定します。 なぜなら、この正規表現は小文字の後に数字が続くシーケンスにマッチするからです。matches'演算は、if/elで使いやすいようにboolean operatorの形でもサポートされています。

• replace - string' パラメータで指定された値がテキスト中に出現した場合、その値を 'replacement' パラメータで指定された文字列で置き換えた新しいテキストを返します。この操作は、'string'の代わりに'pattern'を指定して、指定したjava.util.regex.Pattern正規表現にマッチするすべての出現回数を置換することもできます。例えば、'String replace "fox" string=f replacement=s'は、_STRING変数を'sox'に設定します。

• split - 与えられた文字列('string'パラメータ)またはjava.util.regex.Pattern正規表現('pattern')にマッチする文字列の集合にテキストを分割します。例えば、'String split "brown fox" string=" " ' は、_STRING1=brownと_STRING2=foxの2つの値を生成し、_STRING_COUNT変数に2を設定します。

• substring - 入力'start'または'end'インデックス番号で定義されたテキストの部分文字列を返します。インデックスは0から始まり、0はテキストの先頭（最初の文字）を指す。例えば、'String substring "someone" start=4'は、_STRING変数を'one'に設定します。

• tostring - 1つ以上のセミコロンで区切られた数値ASCIIまたはUnicode値から新しいテキストを作成します。これは、特殊文字や各国アルファベットの文字を生成するのに使うことができる。例えば、'String tostring "49;43;49" ' は、_STRING変数を'1+1'に設定します。

• trim - 先頭と末尾の空白文字(スペース、改行文字など)をすべて削除する。例えば、'String trim " apple " は、_STRING変数を'apple'に設定します。

String indexof "<text>" string=<text>[start=<index>] [end=<index>] [distance=<number>] [var=<variable_name>]

• 赤色は必須パラメーターを示す

オプション

text

-処理するテキスト。

string

-テキスト内で検索する文字列。

start

-検索を開始する開始インデックス（オプション）。数値または有効なNumeric Expressions.インデックスは 0 から開始し、0 はテキストの先頭 (最初の文字) を指します。デフォルトの開始インデックスは 0 です。

end

-検索を終了する終了インデックス。数値または有効なNumeric Expressions.デフォルト値はテキストの長さ(テキストの終端)。

distance

-トレラントテキスト検索を実行するために、"string "パラメータと組み合わせて使用されるオプションの距離（3.5.2からサポート）。このパラメータがデフォルト値の0（距離なし）に設定されている場合、コマンドは引数テキストが指定された文字列の最初の出現箇所を検索するプレーンな文字列検索に戻ります。

許容（ファジー）テキスト検索は、距離値が 1 以上の場合に実行されます。テキストは、指定された文字列と十分に類似した文字列の出現を検索します。許容度（類似度）はレーベンシュタイン距離に基づいている。これは、一方の文字列を他方の文字列に変換するのに必要な最小の編集回数として定義され、許容される編集操作は1文字の挿入、削除、置換です。この距離は、サンプル・テキストが等価であるとみなすために、最大で何文字が省略されるか、または正しく認識されないかをおおよそ指定します。
検索の代わりにファジーテキストマッチングを実行するにはstring_matchesコマンドを使用します。

var

-結果のインデックスを格納する変数名(オプション)。このパラメータが指定されない場合、結果はデフォルトの _STRING 変数に格納されます。

戻り値

'String indexof' コマンドは、指定された文字列がテキスト内に見つかった場合は 0 (ゼロ) を返し、そうでない場合は 1 を返します。このコマンドはさらに、_STRING変数(または'var'パラメータで指定したカスタム変数)にインデックス(見つからなければ-1)を格納します。インデックスは0から始まり、0はテキストの先頭（最初の文字）を指します。

例

String indexof "Demo text" string="text" var=result

– Demo text "内の "text "の位置（インデックス）を取得し、"result "変数に5の結果を格納します。

String indexof "Demo text" string="test" var=result  distance=1 

– 前の例と同じですが、"text "の単語は、指定された "test "の文字列の距離1以内にあります。

String length "<text>" [var=<変数名>].

• 赤色は必須パラメータ

オプション

var

-結果の文字列長を格納する変数名(オプション)。このパラメータが指定されない場合、結果はデフォルトの_STRING変数に格納されます。

戻り値

String length' コマンドは常に 0 (ゼロ) を返し、引数のテキストの長さ (文字数) を _STRING 変数または 'var' パラメータで指定したカスタム変数に格納します。

例

文字列の 長さ "デモテキスト" var=len

• デモ・テキスト "の長さ（9）を "len "変数に格納します。

String matches "<text>" pattern="<regular_expression>" [var=<variable_name>]

String matches "<text>" string="<text>" [distance=<number>] [var=<variable_name>].

• 赤色は必須パラメーターを示します。

オプション

pattern

-java.util.regex.Patternに準拠した正規表現。. "の正規表現は、デフォルトでは行終端以外のすべての文字にマッチします。この動作はコマンドの環境設定で変更することができます。
正規表現はテキスト全体にマッチしなければならないことに注意してください。このコマンドは、その正規表現にマッチする部分のテキストを検索しません。例えば、"*.test.*"という単語を検索するには、".test. "という表現を使わなければなりません。意味は「'test'という単語で、その前後に(.*)が含まれていてもいなくてもよい」ということです。

string

-テキストを検索する文字列 (3.5.2 以降でサポート)。

distance

-オプションの距離。"string "パラメータと組み合わせて使用し、トレラントテキストマッチングを実行します(3.5.2以降に対応)。このパラメータをデフォルト値の0(距離なし)に設定すると、コマンドはプレーンな文字列比較に戻り、引数テキストが指定された文字列と等しいかどうかがテストされます。
許容（ファジー）テキスト・マッチングは、距離値が1以上の場合に実行されます。テキストが指定された文字列と十分に類似しているかどうかがテストされます。許容度（類似度）はレーベンシュタイン距離に基づいています。これは、一方の文字列を他方の文字列に変換するのに必要な最小の編集回数として定義され、許容される編集操作は1文字の挿入、削除、置換です。この距離は、サンプルテキストを等価とみなすために、最大で何文字が省略されるか、または正しく認識されないかをおおよそ指定します。
指定された文字列は、引数テキスト全体と一致しなければならないことに注意してください。指定された文字列と似た文字列を見つけるためにあいまい検索を行うには、代わりにstring_indexofを使います。

var

-結果のブール値フラグ(true/false)を格納する変数名(オプション)。このパラメータが指定されない場合、結果はデフォルトの _STRING 変数に格納されます。

戻り値

'String matches' コマンドは、テキストが正規表現にマッチする場合は 0 (ゼロ)、マッチしない場合は 1 を返します。コマンドはさらに、結果を 'true' または 'false' として _STRING 変数または'var' パラメータで指定したカスタム変数に格納します。

例

File open file="C:\data.txt"
Var result=-1

for (i=1; {i}<{_FILE_LINE_COUNT}+1; i={i}+1) {
   File read line={i}
   String matches "{_FILE_READ}" pattern="[a-z]*"
   if ({_EXIT_CODE} == 0) {
       Var result={i}
       Break
      }
}

• データ・ファイルを開き、一行ずつ読み込んで、それぞれを指定された正規表現と照合する。行がマッチしたら、その行番号を変数 "result "に保存して停止する。

// サンプルテキストを作成
Var TEXT= "this is sample text" 

// このコマンドは 0 (合格) を返します。指定されたパターンは 「simple」 または 
//「sample」 を含む任意のテキストに一致します
String "matches" "{TEXT}" pattern=".*s[ia]mple.*" 

// このテキストには「simple」が含まれていないため、0が返されます。
String "matches" "{TEXT}" string="simple" 

// これは0を返します。テキストに「sample」が含まれており、「simple」と1文字しか違いがないためです。
String "matches" "{TEXT}" string="simple" distance=1 

• サンプル・テキストを様々な方法でテストします。

String replace "<text>" string="<text>" replacement="<text>" [var=<variable_name>].

String replace "<text>" pattern="<regular_expression>" replacement="<text>"[var=<variable_name>].

• 赤色は必須パラメータ

オプション

replacement

-新しい文字列（置換）。

string

-テキスト内で置き換える）古い文字列。

pattern

-置換する文字列を表すjava.util.regex.Patternに準拠した正規表現です。. "の正規表現は、デフォルトでは行終端を除くすべての文字にマッチします。この動作は、コマンドの環境設定で変更することができます。

var

-結果の新しいテキストを格納する変数名(オプション)。このパラメータが指定されない場合、結果はデフォルトの _STRING 変数に格納されます。

戻り値

文字列の置換'コマンドは、少なくとも1つの置換が行われた場合は0を、置換が行われず、結果のテキストが元のテキストと等しい場合は1を返します。新しいテキストは、それが変更されたかどうかに関係なく、_STRING変数または'var'パラメータで指定されたカスタム変数に格納されます。

例

String replace "bad fat cat" string="b" replacement="s"

• STRING変数を "sad fat cat "で更新し、文字列が更新されたので0を返します。

String replace "bad fat cat" pattern="[bf]a[td]" replacement="cat"

• STRING変数を "cat cat cat "で更新し、文字列が更新されたので0を返します。

String split "<text>" string="<text>"[var=<variable_name>]
String split "<text>" pattern="<regular_expression>" [var=<variable_name>]

• 赤色は必須パラメータです。

オプション

string

-分割する区切り文字 (セパレータ)。

pattern

-java.util.regex.Patternに準拠した正規表現で分割します。正規表現 "." は、デフォルトでは行終端以外のすべての文字にマッチします。この動作は、コマンドの環境設定で変更することができます。

var

-結果の文字列を格納する変数のベース名を指定します。このパラメータが指定されない場合、結果はデフォルトの番号 _STRING<number> 変数に格納されます。

戻り値

String split' コマンドは常に 0 (ゼロ) を返します。解析された各値は、_STRING1、_STRING2 などの番号付き変数、または 'var' パラメータで指定された名前から派生した同様の番号付き変数セットに保存されます。その後、値の数が_STRING_COUNT変数に格納されます。

例

String split "bad fat cat" string=" " var="s"

• テキストをスペースで分割する。s "というカスタム変数のベース名が指定されると、コマンドは3つの変数s1="bad"、s2="fat"、s3="cat "のセットを生成する。STRING_COUNT変数は3に設定されます。

String split "bad, fat cat" pattern="[,]* "

• テキストをスペースで分割し、その前にカンマを置くこともできます。前の例と同様に、このコマンドは3つの変数_STRING1="bad"、_STRING2="fat"、_STRING3="cat "のセットを生成します。STRING_COUNT変数は3に設定されます。

//　操作対象のディレクトリ
Var DIR=/tmp

// ディレクトリの内容を一覧表示（Linux/Unix）。
// Windowsの場合は「ls」コマンドを「command.com /C dir /B」に置き換える
Exec "ls {DIR}" 

// ディレクトリ一覧を行単位で分割
String split "{_EXEC_OUTPUT}" pattern="\r?\n"

for (i=1; {i}<{_STRING_COUNT}+1; i={i}+1) {

  // インデックスの浮動小数点置換（2.3.3以降不要）
  String replace "{i}" pattern="[.].*" replacement=""

  Var f="{_STRING{i}}"

  // ファイルが .png または .jpg 画像の場合、3秒間表示する
  if ("{f}" endswith ".png" || "{f}" endswith ".jpg") {
    Connect "file://{DIR}/{f}" 
    Wait 3s 
  }
}

• ディレクトリに対して画像のスライドショーを行います。ここでは、"String split "コマンドを使って、ディレクトリ・リストを個々のファイルに分割する（1行に1ファイルを想定）。解析された文字列(ファイル名)は、既知の画像拡張子かどうかチェックされ、ロボットのデスクトップビューに3秒間表示されます。

String substring "<text>" start=<index> [end=<index>] [var=<variable_name>]
String substring "<text>" end=<index> [start=<index>] [var=<variable_name>]

• 赤色は必須パラメーターを示す

オプション

start

-開始インデックス (数値または有効な数値表現)。インデックスは0から始まり、0はテキストの先頭(最初の文字)を指します。デフォルト値は0です。

end

-終了インデックス (数値または有効な数値表現)。デフォルト値はテキストの長さ（テキストの終端）。

var

-結果の部分文字列を格納する変数のベース名 (オプション)。このパラメータが指定されない場合、結果はデフォルトの _STRING 変数に格納されます。

戻り値

文字列の部分文字列'コマンドは、開始および終了インデックスがテキスト内の有効な位置を指す場合、0 (ゼロ) を返します。開始位置が無効な場合（0より小さいか、テキストの長さ以上であることを意味します）、コマンドは開始インデックスを0に設定し、1を返します。そうでない場合、終了位置が無効（開始位置より小さいか、テキスト長より大きいことを意味する）なら、コマンドは終了インデックスをテキスト長のデフォルト値に設定し、2を返す。返される値にかかわらず、_STRING変数（または'var'パラメータを通して渡されるカスタム変数）は、常に開始位置と終了位置の間の新しい部分文字列で満たされます。

例

String substring "bad fat cat" start="4" var="s"

• 最初の4文字を削除し、変数 "s "に "fat cat "をセットします。

String length "bad fat cat" var="len"
String substring "bad fat cat" start="{len}-3" end="{len}-2"

• 最後の3文字目（"c"）を _STRING 変数にカットします。

String tostring "<text>" unicode=<index> [var=<variable_name>]

• 赤は必須パラメータを示します。

オプション

unicode

-文字列に変換する Unicode/ASCII コードを数値で1つ、またはセミコロンで区切られたコードのリストを指定します。リスト内の各コードはjava.lang.Integer.decode()メソッドで解析されるため、10進数、16進数(先頭が'0x'または'#'、例えば'0xF0'または'#F0')、または8進数である可能性があります。例えば、'@'文字は'64'(10進数)、'0xF0'、'#F0'(16進数)、'0100'(8進数)で指定することができる。文字コードの一覧は Wikipedia のASCII とUnicode の表を参照してください。

var

-結果の文字列を格納する変数のベース名をオプションで指定します。このパラメータが指定されない場合、結果はデフォルトの _STRING 変数に格納されます。

戻り値

String tostring' コマンドは、成功すると 0 (ゼロ) を返し、1 つ以上のコードが有効な ASCII/Unicode 文字に対応しない場合は 1 を返します。成功した場合、コマンドは_STRING変数（または'var'パラメータを通して渡されたカスタム変数）に変換された文字列を格納します。

例

String tostring "104;101;108;108;111" var="s"

• s" 変数に "hello" を代入します。

String tostring "0xF1" var="s"
Var tomorrow="ma{s}ana"

• 変数 "tomorrow "に "mañana "を設定します。

String trim "<text>" [var=<variable_name>]

• 赤色は必須パラメータです。

オプション

var

-結果の文字列を格納する変数のベース名(オプション)。このパラメータが指定されない場合、結果はデフォルトの _STRING 変数に格納されます。

戻り値

String trim' コマンドは常に 0 (ゼロ) を返します。コマンドが成功すると、_STRING 変数 (または 'var' パラメータで渡されたカスタム変数) にトリムされた文字列が格納されます。

例

String trim " Hello!  " var="s"

• s" 変数を "Hello!" に設定します。

3.2.17 Var

説明

Var - スクリプト変数を定義します。スクリプト変数のサポートに関する一般的な説明は Variables の章を参照してください。

書式付きテキスト（複数行、タブ、...）の作成には Varf コマンドを使用してください。数値式の値を評価（計算）して変数に格納するには Eval コマンドを使います。

アンダースコア ('_') で始まる変数は、いわゆる定義済み変数です。これらは通常、T-Plan RobotまたはT-Plan Robotのコマンドによって提供され、実行コンテキストや操作結果に関する情報を提供する有用な値が格納されています。 以下に、最も重要なものを網羅的でない表で示します。

Step "{name}": {RESULT}\n

Var _RGB_X=234 _RGB_Y=128
if ("{_RGB}" == "00ff00") {
  // The pixel is green
}

Step "Click button1" 
Step "Click button2"            
Step "Click button3" fail
Var SUMMARY="{_STEP_SUMMARY}"