Customization basics | Ranorex Studio User Guide
Help CenterUser GuideRanorex Studio fundamentals

カスタマイズの基本

ほとんどの場合、標準のレポートを使用することが適切ですが、ニーズに合わせてカスタマイズすることもできます。カスタマイズは大きなトピックのため、 2 つの章に分けて説明します。

この章では、カスタマイズの基本について学習し、コーディングなしでレポートの外観をカスタマイズするいくつかの例を取り上げます。

参照

コーディングを含む、より複雑なカスタマイズについては、Ranorex Studio 基礎 > レポート > ⇢ より複雑なカスタマイズ を参照してください。

tipp icon

スクリーンキャスト

以下のスクリーンキャストで、この章で説明している内容を確認できます。

Watch the screencast now

サンプル ソリューションのダウンロード

この章の説明は、サンプル ソリューションを使用しておこないます。サンプル ソリューションは以下からダウンロードできます。

サンプル ソリューション

Theme: Report customization
Time: 15 minutes

Download sample file

インストール:

任意のフォルダーに解凍します。
Ranorex Studio を起動し、ソリューション ファイル RxDatabase.rxsln を開きます。

tipp icon

ヒント

このサンプル ソリューションは、Ranorex Studio 8.0 以降で利用できます。8.2 以降を利用している場合には、ソリューションのアップグレードをおこなってください。

データ ファイルからのレポートの生成処理

以下の図は、レポート データがレポートに変換される処理について示したものです。

Concept of Ranorex reporting

Concept of Ranorex reporting

  1. テスト実行中、レポート エンジンは XML 形式でデータを収集します。
  2. レポート エンジンはこのデータを、XSL および CSS によって HTML に変換し、レポート ファイルを生成します。
  3. Ranorex Studio は、この HTML ベースのレポートを、内蔵の HTML ビューアーで表示します。

収集されたテスト データ

テスト実行中に収集されたデータは、XML 形式で保存されます。このデータは、XML ビューアー/エディターを使用して、Ranorex Studio 以外で開くこともできます。

Test data in XML-file format

Test data in XML format

この XML データは、対応するレポートと常に同じフォルダーに、レポート ファイルと同じファイル名の後ろに .data を付けた名前で保存されます。

Report file and test data file

Report file and XML-data file

CSS と XSL の仕様

XML データは、CSS および XSL 仕様に基づいて、HTML を生成するために使用されます。

Concepts of XSL and CSS processing

HTML を生成するために使用される XSL と CSS は、XML およびレポート ファイルと同じ場所に配置されます。

CSS and XSL specification files

CSS and XSL specification files

参照

標準レポートのレイアウトやコンテンツを変更するためには、HTML, CSS, XSL, XML についての基本的な知識が必要です。詳しくは、World Wide Web Consortium (W3C) www.w3.org を参照してください。

HTML レポート ファイル

XSL と CSS によって XML から生成された最終的なレポートは、プロジェクト ディレクトリの Reports フォルダーに、HTML 形式で保存されます。

HTML-report file and displayed report in Ranorex Studio

HTML-based report file and report as displayed in Ranorex Studio

Note icon

メモ

  • レポートは、任意の Web ブラウザーで表示できます。
  • レポート ファイルは、任意の HTML エディターで編集できます。

カスタム レポート テンプレートの作成

レポートの生成手順を確認したので、次はレポートのカスタマイズ方法について確認します。標準レポートには影響を与えずに、Ranorex Studio 上でカスタマイズする方法があります。

テスト スイート ビューで、テスト スイートを右クリックします。
プロパティ をクリックします。
レポート タブをクリックします。

Accessing report settings

カスタム テンプレートの作成 をクリックします。
新しいレポート テンプレート フォルダーが作成された場所を示すメッセージが表示されます。

Creating a new report custom template

結果:

プロジェクト ビューで、新しいテンプレート フォルダーが作成されたことが確認できます。

NewCustomTemplate1 in project file view

NewCustomTemplate1 folder in projects view

CSS, XML, 画像ファイル

  • レイアウトとレポート コンテンツをカスタマイズするためのファイルです。
  • デフォルトのロゴとして使用される Ranorex ロゴやその他の画像を含む PNG ファイルが含まれています。これらを任意の画像で置き換えることができます。

プレビュー ファイル

  • カスタマイズ内容を確認するためのダミーのレポートです。
  • Ranorex Studio を使用せずに、Windows エクスプローラーから開くこともできます。

複数のカスタム レポート テンプレート

必要に応じて、複数のカスタム レポート テンプレートを作成できます。ただし、テスト スイートでアクティブにできるのは 1 つだけです。

追加のカスタム テンプレートは以下の手順で作成します。

テスト スイート プロパティの レポート タブで、初期設定に戻す をクリックします。
再度、カスタム テンプレートの作成 をクリックします。

Creating multiple custom report templates

結果:

プロジェクト ビューに、追加のテンプレート フォルダーが表示されます。

Example for multiple custom report templates

Example for multiple custom report templates

カスタム レポート テンプレートの名前の変更

カスタム レポート テンプレートの名前を変更できます。

プロジェクト ビューで、任意のテンプレート フォルダーを選択します。
F2 を押下し、任意の名前に変更します。
テンプレート フォルダーの名前が変更されます。

tipp icon

注意

レポート エンジンは、名前の変更を自動的には認識しません。名前を変更した後、テンプレートを再度適用する必要があります。これについては、次のセクションで説明します。

Renaming a custom report template

Renaming a custom report template

Error due to non-application of renamed custom report template

Error if the template isn’t reapplied.

カスタム レポート テンプレートの選択/再適用

この機能は、以下の場合に使用します。

  • フォルダーから既存のカスタム テンプレートを追加する場合
  • 複数のカスタム テンプレートから適用するものを選択する場合
  • テンプレートの名前を変更した後に再適用する場合
Note icon

メモ

テスト スイートでアクティブにできるテンプレートは 1 つだけです。

テスト スイート プロパティで レポート タブを開きます。
現在アクティブなカスタム テンプレートがある場合、初期設定に戻す をクリックし、デフォルトのテンプレートに戻します。

Applying a custom report template

カスタム テンプレートの選択 をクリックします。
任意のカスタム テンプレートを選択します。
OK をクリックします。

デフォルト レポート テンプレートへのリセット

カスタム テンプレートの使用を中止したい場合、いつでもデフォルトのテンプレートに戻すことができます。

テスト スイート プロパティの レポート タブを開きます。
初期設定に戻す をクリックします。

Resetting to default report template
Note icon

メモ

この操作では、カスタム レポート テンプレートは削除されません。上のセクションで説明したように、いつでも再適用できます。

Ranorex standard report template

Ranorex standard report template

Ranorex Studio のカスタム テンプレートの処理方法

Ranorex Studio には、カスタマイズされたレポート テンプレートを処理するための特別なメカニズムがあります。レポート テンプレートに外部ファイル (自社ロゴの PNG ファイルなど) を含めたい場合、デフォルトではこれらのファイルは処理の対象外となっているため、このメカニズムの理解は重要です。

出力フォルダー \bin\Debug\

テストを実行すると、Ranorex Studio は、テスト実行に必要なすべてのファイルを、プロジェクトの出力フォルダー (\bin\Debug\) にコピーします。これらのファイルには、カスタム レポート テンプレートとして生成される標準ファイルは含まれますが、ロゴなどの外部ファイルは含まれません。外部ファイルは、設定された場合のみコピーされるため、したがってデフォルトではレポートに表示されません。この設定手順については、次のセクションで説明します。

Ranorex output folder

カスタマイズされたレポート テンプレート フォルダーのコピー (例: “FrogConsulting”)
レポート フォルダー
レポート ファイル (.rxlog) とレポート データ ファイル (.rxlog.data)
CSS、XSL、デフォルトのロゴ (RanorexReport.log)

Note icon

メモ

Ranorex Studio は、テスト実行ごとに、出力フォルダーのすべてのファイルを同期します。

処理の概要

以下の図は、この処理の概要を示したものです。前述のとおり、この処理に外部ファイルを含める場合、特別な設定が必要です。以降のセクションで、その設定方法について説明します。

Preserving the newest report

カスタム レポート テンプレートがテスト スイートに適用された状態です。この例では、カスタム テンプレート フォルダー FlagConsulting が、プロジェクト フォルダーに配置されています。
最初のテスト実行時に、カスタム テンプレート フォルダーが、プロジェクトの出力フォルダーにコピーされます。
レポートのレイアウト用ファイル (CSS, XSL, カスタムのファイル) は、テンプレート フォルダーから、プロジェクトの出力フォルダーの Reports フォルダーにコピーされます。

次のテスト実行時に、プロジェクト フォルダーと出力フォルダーのカスタム テンプレートが同期されます。つまり、出力フォルダーには常に、カスタム テンプレート フォルダーの最新のファイルが配置されます。

レポートへの外部ファイルの追加

デフォルトでは、Ranorex Studio はレポート処理で内部ファイル (.rxlog, rxlog.data, .css, .xsl) のみを扱い、これらのファイルのみを出力フォルダーにコピーします。カスタム レポートにロゴなどの外部ファイルを表示するには、この処理にこれらのファイルを手動で追加する必要があります。

外部ファイルを、カスタム レポート テンプレート フォルダーにコピーします。
Ranorex Studio のプロジェクト ビューで 更新 ボタンをクリックし、このファイルがテンプレート フォルダーに表示されることを確認します。

‘Refresh’ button in project file view toolbar

外部ファイルを右クリックします。
プロジェクトに追加 をクリックします。
ファイルがプロジェクトに追加されますが、さらに設定が必要です。

Including custom file(s) into project

カスタム レポート フォルダーにコピーされたファイルは、最初はプロジェクトの一部ではないため、レポート処理にも含まれていません。プロジェクト ビューでグレイアウト表示されています。

外部ファイルを選択し、F4 を押下しプロパティを開きます。
Copy to output directoryNever に設定されています。つまり、レポート処理から除外されている状態です。これを、Always または Preserver newest に変更します。

File property pane with preservation setting

Never: 新しく追加された外部ファイルのデフォルト設定です。
Always: テスト実行ごとに常にファイル コピーがおこなわれます。
Preserve newest: \Reports\ フォルダーにあるファイルのバージョンが出力フォルダーのものより新しい場合のみコピーがおこなわれます。出力フォルダーにファイルがない場合には常にコピーがおこなわれます。

背景色とロゴのカスタマイズ

この例では、レポートの背景色を変更し、Ranorex ロゴをカスタムのものに置き換えます。この例は、章の冒頭でダウンロードできるサンプル ソリューションを使用しています。

ロゴ

  • ロゴは特定のサイズである必要はありません。任意のサイズのものが使用できます。
  • ロゴで使用されている色の正確な HEX 値を把握しておくとよいでしょう。

サンプルのロゴを用意しました。緑色の背景部分の HEX 値は #ACDB6B です。

Prepared sample logo

このサンプル ロゴは、FrogConsulting カスタム レポート テンプレート フォルダーにあります。

Prepared logo in the custom report template

ロゴの置き換え

ロゴを置き換えるには CSS ファイルの変更が必要です。

プロジェクト ビューで、CSS ファイルをダブルクリックします。
新しいタブでファイルが開かれます。

Exchanging report logo

ファイルの最後に移動し、customization エリアを探します。
この部分を、以下の図で示す内容に書き換えます。

Insert customized CSS specification

背景のカスタマイズ

  • background-color を、ロゴの背景色と同じ HEX 値に設定します。
  • 他の設定はそのままにします。

ロゴのカスタマイズ

  • height と width をロゴのサイズに設定します。
  • デフォルトのロゴ ファイル名を、”frogconsulting.png” に置換します。
  • 他の設定はそのままにします。

マージンの調整

  • 最後に、ページの top-margin を 40px に設定します。

結果:

Example custom report layout
tipp icon

ヒント

レポートにロゴが表示されない場合には、ロゴ ファイルをプロジェクトとレポート処理に追加していることを確認してください。

Computer/Endpoint の username での置換

レポートの内容を変更するための多くのオプションがあります。ここでは、基本原則と、レポートをカスタマイズするための 3 つの例を説明します。最初の例では、”Computer/Endpoint” の代わりに、”username” を表示するカスタマイズをおこないます。

Replacing machine name with username

Replacing Computer/Endpoint with user name

エントリのタイトルを定義する XSL ファイルの行
実際の computer/endpoint 名を格納している、レポート データ ファイルの “host” 行
XSL ファイルのこの行は、レポート データ ファイルの “host” 行から computer/endpoint 名を取得し、レポートの “Computer/Endpoint” エントリに表示します。

“Computer/Endpoint” エントリを “Username” エントリで置換するには、以下の手順でおこないます。

XSL ファイルの “Computer/Endpoint” を “Frog user” に置換します。
XSL ファイルの @host 変数を @user 変数に置換します。

Report username customization

Report username customization

ファイルを保存して閉じます。

結果:

Report with customized username

Report with customized username

レポート メッセージのフォーマット変更

この例では、特定の種類のレポート メッセージのフォーマットを変更します。

以下の図で示されるように、Success レベルのメッセージは、デフォルトでは緑色で表示されていますが、これを 太字の青色 に変更します。

Default successful test validation report message

デフォルトの 緑色Success メッセージ

CSS ファイルを開きます。
Success メッセージの色定義部分を探し、これをコピーします。
ファイルの最後にある customization セクションに貼り付けし、以下の図で示す内容に変更します。
ファイルを保存して閉じます。

Changing font-color of test validation message

Success メッセージのデフォルトの font color 定義
デフォルトの定義を上書きする、customization セクションでの新しい定義

Note icon

メモ

デフォルト定義 (行 #197 ~ #199) は変更しないでください。デフォルト定義を残しておけば、いつでも元に戻すことができます。

結果:

Changed report with newly formatted test validation message

Customized Success message

レポートからの情報の削除

この例では、レポートから情報を削除します。これは単純に、レポートのスペースを開放したい場合に便利です。

この例では、レポート メッセージの Time カラムを削除します。

Non-necessary standard report information

XSL ファイルを開きます。
すべての Time 記述を探します。

CSS default specification for table row time information

XSL ファイルで Time カラムを定義している行
以下のように、該当部分すべてをコメント アウトします。

Commenting CSS code

各アクション行の Time 値を取得しレポートに表示するコード
以下のように、該当部分をコメント アウトします。

Commenting CSS code

結果:

Custom report with missing time information

Custom report without Time column