2023-01-04

HeartCore Robo CLIオプション

1. 起動CLIオプション

アルファベット順でサポートされる標準オプション：

--autosave
-c、--connect
--cfg
--createscript
-e、--edit
-h、--help
-l、--listen
--license
--licensekey
--licenseserver
--locale
-m、--resultmanager
-n、--nodisplay
--nologin
--nooutput
-o、--option
--outputdir
-p、--password
--params
-r、--run
--rapdirs (v7で削除されました)
--rapmasks (v7で削除されました)
--rapserver (v7で削除されました)
--remotecontrol
--restricted
--safebox
--safepass
--templatedir
-u、--user
-v、--variable
--variable-session

1.1標準CLIオプション

概要 | オプション | 例

概要
HeartCore Roboを実行するには、インストールディレクトリに移動し以下のコマンドを使用します。
robot.sh および robot.bat では、9個以上のパラメータを処理できないことに注意してください。より多くのパラメータを渡したり、start コマンドをカスタマイズしたりする必要がある場合は、java構文を使用します。バージョン4.4.2 以降では、すべての CLI パラメータをJSON ファイルに指定し、--paramsオプションを通して渡すこともできます。

MacOS , Unix and Linux：

1：

./robot.sh [options]

2（カスタマイズ、デバッグ、サードパーティコンポーネントとの統合に適しています）：

java-Xmx512m -classpath robot.jar:jh.jar:activation.jar:mail.jar:poi-3.6-20091214.jar:javaparser.jar:JTattoo.jarcom.tplan.robot.ApplicationSupport [options]

MS Windows：

1（最大9つのCLI引数を受け入れる）：

robot.bat [options]

2（9以上のCLI引数、カスタマイズ、サードパーティコンポーネントとのデバッグおよび統合を伴う呼び出しに適しています）：

java -Xmx512m -classpath robot.jar;jh.jar;activation.jar;mail.jar;poi-3.6-20091214.jar;javaparser.jar:JTattoo.jarcom.tplan.robot.ApplicationSupport [options]

クラスパス上のいくつかのJARファイルは省略することができます。このような場合のロボットは、省略されたライブラリに依存する機能を無効にします。バンドルされたJARファイルの詳細については、リリースノートを参照してください。

オプション
-h, --help

このヘルプの短縮版を表示します。

-c, --connect [protocol://host[:port]]
-c, --connect [host[:display]]
-c, --connect [host[::port]]

デスクトップまたはイメージに接続します。引数は<protocol>://<host_or_IP>[:<port>]の形式で有効なURLであり、かつprotocolはインストールされているクライアントプラグイン（プロトコル）コードの1つと等しい必要があります。サポートされている接続タイプとそのURLのリストについては、リリースノートのドキュメントを参照してください。例：

-c fox.red.com:1 -p welcome
-c fox.red.com::5901 -p welcome

fox.red.comというマシンのポート5901で動作するVNCサーバに、パスワード "welcome"で接続します。

URLでプロトコルが省略された場合、VNCRobot 1.x との後方互換性を提供するために RFB (VNC) 接続が標準となります。この場合、ポート番号は実際のポートではなく表示番号とみなされます。正確なポート番号を取得するには、表示番号に標準のRFBポートである5900を加算します。ダイレクトポートは、ダブルコロンで指定するモードです。例えば「localhost:1」と「localhost::5901」は、ポート5901で動作する同じローカルVNCサーバを参照しています。標準URL形式で同じアドレスを指定するには実際のポートを記載する必要があり、URLは「rfb://localhost:5901」になります。

-c rfb://

fox.red.com:5900

            -c rfb://

fox.red.com

fox.red.comで動作しているVNCサーバに接続します。サーバは標準の5900番ポートで動作するため（一般的にWindowsマシン）、ポートを指定する必要はなく、そのため上記例はどちらも同じアクセス先になっています。

-c rfb://192.168.100.9:5901 -p welcome

IP 192.168.100.9のポート5901で動作するVNCサーバに接続します。サーバには「welcome」というパスワードが必要です。

-c file://C:\TestData\Screen.png

指定されたイメージファイルを読み込んで、ライブデスクトップの代わりにテストします。

-c file://C:\TestData\images.jar!/examples/screen.png

JARファイル内で圧縮されたイメージをロードし、ライブデスクトップの代わりにテストします（JARバンドルのサポートは2.3で導入されました）。

-c file://desktop.bmp

インストール先ディレクトリにある画像を読み込みます。URL内の相対ファイルパスは、常にインストールディレクトリに対して解決されます（2.3以降でサポート）。

-c adb://default

Android Over ADB接続（3.1以降）を使用してUSBケーブルでAndroidデバイスに接続します。

-c adb://MB104PY10519

Android Over ADB接続を使用して、指定されたシリアル番号のAndroidデバイスに接続します。このフォームは、ロボットマシンに複数のデバイスが接続されている場合に使用します。

-c java://localhost

ローカルデスクトップ接続（3.2以降）を使用してローカルデスクトップに接続します。

-c apple://192.168.100.13:5901

iOSミラー接続（3.3以降）を使用して、ポート5901上のVNCサーバを実行しているAppleデバイスに接続します。

-c apple://192.168.100.13:5909
iOSミラー接続（3.5以降）を使用して、ポート5909でHeartCore Roboサーバを実行しているAppleデバイスに接続します。

テスト中のシステムへの接続は、TPRテスト・スクリプトのConnectコマンド・コール、またはJavaテスト・スクリプトのconnect（）メソッドの呼び出しを使用して確立することもできます。接続はGUIのログインダイアログから手動で開始することもできます。

-l, --listen [:display]

-l, --listen [::port]

これはRFB（VNC）固有のパラメータで、HeartCore Roboはポート5500+表示番号でRFBサーバからの逆接続を待ち受けます。このモードでは、パブリックIPアドレスを持たないサーバ（たとえば、携帯電話やポータブルデバイス）との接続を確立できます。

このパラメーターが指定されると、接続プロトコルは自動的にRFBに設定され、-c/--connectパラメーターは指定できません。接続はサーバから開始する必要があります。この手順は、サーバとプラットフォームに依存します。Linux/Unixシステムでは、vncconnect呼ばれるユーティリティを使用します。Windows上のVNCサーバは通常、GUIまたはコマンドラインオプションを使用して接続を開始できます。詳細については、VNCサーバのドキュメントを参照してください。

-u, --user [username]

デスクトップサーバへの認証に使用するユーザー名（ID）。サーバが必要としない場合はこのパラメーターを無視します。本製品でサポートされているRFB（VNC）および静止画像クライアントのいずれもユーザー名を必要としないため、このオプションは現在使用されておらず、将来の使用や第三者のクライアント拡張のために予約されています。

-p, --password [password]

デスクトップサーバ（通常はRFB / VNC）に認証するためのパスワード。サーバがパスワードを必要としない場合、このパラメーターは無視されます。例については、-c/--connect パラメータを参照してください。

-v, --variable [variablename]=[value]

スクリプト変数の値をオーバーライドします。Varコマンドのドキュメントを参照してください。このパラメータで定義された変数値は、スクリプトの実行中は変更されずにそのまま残され、スクリプトで宣言された変数の変更はすべて上書きされます。この機能を使用して、異なる構成に対して同じスクリプトを実行できます。CLIパーサーは最初に変数nameとvalueを区切るために '='文字を検索するので、変数名には変数名が含まれていないことがあります。名前または値にスペースを含む変数を渡すには、引数全体を二重引用符で囲みます（例：） -v "MYVARIABLE=This is variable value with spaces"。

--variable-session [variablename]=[value]

すべてのスクリプトから見えるように、読み取り/書き込み可能なセッション変数を作成します。詳細はVargコマンドを参照してください。v6.3からサポートされています。

-o, --option [optionname]=[value]

ユーザー設定値を再定義します。[環境設定]ダイアログで設定可能なものはここで再定義できます。このようにオーバーライドされたプリファレンス値は、スクリプト実行時にのみ維持され、ユーザー構成ファイルには書き込まれません。環境設定の名前と許容される値については、プリファレンス名と許容値に関するエンタープライズ標準設定ファイルの情報を参照ください。CLIパーサーは、オプション名と値を分離するために、最初の '='文字を検索するので、その中に等号文字が含まれないことがあります。名前または値にスペースを含むオプションを渡すには、引数全体を二重引用符 " で囲みます（例：） -o "some.file=C:\Program Files\HeartCore\file.dat"。

-r, --run [filename]

テストスクリプト（.tpr、.java）またはワークアイテム（.xml）を実行します。v7以降では、実行可能パッケージ(.zip)も受け付けます。ファイル名のパスは相対または絶対のどちらでもかまいません。相対パスは、HeartCore Roboインストールディレクトリが起点（カレントディレクトリ）になります。このオプションは、GUIとCLI( -n/--nodisplay)両モードで使用できます。

-n, --nodisplay

GUIを表示しないようにします。このオプションは-r/--runと一緒に使用して、グラフィカルインタフェースを使用せずにコマンドラインからテストスクリプトを実行します。CLIモードでの実行には多くの利点があるため実稼働環境での利用を推奨しています。

パフォーマンスが向上し、必要なメモリ量が大幅に減ります。
GUIモードと異なりスクリプトを並行して起動することができるので、テスト完了するために必要な時間を短縮することができます。並列スクリプトの実行は、ワークアイテム（スケジュール機能 v4以降）やScriptStarterプラグインを使用するか、またはJavaAPIの上に簡単なJavaプログラムを記述することで実現できます。
また、telnetやrshなどのフラフィック表示の無い端末からリモート接続で自動化タスクを開始することもできます。

-e, --edit [filename]

GUIを起動し、指定された特定のテストスクリプトを開いてスクリプトエディタで編集します。ファイル名は相対または絶対のどちらでもかまいません。相対パスが指定されると、HeartCore Roboのインストールディレクトリに対して解決されます。このオプションはGUIモードでのみ意味があり、それ以外の場合は無視されます。
このオプションは、最後のセッションからオープンスクリプトを復元する標準のHeartCore Roboの動作を上書きします。テストスクリプトがプロジェクトに属している場合、GUIは最近使用されたものの代わりにプロジェクトを開きます。

-m, --resultmanager

CLIモードでも結果マネージャウィンドウを強制的に表示します（-n/--nodisplayオプション付き）。これは通常、CLIモードで実行される1つまたは複数のテストスクリプトの結果を確認するために使用されます。最初のスクリプトが終了してテスト結果が生成されると、ウィンドウが開きます。すべてのテストスクリプトが終了しても、ウィンドウが開いている限りJavaプロセスは終了せず、結果を確認して最終的に保存できます。
このオプションをGUIモード（-n/--nodisplayオプションなし）で使用しても、標準でGUIが利用できるためこのオプションは無視されます。このオプションはv2.3以降でサポートされています。


--remotecontrol <port>

リモートコントロールサーバを起動します。これにより、RemoteControlプラグイン、またはtelnet を使用してロボットインスタンスをリモート制御することができます。ポート番号はオプションで、1024〜65535の間でなければなりません。ポートを省略すると、標準で5899になります。このオプションはv3.5以降でサポートされています。

~~--rapserver <port>~~

RAPサーバを起動して、Robotic Automation Portal（RAP）との通信を有効にします。ポータルは、ネットワーク上のロボットプロセスを監視、分析、制御することができるWebアプリケーションです。ポート番号は省略可能で、1024から65535の間でなければなりません。ポートを省略すると、標準で11298になります。サーバはTools- > RAP Server Manager メニュー項目を使用してGUIで制御することもできます。v4.2.1以降でサポートされています。管理ポータルAgentを使う

~~--rapdirs <path(s)>~~

ロボットプロジェクトのパスまたはパスのリスト。指定された各プロジェクトのスクリプトとスケジュール（「作業項目」）は、接続が確立されるとRAPポータルと同期されます。ポータルで項目が表示され、管理対象（リモート実行）になります。指定されたパスがプロジェクトホームディレクトリでない場合、プロジェクトのために再帰的に検索されます。このオプションは、異なる方法で同期されたテスト結果をエクスポートしません。詳細については、RAPのドキュメントを参照してください。管理ポータルAgentを使う

このオプションは、このオプションと一緒に使用することを意図しています--rapserver 。GUIを使用できない、たとえばヘッドレス環境の展開では、作業項目をRAPにエクスポートできます。v4.3以降でサポートされています。

~~--rapmasks <ip_mask(s)>~~

RAPサーバへの着信接続を制限するIPアドレスまたはサブネットマスク。複数のマスクはセミコロンで区切る必要があります。このオプションでは、次のマスク形式を使用できます。

単一マシンへのアクセスを制限するには、次のような単純なRAPポータルIPアドレスを指定します。 192.168.1.9
サブネットからマシンへのアクセスを許可するには、192.168.1.9/255.255.255.0または192.168.1.9/24

v4.3以降でサポートされています。管理ポータルAgentを使う

--restricted

最小限の実行制御ボタンのみのGUIを表示します。これは、-r/--runオプションと一緒に使用することを意図しており、開発ウィンドウ全体を表示せずにGUIモードでロボットを実行します。このモードは暗号化された実行可能パッケージが実行されるときに強制表示されます。v7からサポートされています。

--safebox [safebox_file]

セーフボックスファイルのパスを指定できます。v7から対応しました。

--safepass [password]

セーフボックスのロックを解除してスクリプトに保護された変数へのアクセスを許可するパスワードを設定します。v4.4.2以降でサポートされています。

--params [JSON_file]

指定されたJSONファイル（4.4.2以降）からCLIオプションを適用します。JSONプロパティは、マイナス文字のないオプション名になります。JSONファイルにコマンドラインで指定されたオプションが含まれている場合は、後者の方が優先されます。JSONファイル形式は次のとおりです。

オプションの後に値を指定しない場合は、値をnullで指定します。例えば、-n は { "n": null } となります。
オプションの後ろには、文字列または数字のいずれかを指定することができます。たとえば、-r <file>は次のようになります。{ "r": "<file>" }
-v/--varや-o/--optionなどの<param>=<value> 形式で値を受け入れるオプションは、単一の値{ "v": "MYVAR=test" }またはオブジェクト{ "v": { "MYVAR" : "test" }}として指定できます。オブジェクトバリアントは、同じオプションの複数の呼び出しに適しています。

たとえば、次のようなコマンドです。

robot.bat -n -r C:\Robot\script.tpr --var MYVAR1=abc --var MYVAR2=def

は以下と同様です。

robot.bat -params myparams.json

JSONファイルには下記内容が記載されています。

{
    "n": null,
    "r": "C:\Robot\script.tpr",
    "v": {
        "MYVAR1": "abc",
        "MYVAR2": "def"
    }
}

--licensekey [file(s)]

引数ファイルまたはセミコロンで区切られたライセンスキーファイルのリストを使用して起動します。v4.0以降でサポートされています。HeartCore Roboに渡すライセンスキーファイルは4種類あり、組み合わせて使用できます。

このオプションを使用する。
ライセンスキーファイルをHeartCore Roboインストールディレクトリに保存する。HeartCore Roboは起動時最初に* .tlicファイルの場所を検索し自動的に設定します。
開発画面のメニューから [ツール] - >[ライセンスキーマネージャ]ウィンドウを使用します。ここで設定するとユーザー構成ファイル(.cfg)にキーのパス（場所）が記録されます。
robot.licenseKeyシステムプロパティを通じて（v4.0.3以降）この方法はロボットと第三者のJavaアプリケーションを統合するプロジェクトに適しています。例については、リリースノートを参照してください。

--licenseserver [server_address[:port]]

指定したアドレスのライセンスサーバに接続して、実行するためのライセンスを取得します（v4.3以降）。サーバアドレスは、ホスト名（たとえば"mymachine"や"mymachine.com"）とオプションのport（"mymachine:8881"）で構成されます。ポートが指定されていない場合は、標準で8880になります。ライセンスサーバのアドレスをHeartCore Roboに渡す方法には、次の3つがあります。

このオプションを使用する。
開発画面のメニューから [ツール] - > [ライセンスキーマネージャ] ウィンドウを使用します。これによりライセンスURLがユーザー構成ファイル(.cfg)のls.addressキーに記録されます。代わりに、このオプションは-o/--optionで渡すこともできます。
robot.licenseServerシステムプロパティを通じて（v4.4以降）。この方法は、ロボットと第三者のJavaアプリケーションを統合するプロジェクトに適しています。例については、リリースノートを参照してください。

このオプションが指定されていない場合、ファイルベースのライセンスキーはなく、サーバは環境設定によって設定されません。ロボットは、ローカルマシンの標準ポート（localhost:8880）で実行されているサーバを探します。

--cfg [file]

<user_home>/.hcrobo/hcrobo.cfgの代わりに指定されたユーザー構成ファイルを使用します。このオプションを使用すると、組織内で配布するため同一条件の特定構成でロボットをパッケージ化できます。v4.0以降でサポートされています。

--createscript [filename]

このオプションは、新しいスクリプトを作成するか、既存のスクリプトを上書きしてGUIの起動時にエディタで開きます。事前定義されたコンテンツでGUIを起動する必要があるサードパーティのフレームワークとの統合を可能にすることを目的としています。オプションはGUIモードでのみ意味を持ち、-n/--nodisplayオプションが指定されている場合は無視されます。

引数のファイル名は、相対または絶対のいずれでもかまいません。相対パスが指定されると、HeartCore Roboのインストールディレクトリに対して解決されます。

このオプションは、最後のセッションからオープンスクリプトを復元する標準のHeartCore Roboの動作を上書きします。テストスクリプトがプロジェクトに属している場合、GUIは最近使用されたスクリプトの代わりにそのスクリプトを開きます。

--outputdir [path]

--createscriptで作成されたスクリプトの出力パスを初期化します。このオプションは'Var _REPORT_DIR=<path>'という変数コマンドを作成し、それをスクリプトに挿入します。--createscriptが指定されていない場合このオプションは無視されます。

注記： CLIから既存のテストスクリプトの出力パスを指定するには、-v/--variableオプションを使用して_REPORT_DIR変数を設定します。たとえば、-v "_REPORT_DIR=C:\reports"は（HeartCore Roboが終了するまで）セッション全体の出力パスを指定されたパスに固定されます。

--templatedir [path]

--createscriptで作成されたスクリプトのテンプレートパスを初期化します。このオプションは'Var _TEMPLATE_DIR=<path>'という変数コマンドを作成し、スクリプトに挿入します。--createscriptが指定されていない場合このオプションは無視されます。

注記： CLIから既存のテストスクリプトのテンプレートパスを指定するには、-v/--variableオプションを使用して_TEMPLATE_DIR変数を設定します。たとえば、-v "_TEMPLATE_DIR=C:\templates"は（HeartCore Roboが終了するまで）セッション全体のテンプレートパスを指定されたパスに修正します。

--autosave

GUIを閉じるときに--createscriptで作成されたスクリプトを自動的に保存します。--createscriptが指定されていない場合、このオプションは無視されます。

--nooutput

非出力実行 - スクリプトを実行しますが出力は生成されません。このオプションを指定すると、ScreenshotコマンドとReportコマンドはすべて正常に実行されますがファイルは生成されません。これは、スクリプトを再実行して以前の結果を上書きしたくない場合や、デバッグ目的で使用します。

--nologin

起動時にログインダイアログを表示せずメイン画面に進みます。-cまたは-rで渡されたスクリプトによって指定されたデスクトップ接続がない場合はオフラインモードで起動して、Welcomeパネルが表示されます。

--locale [locale]

指定されたロケール（言語）で製品を起動します。引数 [locale]は、インストールされている言語パックのファイル名の末尾に相当するものである必要があります。ロケールは、必須の言語 IISO-639 2 文字コード、オプションでアンダースコア、国コード (ISO-3166 2 文字)、さらにオプションでアンダースコア、バリアント (ベンダーやブラウザ固有のコード) から構成されます。例えば、"-locale de" はドイツ語でプログラムを起動しようとし、 "--locale es_MX" はメキシコのスペイン語言語パックを探します。

要求された言語が利用できない場合、プログラムは標準で英語になります。ログインダイアログを参照してください。インストールされている言語パックのリストの言語コンポーネント。製品のローカリゼーションサポートについて詳しく知りたい場合は、開発元ドキュメントのローカリゼーションインストラクションマニュアルをお読みください。

--license

HeartCore Roboのライセンスをコンソールに出力します。

使用例
./robot.sh --connect fox.robot.com:2
./robot.sh --connect fox.robot.com::5902
./robot.sh --connect rfb://fox.robot.com:5902

3つのコマンドはすべて同じで、ポート5902上のマシンfox.robot.com上で実行されているVNCサーバに接続します。サーバが認証を必要としない場合、HeartCore Robo GUIが起動し、サーバデスクトップがデスクトップビューアに表示されます。サーバにパスワードが必要な場合は、ログインダイアログが表示され、ユーザーは有効なパスワードを入力する必要があります。

./robot.sh --connect java://localhost

Javaネイティブクライアントを介して、ローカルシステムディスプレイ（画面や他の表示デバイスに表示されるデスクトップと同じデスクトップを意味します）に接続します。JavaやHeartCore Robo以外のソフトウェアは必要ありません。

./robot.sh --connect java://192.168.1.1:1099

RMIを使用してJavaネイティブ・クライアントを介してIPアドレス192.168.1.1のホストのディスプレイに接続します。ホストマシンにはJavaがインストールされており、JavaサーバモードでHeartCore Roboを実行している必要があります。詳細については、Javaクライアントのマニュアルを参照してください。（エンタープライズ版のみ）

./robot.sh -r self_connect.java

self_connect.javaというJavaのスクリプトをGUIモードでを実行します。HeartCore Roboが内部的に.class形式へコンパイルし実行します。パスが指定されていないため、ファイルをHeartCore Roboのインストールディレクトリに配置する必要があります。また、-c/--connectオプションが指定されていないため、スクリプトに独自の接続コードを内蔵する必要があります。

HeartCore Roboのインストールディレクトリにtest.txtというスクリプトテキストを用意します：


               # This
                  script opens an application on GNOME

                  
                # We take advantage of the feature that Alt+F2 

                  
                # opens the Run Application window

                   Var
               APPLICATION=""

               Press 
               Alt+F2 
              wait=5000

               Typeline 
               "{APPLICATION}"
               wait=5000

              :screenshot

               Screenshot 
               application.png

その後、コマンド：

java -Xmx128m -classpath jh.jar;activation.jar;mail.jar;poi-3.6-20091214.jar;robot.jar com.tplan.robot.ApplicationSupport -c fox.robot.com:2 -p mypassword -r test.txt -o
        scripting.delayBeforeAutomaticExecutionSeconds=5 -v APPLICATION=gnome-terminal

マシンfox.robot.com上で動作するVNCサーバにポート5902で接続し、GUIモードで呼び出されるtest.txtスクリプトの自動実行を開始します。認証が成功し、サーバへの接続が確立されると、GUIが表示され、タイムアウトカウントダウンが開始されます。パラメータ-oはタイムアウト値を再定義するため、標準の15秒ではなく5秒間続きます。時間がなくなると、スクリプトの実行が開始されます。-vオプションでAPPLICATION変数を再定義すると、スクリプトはGNOMEターミナルウィンドウを起動し、スクリーンショットを作成します。その後、標準15秒のシャットダウンカウントダウンが開始されます。時間がなくなると、GUIが廃棄され、HeartCore Roboが終了します。

java -Xmx128m -classpath
        jh.jar;activation.jar;mail.jar;

poi-3.6-20091214.jar;

robot.jar
        com.tplan.robot.ApplicationSupport

-c fox.robot.com:2 -p mypassword -r test.txt -o scripting.delayBeforeAutomaticExecutionSeconds

=5
        -v APPLICATION=gnome-terminal -n

このコマンドは、GUIが表示されず、HeartCore RoboがCLIモードで実行されていることを除いて、前のものと同じ結果を提供する必要があります。実行ログはコンソールに出力されます。

java -Xmx128m -classpath
        jh.jar;activation.jar;mail.jar;

poi-3.6-20091214.jar;

robot.jar
        com.tplan.robot.ApplicationSupport


        -c fox.robot.com:2 -p mypassword -r test.txt -v
        APPLICATION=gnome-terminal --fromlabel screenshot

このコマンドはscreenshotラベルの後の唯一のコマンドであるため、'Screenshot application.png' コマンドだけを実行します。

 robot.sh -c java://localhost
        -r test.txt -v APPLICATION=gnome-terminal

Javaネイティブクライアントを介してローカルデスクトップ上でtest.txtテストスクリプトを実行します。ローカルマシンは、デスクトップソフトウェアを実行する必要はありません。自動化は、ローカルOSレベルのディスプレイにアクセスするJavaのネイティブインタフェースを介して行われます。これにより、テストスクリプト、HeartCore Roboインスタンス、およびJavaで構成された、再配置可能、自己完結型およびローカル実行可能なテストスイートを作成できます。この例のテストスクリプトは、もともとRFBサーバで設計されていましたが、Javaを実行するための変更は必要ありません。

1.2 T-Plan統合CLIオプション（HeartCore Roboでは利用しません）

T-Plan統合CLIオプションは、他のT-Plan製品、特にT-Plan Professional 7.0との統合をサポートするための既存の標準インターフェースの拡張です。詳細については、インテグレーションリファレンスドキュメントを参照してください。このインターフェースは-o/--option、でサポートされているユーザー設定オーバーライド・メカニズムを利用しているため、実際には標準インターフェースでは新しいオプションを定義しません。各オプションは一緒に使用する必要があります-oまたは--optionたとえば、"-o tplan.url=http://localhost:4000"。

統合オプションは、HeartCore Roboに次のようなT-Planテスト管理データベースの統合タスクの1つを実行するように指示するように設計されています。

T-Plan Professionalのスクリプトエンティティを自動スクリプトにインポートし、

自動化されたテスト結果をT-Planデータベースにエクスポートします。

共通のオプションとタスク固有のオプションがあります。

一般的な統合オプション

共通のオプションには、主に各タスクに提供する必要がある資格情報が含まれます。これらのすべてのオプションの標準値は、プリファレンスウィンドウのT-Plan Connectorパネルを使用してユーザ設定ファイルに永続的に保存できます。標準値を持つオプションは、コマンドラインで省略することができます。

オプション名	説明
`tplan.url`	SOA WebサービスURL（例： "http://tplandb.mycompany.com:4000"）。HeartCore RoboとT-Planデータベースとの間のすべての通信は、通常データベースサーバ上のポート4000上で実行されるWebサービスを通じて実現されます。このパラメーターは、各統合タスクに必須です。
`tplan.user`	データベースユーザー名。これは、T-Plan Professionalにログインするために提供されなければならないパラメータと同じです。このパラメーターは、各統合タスクに必須です。
`tplan.password`	データベースへの認証用のパスワード。これは、T-Plan Professionalにログインするために提供されなければならないパラメータと同じです。このパラメーターは、各統合タスクに必須です。
`tplan.database`	接続先のデータベース名。これは、T-Plan Professionalにログインするために提供されなければならないパラメータと同じです。このパラメーターは、各統合タスクに必須です。
`tplan.group`	データベースユーザーグループ。これは、T-Plan Professionalにログインするために提供されなければならないパラメータと同じです。このパラメーターは、各統合タスクに必須です。
`tplan.debug`	デバッグフラグ（オプション）。値は "true"または "false"のいずれかです。"true"の値を指定すると、統合デバッグメッセージがコンソールに出力されます。標準値は "false"です。

インポートオプション

インポートオプションは、GUIの起動時に一度だけ処理されます。スクリプトが正常にインポートされ、エディタで開くか、タスクが失敗し、エラーメッセージが表示されます。どちらの場合もオプションは破棄されます。

オプション名	説明
`tplan.importScriptNumber`	インポートする既存のT-Plan Professionalスクリプトエンティティの番号。インポートタスクには必須です。
`tplan.scriptName`	インポートされたスクリプトエンティティの名前（オプション）。指定されている場合は、Scriptコマンドの属性として追加されます。

エクスポートオプション

エクスポートオプションは通常、-r/--runパラメータと共に自動実行とともに使用されますが、HeartCore Roboインスタンスによって実行されるすべてのスクリプトに適用されます。つまり、エクスポートオプションを使用してGUIを起動し、手動で複数のスクリプトを実行すると、各結果セットが指定されたT-Planテストスイートにエクスポートされます。このエクスポートモードを終了するには、CLI引数なしでアプリケーションを再起動します。

オプション名	説明
`tplan.autoExport`	スクリプト実行後にテスト結果をエクスポートするかどうかを示すフラグ（通常は-r / - runオプションを使用）。このタスクを実行するには、値が「true」である必要があります。エクスポートタスクには必須です。
`tplan.mode`	テスト結果のエクスポートモード。許容できる値は次のとおりです。 "create" はテスト結果をインポートするための新しいテストスイートを作成します。`tplan.newSuiteName`このモードと一緒に提供されなければなりません。`tplan.suiteNumber` オプションも指定されている場合、このパラメータで指定されたテストスイートは、新しいものの親として機能します。それ以外の場合、テストスイートはルート管理ノードのすぐ下に作成されます。 "rewrite" は、`tplan.suiteNumber`オプションで指定された既存のテストスイートのテスト結果を書き換えます。 "append"は、`tplan.suiteNumber` オプションで指定された既存のテストスイートにテスト結果を追加します。
`tplan.suiteNumber`	テスト結果をエクスポートするためのテストスイート番号。パラメータは、`tplan.mode` オプションの値に応じて新しいテストスイートまたはターゲットテストスイートを識別します。
`tplan.newSuiteName`	新しいテストスイートの名前。このオプションは、エクスポート・モードが「作成」（`"tplan.mode=create"`）のときに指定する必要があります。それ以外の場合は無視されます。

使用例
java -Xmx128m -classpath jh.jar;activation.jar;mail.jar;poi-3.6-20091214.jar;

robot.jar
      com.tplan.robot.ApplicationSupport

--createscript

test.tpr -o

tplan.url=http://localhost:4000
      -o

tplan.user=admin -o

tplan.password=dbadmin
      -o

tplan.database=testdb

 -o
      "tplan.group=System Administrators" -o

tplan.importScriptNumber=101

GUIモードでHeartCore Roboを起動し、test.tprという名前のテストスクリプトを作成し、スクリプトエディタで開きます。ファイルがすでに存在する場合は、ファイルを上書きします（ファイルの-e/--edit代わりに追加モードでファイルを開きます--createscript）。次に、T-Planの書体番号101の構造をエディタにインポートします。

java -Xmx128m -classpath
      jh.jar;activation.jar;mail.jar;

poi-3.6-20091214.jar;

robot.jar
      com.tplan.robot.ApplicationSupport

-c
      fox.robot.com:2 -p welcome -r test.tpr -o

tplan.url=http://localhost:4000
      -o

tplan.user=admin -o

tplan.password=dbadmin
      -o

tplan.database=testdb

 -o
      "tplan.group=System Administrators" -o

tplan.autoExport=true
      -o

tplan.mode=rewrite -o

tplan.suiteNumber=111

VNCサーバfox.robot.comでtest.tprスクリプトを実行します。次に、テスト結果をT-Planデータベースのテストスイート番号111にエクスポートします。エクスポートモードが「書き換え」に設定されているため、同じスクリプトの既存の結果はすべて新しいスクリプトによって上書きされます。

オフラインイメージ比較CLIオプション

概要 | オプション | 終了コード | 例

概要
HeartCore Robo は、シンプルなCLIインターフェイスを使用してオフラインイメージの比較にも使用できます。これを実行するには、次のコマンドのいずれかを使用します。ラッパースクリプトは9つ以上のパラメーターを処理できないことに注意してください。より多くのパラメータを渡す必要がある場合、またはHeartCore Roboのstartコマンドをカスタマイズする必要がある場合は、javaを用いたコマンドを使用します。

Unix / Linux：

./imgcompare.sh

<source_image>
          <template_image>

[options]

java -classpath robot.jar
        com.tplan.robot.ImageComparison

<source_image>
          <template_image> [options]

MS Windows：

imgcompare.bat

<source_image>
          <template_image>

[options]
java -classpath robot.jar com.tplan.robot.ImageComparison

<source_image>
          <template_image>

[options]

HeartCore Roboで利用可能なすべての画像比較モジュールを呼び出すことができます。これには、プラグインAPIを介してツールにプラグインされたカスタムのものも含まれます。このCLIはユーザー設定も読み込み、標準の比較方法（モジュール）、標準の合格率値、「検索」比較の検索ヒットの最大数など、GUIを使用してカスタマイズされたすべての画像比較設定を使用することに注意してください。

オプション
-s

サイレントモード。このオプションは、エラーメッセージ以外のすべての出力を抑制します。このモードは、リターンコードだけに興味がある場合に使用します。

-c

コンサイスモード。'search'メソッドと共に使用すると、[x、y]形式で1行に1つの座標が正確に出力されます。この出力は言語に依存せず、フォーマットは将来のバージョンと言語に関わらず保存されるためサードパーティのツールで解析するのに適しています。

このスイッチは'default'メソッドと一緒に呼び出されたときは-sと同じ機能を持ちます。1つのコマンドで両方-sと-cを指定すると、ツールはサイレントモードで実行されます。

-m [module]

使用する画像比較モジュール（メソッド）。HeartCore Roboは、ヒストグラムベースの比較のための「default」と画像検索のための「search」の2つを定義します。イメージの比較の詳細については、Comparetoコマンドの仕様およびHeartCore Robo ドキュメントとのイメージの比較を参照してください。
Plugin APIを使用してツールにプラグインされたカスタムモジュールも使用できます。-m パラメータの値は、そのモジュールの getMethodName() メソッドによって返される名前に対応する必要があります。

このオプションを省略すると、ユーザー設定の標準値が使用されます。

-p [passrate]

合格率（％）。この値は、0と100の間の整数または小数で指定します。この値は、画像比較結果が「合格」（終了コード0）になるように、ソース画像とテンプレート画像がどれくらい一致するかを示します。

このオプションを省略すると、ユーザー設定の標準値が使用されます。'default'（通常は95％）と'search'（100％）で別々の標準合格率であることに注意してください。

-r [rectangle]

画像比較をソースイメージの特定領域に制限します。画像の一部のアイコン、またはサブ画像を検索することが意味のある'search'メソッドで使用するものです。

値は、HeartCore Roboの矩形形式にする必要があります（例：'x:0,y:25,w:350,h:200'）。xまたはyが省略された場合0が使用されます。w（幅）またはh（高さ）のパラメータが省略された場合、その値はソース画像サイズへに関して可能な最大値として設定されます。あなたのソースイメージが例えば640x480で、あなたが指定する値が'-r x:100,h:300'の場合、矩形は'x:100,y:0,w:540,h:300'のように設定されます。オプションを省略すると、ソース画像全体に対して画像比較が実行されます。

-h [max_number_of_search_hits]

検索一致の最大数。検索一致の最大数に達すると、イメージ比較は終了し、それ以降の検知をパスします。

このオプションは'search' 比較にのみ適用されます。'default 'メソッドと一緒に使用すると無視され、エラーは報告されません。オプションを省略すると、ユーザー構成の標準値（通常は100）が使用されます。

終了コード

終了コード	意味
0	イメージ比較が合格しました。
1	画像の比較に失敗しました（「標準」：合格率が満たされていない、「検索」：合格率が合致していない）
2	エラー：ソースイメージを読み込めませんでした。
3	エラー：テンプレート画像を読み込めませんでした。
4	入力引数に構文エラーがあります（エラーを説明するメッセージが出力されます）。
5	内部エラー - HeartCore Roboサポートに報告してください。

使用例
java -classpath robot.jar;poi-3.6-20091214.jar


      com.tplan.robot.ImageComparison image.png pattern.png -m search -r
      x:0,y:20,w:120,h:300

      ./imgcompare.sh

image.png pattern.png


      -m search

-r x:0,y:20,w:120,h:300

元画像image.pngの[0,20,120,320]矩形内テンプレートイメージにあるpattern.pngを検索します。上記のコマンドはWindowsで有効です。Linux / Unixの場合、クラスパスのセミコロン ';' をコロン '：'に変更します。

java -classpath robot.jar;poi-3.6-20091214.jar


      com.tplan.robot.ImageComparison

image.png
      pattern.png -m search -p 99.9 -h 1

      ./imgcompare.sh

image.png pattern.png


      -m search

-p 99.9 -h 1

元画像image.pngからソース画像内のテンプレート画像pattern.pngの最初の99.9％一致する出現座標を検索します。上記のコマンドはWindowsで有効です。Linux / Unixの場合、クラスパスのセミコロン ';' をコロン '：'に変更します。

java -classpath robot.jar;poi-3.6-20091214.jar


      com.tplan.robot.ImageComparison

image1.png
      image2.png -m default -p 99

./imgcompare.sh

image1.png image2.png -m
      default -p 99

image1.pngとimage2.pngの画像のヒストグラムを比較して99％以上一致する場合にPASS（終了コード0）を返します。上記のコマンドはWindowsで有効です。Linux / Unixの場合、クラスパスのセミコロン ';' をコロン '：'に変更します。