カスタマイズの基本

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

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

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

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

インストール:

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

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

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

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

収集されたテスト データ

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

CSS と XSL の仕様

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

HTML レポート ファイル

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

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

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

結果:

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

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

プレビュー ファイル

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

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

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

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

結果:

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

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

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

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

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

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

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

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

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

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

出力フォルダー binDebug

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

処理の概要

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

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

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

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

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

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

ロゴ

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

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

ロゴの置き換え

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

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

ロゴのカスタマイズ

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

マージンの調整

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

結果:

Computer/Endpoint の username での置換

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

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

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

結果:

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

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

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

結果:

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

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

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

結果: