Screenshot Command

3.3.3 Screenshot

説明

Screenshot - 現在のリモートデスクトップのスクリーンショットを撮り、ファイルに保存します。

スクリーンショットコマンドは Compareto コマンドを使います。比較は、対応するテンプレート・イメージがテンプレート・ディレクトリで見つかったときに実行されます (_TEMPLATE_DIR 変数）であり、かつ以下の条件の少なくとも1つが満たされた場合に実行されます：

• スクリーンショットコマンドには、Comparetoコマンドに由来する少なくとも1つのパラメータが含まれます - 'template'、'passrate'、'onpass'、'onfail'。

• スクリーンショットコマンドの設定にある「テンプレートが利用可能な場合に自動比較を実行する」オプションがオンになっています。

'template'パラメータでテンプレート画像を明示的に指定しない限り、コマンドはテンプレートディレクトリを検索して、名前と拡張子が一致するPNG、GIF、BMP、JPG（この順）のテンプレートを探します。スクリーンショット環境設定でこの機能をオフに切り替えると、コマンドはスクリーンショット画像と全く同じファイル名のテンプレートを検索するようになります。

コマンドが画像比較を実行すると、画像比較固有の変数が入力されます。.

シノプシス

Screenshot <file> [desc=<description>] [area=[x:<x>],[y:<y>],[w:<width>],[h:<height>]] [attach=<list_of_files>] [template=<image_collection>] [passrate=<pass_rate>%] [onpass=<command>] [onfail=<command>] [method=<comparison_method>] [methodparams=<custom_params>] [cmparea=[x:<x>],[y:<y>],[w:<width>]],[h:<height>] [drawresults=<true|false>] [drawdiff=<true|false>] [<method_specific_params>]

• 赤色は必須パラメータ

オプション

<ファイル>

-画像を保存するファイル名。例えば "png "や "jpg "のように、サポートされている拡張子を持たなければなりません。サポートされている画像フォーマットはJavaのバージョンに依存します。Java 1.6では、少なくともPNG、JPG、GIF、BMPをサポートしています。ファイル名は相対パス（img.jpgなど）でも絶対パス（/root/report/img.jpgなど）でもかまいません。パスが存在しない場合は作成されます。相対パスまたはファイル名だけの場合、画像は[_REPORT_DIR変数|#_report_dir]で定義されたディレクトリに保存されます。

desc=<説明>

-画像の説明。レポートに表示されます。

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

-このパラメータを使用して、リモートデスクトップのどの部分（サブイメージ）を保存するかを指定できます。このパラメータを省略すると、リモートデスクトップ全体が処理されます。領域座標は「x:,y:,w:,h: 」の形式で、各座標はピクセル単位（「x:225」など）またはパーセンテージ（「x:23%」など）で指定できます。x,y,width,heightのいずれかが省略された場合、T-Plan Robotは不足するパラメータを決定するために全画面の値を使用します、すなわち'x:0, y:0, w:, h:'です。比較領域はそのスクリーンショットウィンドウに表示されます。

attach=<ファイルのリスト>

-レポートに添付するファイルまたはセミコロン（';'）で区切られたファイルのリスト。これは、例えばログファイルやドキュメントをレポートのスクリーンショットエントリーにリンクする方法を提供します。このレポートジェネレーターはHTMLレポートのスクリーンショットタイトルに添付ファイルをリストアップし、各添付ファイルのハイパーリンクを作成します。T-Planロボットは添付ファイルをレポートディレクトリにコピーしませんし、存在するかどうかも確認しません。

このパラメータは、旧バージョンとの互換性を維持するために廃止された。Java script APIではサポートされていません。

template=<イメージ・コレクション>

• アンイメージコレクション - リモートデスクトップイメージと比較する 1 つ以上のイメージファイル名、またはイメージをセミコロン (';') で区切ったフォルダ。Linux/Unix では、ファイル名にセミコロンが含まれていないことを確認してください。ファイル名は、相対ファイル名（たとえばimg.png)または絶対(例えば/root/report/img.png).相対パスを使うと、画像は_TEMPLATE_DIR変数が必要です。サポートされている画像フォーマットは、Javaのバージョンとインストールされている拡張機能（Java Advanced Imaging library, JAIなど）に依存します。Java 1.6では、少なくともPNG, JPG, GIF, BMPをサポートしています。

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

画像比較はJPEGのような非可逆圧縮の画像に対して行うべきではありません。代わりにPNGまたはBMPを使用してください。これらは画像情報を100％保持し、信頼性の高い安定した比較結果を保証します。画像比較についてはComparetoコマンド仕様で説明されています。　

passrate=<パス・レート>

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

method=<comparison_method>

-- 画像比較に使用するメソッド（アルゴリズム）。で説明されているメソッド名（コード）のいずれかでなければならず、画像比較機能 章、またはプラグイン・インターフェイスを通じて有効化されたサードパーティ・メソッドの名前。省略された場合、コマンドはデフォルトのものを使用します。

methodparams=<カスタム_params>

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

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

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

onfail=<コマンド>

-画像比較に失敗したときに実行されるコマンド。単一のコマンドでなければなりません。実行される一連のコマンドを定義する必要がある場合は、プロシージャを使用します。

onpass=<コマンド>

-画像比較が成功したときに実行されるコマンド。単一のコマンドでなければなりません。一連のコマンドを呼び出すには、プロシージャかそれに続くif/else 構造コマンドの終了コードをテストします。

drawresults=<true|false>

-このフラグは、画像比較の結果をキャプチャしたスクリーンショットにペイントするかどうかを制御します。デフォルト値はfalse（「結果を描画しない」という意味）です。コマンドが画像比較を採用していないか、指定された比較方法が結果のペイントをサポートしていない場合、このパラメーターは無視されます。デフォルトのT-Planロボットの設定では、"default "画像比較方法は、アルゴリズムの性質上意味がないため、結果のペイントをサポートしていません。search "メソッドは結果ペイントをサポートし、コマンド構成で指定された色でマッチ位置に対応する矩形を描画します。

drawdiff=<true|false>

-このフラグは、テンプレート画像と異なるピクセルを設定された色（デフォルトでは緑）で塗るかどうかを制御します。このパラメータはレポートの画像差分トラッキングをサポートするためにv3.4で導入されました。デフォルト値はfalse（「差分を描画しない」という意味）です。コマンドが画像比較を採用していないか、指定された比較方法がピクセル差分追跡をサポートしていない場合、パラメーターは無視されます。この機能は "search "と "search2 "アルゴリズムによってのみサポートされます。

method_specific_params

• 個々の画像比較法サポートされている特定のパラメータのリストについては個々のドキュメントを参照してください

戻り値

このコマンドは、スクリーンショットの保存に成功し、画像比較に合格した場合、0（ゼロ）を返します。画像比較が行われ、失敗した場合は1が返されます。スクリーンショットが保存できない場合（容量が足りないなど）、コマンドは2を返します。

使用例

Screenshot image.jpg

• 現在のリモートデスクトップそして、それをJPEG画像として、_REPORT_DIR変数の値で定義されるディレクトリのimage.jpgというファイルに保存する。

Screenshot /root/images/image2.png desc="This image shows what happened after I had clicked the Start button."

• 現在のリモートデスクトップを作成し、PNG画像として/root/images/ディレクトリにimage.pngというファイル名で保存する。実行されたスクリプトがレポートを生成する場合、提供された説明がそこに表示されます。