Complex customizations | Ranorex Studio User Guide
Help CenterUser GuideRanorex Studio fundamentals

より複雑なカスタマイズ

この章では、レポートのさらに複雑なカスタマイズ方法について説明します。コーディング スキルが必要となるため、Ranorex Studio のコード モジュールに精通している必要があります。

参照

コード モジュールについては、Ranorex Studio エキスパート > ⇢ コード モジュール を参照してください。

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

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

サンプル ソリューション

Theme: Complex report customizations
Time: 30 minutes

Download sample file

インストール:

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

tipp icon

ヒント

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

標準のレポート クラス

コードでレポート メッセージを作成するもっとも簡単な方法は、6 つの標準レポート クラスを使用することです。T

標準のレポート クラス

Ranorex Studio には、以下のような 6 つの標準レポート クラスがあります。これらのクラスは、それぞれの標準レポート レベルに対応しています。

Ranorex.Report.Debug(“Debug message”);

Ranorex.Report.Info(“Information message”);

Ranorex.Report.Warn(“Warning message”);

Ranorex.Report.Error(“Error message”);

Ranorex.Report.Success(“Success message”);

Ranorex.Report.Failure(“Failure message”);

コード モジュールを作成し開きます。

Run() メソッドに、標準レポート クラスのインスタンスを追加します。

Applying Ranorex standard report classes

テスト スイートからコード モジュールを実行し、レポートの結果を確認します。

Report messages of standard report classes

Report messages from standard report classes

tipp icon

ヒント

すべてのレポート メッセージを表示するために、テスト スイートのレポート レベルが Debug に設定されていることを確認してください。

ユーザー コード アクションを含むレポート

コード モジュールを使用することに加えて、ユーザー コード アクションを使用してレコーディング モジュールにレポート メッセージを作成することもできます。

参照

ユーザー コード アクションについては、Ranorex Studio 基礎 > アクション > ⇢ ユーザー コード アクション を参照してください。

レコーディング モジュールを開きます。

新しいユーザー コード アクション ReportInformation() を追加し、これを開きます。

Insertion of a user code action to a recording module

ユーザー コード アクションのコンストラクターに、新しいレポート メッセージを追加します。

レコーディング モジュールを実行し、レポートの結果を確認します。

Test report message from user code action

デフォルトのレポート カテゴリのカスタマイズ

デフォルトでは、カスタム レポート メッセージのカテゴリは User です。メッセージごとに、または、すべてのメッセージについて、この設定を変更できます。

メッセージごと

新しいコード モジュールを作成して開きます。

以下のコードを追加します。

Defining a temporary custom report category

Defining a temporary custom report category

カテゴリ Cat.A で表示されるレポート メッセージ

デフォルトのカテゴリ User で表示されるレポート メッセージ

結果:

Temporarily set customized report category

上記で定義したカテゴリでレポート メッセージが表示されます。

デフォルト カテゴリの変更

新しいコード モジュールを作成して開きます。

以下のコードを追加します。

Defining a permanent custom report category

Defining a permanent custom report category

ユーザー定義のレポート メッセージのデフォルト カテゴリの新しい値として Cat.A を定義する行

新しいデフォルト カテゴリで表示されるレポート メッセージ

結果:

Permanently set customized report category

変更したカテゴリ Cat.A でレポート メッセージが表示されます。

カスタム レポート レベルの定義

任意の名前と値を使用して、カスタム レポート レベルを定義できます。

以下のコードで、カスタム レポート レベル MIDLOW を定義します。

新しいレポート レベルで、2 つのユーザー定義のレポート メッセージを作成します。

Definition of user-defined report levels

結果:

Test report with user-defined report levels

新しいレポート レベルで表示されたレポート メッセージ

カスタム レポート レベルのフォーマット

以下のコードで、レポート レベルにカスタム CSS を適用します。

Formatting a user-defined report level

カスタム CSS が適用されたレポート メッセージ

カスタム レポート レベルでのしきい値の設定

この例では、カスタム レポート レベルを使用して、レポート レベルしきい値を設定します。

2 つのカスタム レポート レベルを定義します。

現在のレポート レベルしきい値を、MID 以上に設定します。

レポート レベル LOWMID の 2 つのレポート メッセージを作成します。

Setting the current report level

結果:

Test report with level-filtered report messages

レポート レベル MID 以上のレポート メッセージのみが表示されたレポート

現在のレポート レベルの上書き

現在のレポート レベルを、特別なレポート レベル Always で上書きできます。

Overriding the current report level

Overriding the current report level

2 つのカスタム レポート レベルを定義します。

現在のレポート レベルしきい値を、MID 以上に設定します。

2 つのレポート メッセージを作成します。片方は現在のレポート レベルを上書きします。

結果:

Overridden report level

現在のレポート レベルに関係なく、2 番目のレポート メッセージが表示

レポート スクリーンショット

以下のコードを追加して、レポートにスクリーンショットを追加します。リポジトリ アイテムを指定しない場合、Ranorex Studio はコード実行時に表示されているもののスクリーンショットを取得します。

Reporting desktop screenshots

取得されたデスクトップのスクリーンショット

参照

特定のリポジトリ アイテムのスクリーンショットの取得方法については、Ranorex Studio エキスパート > ⇢ コード モジュール を参照してください。

システム サマリのレポート

レポートにシステム サマリを表示するために、以下のコードを追加します。

Reporting system summary

Info メッセージで表示されたシステム サマリ

カスタム データの追加

テスト実行中に、カスタマイズされたデータを収集し、レポート データ ファイル(.rxlog.data) に書き込むことができます。

レポート データ ファイルへのカスタム データの追加

カスタム データの収集は、この機能を備えたメソッドをユーザー コードで使用することで可能になります。

Ranorex Studio の現在のアクティビティ スタックを参照するオブジェクトを定義します。このアクティビティ スタックは、テスト実行中のすべてのアクティビティがスタック データ構造によって収集される場所です。

アクティビティ スタックにアクティビティを追加します。アクティビティ スタック メソッド CustomProperties は、レポートされたアクティビティをアクティビティ スタックに追加します。アクティビティは、名前 (例: myName) と値 (例: myValue) の 2 つの文字列で定義されます。

Customized report data generation

結果:

  • レポート データ ファイルにカスタム データ フィールドが追加されます。
Custom report data in test data file

カスタム データを含むレポート データ ファイル

  • Ranorex Studio によるレポート生成処理以外の目的でテスト データを使用したい場合、必要に応じてこの XML をパースできます。
  • レポートにカスタム データを表示する方法については、次のセクションを参照ください。

レポートへのカスタム データの追加

参照

XML, CSS, XSL については、World Wide Web Consortium (W3C) を参照してください。

レポートにカスタム データを含めるには、レポートに対応する XSL ファイルを、XML エディターまたは Ranorex Studio で変更する必要があります。

以下の図で示すコードを追加します。

Customization of XSL specification

レポート データ ファイル内にあるカスタム データの場所を識別するフィールド ペア

カスタム データの前に表示するヘッダーを追加する行

対応するフィールドの値を取得する行

結果:

Custom data in rest report

カスタム データが表示されたレポート