TestStand​レポート​の​生成​と​カスタマイズ

概要

自動​テスト​システム​の​一般​的​な​要件​の​1​つ​は、​「シーケンス​テスト​では​何​を​行う​の​か」、​「各​被​試験​装置​(UUT)​で​どの​よう​な​結果​が​得​ら​れ​た​の​か」​といった​質問​に​答え​られる​よう​に、​すべて​の​結果​情報​を​含む​完全​な​レポート​を​生成​する​こと​です。

この​ドキュメント​では、​レポート​の​追加​データ​を​含む​各種​レポート​形式​の​設定​方法​や​レポート​の​カスタマイズ​方法​など、​TestStand​レポート​に関する​情報​を​提供​し​ます。

内容

TestStand​による​レポート​の​生成​方法

TestStand​レポート​の​カスタマイズ​に​使用​できる​オプション​を​調べる​前​に、​TestStand​レポート​の​生成​プロセス​の​仕組み​を​最初​に​理解​し​て​おく​こと​が​重要​です。

TestStand​は、​2​段階​の​アプローチ​を​使用​し​て​テスト​レポート​を​生成​し​ます。

  1. 結果​の​収集: TestStand​は、​テスト​の​実行​中​に​結果​データ​を​収集​し​ます。​これらの​統合​さ​れ​た​結果​は、​レポート​生成​や​データベース​ロギング​など、​すべて​の​結果​処理​に​使用​さ​れ​ます。
  2. レポート​生成: TestStand​レポート​ジ​ェ​ネ​レ​ータ​は、​結果​収集​プロセス​で​収集​さ​れ​た​データ​を​使用​し​て、​レポート​ファイル​を​生成​し​ます。

この​プロセス​の​図​を​次に​示し​ます。

TestStand​は、​ResultList​変数​に​テスト​結果​を​収集​し​ます。​レポート​ジ​ェ​ネ​レ​ータ​では​この​変数​を​使用​し​て、​読み取り​可能​な​テスト​レポート​を​作成​し​ます。


​結果​の​収集

TestStand​は​シーケンス​を​実行​し​ながら、​ステップ​の​結果​と、​レポート​に​含める​追加​情報​を​収集​し​ます。​結果​の​収集​は​TestStand​エンジンによって直接実装され、​レポート​生成​や​データベース​ロギング​など​の​結果​処理​と​は​無関係​に​行​われ​ます。


​Locals.ResultList​プロパティ

シーケンス​では、​すべて​の​新しい​シーケンス​で​自動的​に​作成​さ​れるLocals.ResultListを​使用​し​て、​結果​データ​を​格納​し​ます。​TestStand​は、​シーケンス​の​実行​中​に​ResultList​に​データ​を​入力​し、​メモリ​(RAM)​に​保存​し​ます。

ResultList​ローカル​変数​は​コンテナ​の​配列​で​あり、​最初​は​空​の​状態​です。​各​ステップ​の​実行​後、​TestStand​は​新しい​コンテナ​要素​を​配列​の​最後​に​追加​し​て、​実行​した​ステップ​の​結果​を​格納​し、​次​の​2​つ​の​ソース​を​使用​し​て​データ​を​入力​し​ます。

  • カスタム​結果​プロパティ: 実行​した​ステップ​の​Step.Result​コンテナ​から​取得​さ​れ​ます。
  • 標準​結果​プロパティ: TestStand​エンジン​から​取得​さ​れ​ます。


​カスタム​結果​プロパティ

ResultList​の​データ​の​一部​は、​ステップ​プロ​パテ​ィ​から​取得​さ​れ​ます。 デフォルト​では、​ステップ​プロ​パテ​ィ​の​Result​コンテナ​内​の​プロパティ​のみ​が​結果​の​収集​に​使用​さ​れ​ます。​たとえば、​ステップ​結果​コンテナ​の​2​つ​の​重要​な​要素​は​次​の​とおり​です。

  • Result.Status: ステップ​の​テスト​結果​を​示す​文字​列​要素。
  • Result.Error: ステップ​に関する​エラー​情報​を​格納​する​コンテナ。

ステップ​プロ​パテ​ィ​は、​ステップ​タイプ​によって​異なる​場合​が​あり、​多く​の​ステップ​プロ​パテ​ィ​は​特定​の​ステップ​タイプ​に​のみ​存在​し​ます。​たとえば、​プロパティStep.Result.Numericは、​数値​リミット​テスト​の​ステップ​タイプ​に​固有​です。


​標準​結果​プロパティ

ステップ​プロ​パテ​ィ​を​ResultList​に​コピー​する​ことに​加​えて、​TestStand​は​一連の標準​結果​プロパティを​各​ステップ​に​追加​し​ます。​TestStand​エンジン​は、​これらの​結果をStep.Result.TSプロパティ​の​サブプロパティ​として​追加​し​ます。 これらの​プロパティ​に​は、​ステップ​名、​タイプ、​タイミング​情報​など、​ステップ​に関する​識別​情報​が​含​まれ​てい​ます。

以下​の​図​は、​ResultList​に​ステップ​結果​プロパティ​と​標準​結果​プロパティ​が​どの​よう​に​入力​さ​れる​か​を​示し​てい​ます。

結果​データ​は、​ステップ​タイプ​によって​異なる​カスタム​結果​プロパティ​と、​すべて​の​ステップ​で​同じ​で​ある​標準​結果​プロパティ​から​生成​さ​れ​ます。

 

結果​の​収集​方法​を​設定​する

結果​の​収集​に​追加​の​プロパティ​を​含める

Execution.AddExtraResultメソッド​を​使用​し​て、​特定​の​ステップ​プロ​パテ​ィ​を​ResultList​に​追加​でき​ます。​この​メソッド​では、​プロパティ​の​ルック​アップ​文字​列​("Step.myStepData"など)​を​指定​でき、​実行​内​で​この​プロパティ​を​含む​すべて​の​ステップ​の​結果​リスト​に、​この​プロパティ​が​追加​さ​れ​ます。 また、​この​メソッド​では、​ResultList​内​で​プロパティ​に​使用​する​名前​を​指定​する​こと​も​でき​ます。

たとえば、​プロセス​モデル​は​Execution.AddExtraResult​メソッド​を​呼び出し​て、​ResultListにStep.Limits値とStep.Comp値​を​格納​し​ます。​これらの​プロパティ​は​Step.Result​コンテナ​に​含​まれ​ない​ため、​デフォルト​では​収集​さ​れ​ま​せん。​この​呼び出し​により、​実行​内​で​これらの​プロパティ​を​含む​すべて​の​ステップ​の​ResultList​に、​これらの​プロパティ​が​追加​さ​れ​ます。

AddExtraResult​を​使用​し​て、​追加​の​ステップ​プロ​パテ​ィ​を​結果​リスト​に​追加​する

 

レポート​の​その他​の​プロパティ​の​詳細​について​は、​TestStand​ヘルプ​の「カスタム​結果​プロパティ」​トピック​を​参照​し​て​くだ​さい。


​結果​を​収集​する​頻度​を​設定​する

TestStand​による​結果​の​収集​は、​レポート​を​生成​する​か​データベース​に​記録​する​か​に​関係​なく​行​われ​ます。 結果​を​記録​する​必要​が​ない​場合​は、​特定​の​ステップ​または​シーケンス​について​結果​の​収集​を​無効​に​する​こと​も​でき​ます。 記録​する​結果​を​制御​する​ため​に、​次​の​設定​を​使用​でき​ます。

  • すべて​の​シーケンス​で​結果​の​記録​を​無効​化: ステーション​オプションの実行タブ​に​ある​この​設定​は、​すべて​の​結果​の​収集​を​完全​に​無効​にし​ます。 TestStand​の​結果​処理​を​使用​し​て​データ​を​記録​しない​場合​は、​この​設定​を​使用​し​ます。
  • すべて​の​ステップ​で​結果​の​記録​を​無効​化: シーケンス​の​プロパティ​に​ある​この​設定​は、​特定​の​シーケンス​について​結果​の​記録​を​無効​にし​ます。
  • ステップ​結果​記録​オプション: ステッププロパティペ​ーンの実行​オプションに​ある​この​オプション​を​使用​すると、​特定​の​ステップ​について​結果​の​記録​を​無効​に​でき​ます。 デフォルト​では、​この​設定​より​も​上記​の​シーケンス​設定​が​優先​さ​れ​ます。​ただし、有効​(シーケンス​設定​の​オーバー​ライ​ド)を​選択​すると、​結果​の​記録​が​無効​に​な​って​いる​シーケンス​内​の​特定​の​ステップ​の​結果​を​記録​でき​ます。

テスト​システム​の​パフォーマンス​または​システム​メモリ​の​使用​率​が​問題​に​なる​場合​は、​不必要​な​結果​の​保存​を​防ぐ​ため​に、​頻繁​に​実行​さ​れる​ステップ​の​結果​の​記録​を​無効​に​する​こと​を​検討​し​て​くだ​さい。

 

レポート​生成

TestStand​エンジン​の​一部​で​ある​結果​収集​プロセス​と​は​異​なり、​レポート​ジ​ェ​ネ​レ​ータ​は​TestStand​プロセス​モデル​により、​レポート​生成​プラグ​イン​を​介​し​て​実装​さ​れ​ます。​レポート​ジ​ェ​ネ​レ​ータ​の​実装​の​詳細​について​は、「レポート​生成​の​説明」​の​記事​を​参照​し​て​くだ​さい。

レポート​ジ​ェ​ネ​レ​ータ​は、​結果収集プロセスで生成された​ResultList​変数​の​結果​データ​を​使用​し​て​(詳細​について​は、​この​ドキュメント​の​「結果​の​収集」​セクション​を​参照)、​レポート​を​生成​し​ます。 この​セクション​では、​TestStand​の​デフォルト​の​レポート​ジ​ェ​ネ​レ​ータ​の​概要​について​説明​し​ます。


​レポート​に​含める​データ​に​フラグ​を​付ける

レポート​ジ​ェ​ネ​レ​ータ​は、​ResultList​に​収集​さ​れ​た​結果​プロパティ​の​プロパティフラグ​を​使用​し​て、​それら​を​レポート​に​含める​か​どうか​を​決定​し​ます。​プロパティフラグ​を​使用​すると、​どの​よう​に​テスト​レポート​に​含める​か​など、​PropertyObject​に関する​処理​の​詳細​を​設定​でき​ます。

PropertyObject​の​フラグ​は、​次​の​2​つ​の​方法​の​いずれ​か​で​表示​および​設定​でき​ます。

  1. シーケンス​エディタ​の​使用: プロパティ​を​右​クリック​し、上級​→​フラグ​を​編集を​選択​し​て、フラグ​を​編集ダイアログ​を​表示​し​ます。 新規​フラグフィールド​に、​選択​さ​れ​て​いる​すべて​の​フラグ​の​現在​の​合計​が​表示​さ​れ​ます。


フラグ​を​編集ダイアログ​を​使用​し​て​PropertyObject​フラグ​を​設定​する

  1. TestStand API​の​使用: PropertyObject.GetFlags​メソッド​で​フラグ​の​状態​に​アクセス​し、​PropertyObject.SetFlags​メソッド​で​フラグ​の​状態​を​設定​でき​ます。

各​フラグ​に​は​一意​の​値​が​あり、​プロパティ​の​現在​の​フラグ​の​状態​は、​その​すべて​の​フラグ​値​の​合計​です。 たとえば、PropFlags_IsLimit(値: 0x1000)とPropFlags_IncludeInReport(値: 0x2000)​の​フラグ​が​有効​に​な​って​いる​プロパティ​の​フラグ​値​は、​0x3000​です。​各​フラグ​の​詳細​について​は、「PropertyFlags​定数」​ヘルプ​トピック​を​参照​し​て​くだ​さい。

以下​の​フラグ​は、​収集​さ​れ​た​結果​を​レポート​に​追加​する​か​どうか​を​レポート​ジ​ェ​ネ​レ​ータ​が​決定​する​際​に​使用​さ​れ​ます。 詳細​について​は、「レポート​に​影響​を​与える​プロパティフラグ」​を​参照​し​て​くだ​さい。

  • PropFlags_IncludeInReportフラグ​は、​プロパティ​を​常に​レポート​に​含める​こと​を​示し​ます。
  • PropFlags_IsLimitフラグ​またはPropFlags_IsMeasurementValueフラグ​は、​現在​の​レポート​オプション​に​基​づ​い​て​データ​を​含める​こと​を​示し​ます。


​TestStand​レポート​の​形式

TestStand​に​は​多く​の​レポート​形式​が​あり、​それぞれに​長所​と​短所​が​あり​ます。 レポート​ジ​ェ​ネ​レ​ータ​は、​各​形式​に​固有​の​シーケンス​ファイル​(例: ReportGen_ATML.seq)​を​呼び出し​て、​レポート​テキスト​を​生成​し​ます。​各​レポート​形式​の​詳細​について​は、​次​の​表​を​参照​し​て​くだ​さい。

レポート​形式 可読性 ファイルサイズ パフォーマンス 解析1 カスタマイズ
ASCII(.txt)
基本​的​な​テキスト​レポート​形式
基本 非常​に​小さい 最速 中​程度 - カスタム​パーサー​が​必要​だが、​形式​情報​は​限​られる
HTML(.html)
リッチ​テキスト​レポート​形式
リッチ​テキスト 中​程度
XML(.xml)
データ​のみ​の​ファイル​形式​で​あり、​XSL​スタイル​シート​を​使用​し​て​リッチ​テキスト​を​生成​する
リッチ​テキスト 簡単 - 標準​の​XML​スキーマが使用され、​XML​の​API​を​使用​し​て​簡単​に​解析​可能 中​程度 - スタイル​シート​を​使用​し​て、​プロセス​モデル​を​変更​せ​ず​に​形式​を​カスタマイズ
ATML(.xml) - 自動​テスト​マーク​アップ​言語 リッチ​テキスト 中​程度 高速 簡単 - 標準​の​XML​スキーマが使用され、​XML​の​API​を​使用​し​て​簡単​に​解析​可能 中​程度 - スタイル​シート​を​使用​し​て、​プロセス​モデル​を​変更​せ​ず​に​形式​を​カスタマイズ

1 レポート​ファイル、​特に​XML​および​ATML​レポート​ファイル​を​使用​し​て​自動​レポート​分析​を​行​え​ます​が、​データベース​を​使用​し​て​自動​分析​を​行う​方​が​通常​は​効率​的​です。 TestStand​で​データベース​に​記録​する​機能​の​詳細​について​は、「データベース​ロギング」​ヘルプ​トピック​を​参照​し​て​くだ​さい。

TestStand 2019​から、​ASCII (.txt) 以外​の​レポート​形式​ごと​に、​PDF​レポート​も​生成​できる​よう​に​なり​ま​した。​詳細​について​は、「PDF Report Generation」​を​参照​し​て​くだ​さい。

アプリケーション​に​最適​な​レポート​生成​戦略​を​選択​する​方法​の​詳細​について​は、「テスト​システム​に​最適​な​NI TestStand​レポート​生成​方法​を​選ぶ​には」​を​参照​し​て​くだ​さい。


​オンザフライ​で​レポート​を​生成​する

レポート​オプションダイ​ア​ログ​ボックスのコンテンツタブでオンザフライ​レポートオプション​を​有効​に​すると、​プロセス​モデル​は、​UUT​テストの完了まで待たずに、​実行​と同時に​レポート​を​段階​的​に​生成​し​ます。​オンザフライ​レポート​を​使用​する​場合​は、実行ウィンドウのレポートペ​ーン​を​クリック​し​て、​実行​中​に​レポート​を​表示​でき​ます。​テスト​の​実行​に​沿​って​レポート​が​更新​さ​れる​ため、​レポートビュー​は​テスト​シーケンス​の​実行​に​伴​い​定期​的​に​新しい​結果​で​更新​さ​れ​ます。

通常、​オンザフライ​レポート​は、​テスト​が​長時間​にわたり、​テスト​の​スループット​が​メモリ​使用​量​や​データ​損失​の​防止​ほど​重要​では​ない​場合​に​適​し​てい​ます。  

長所 短所
  • テスト​の​実行​中​に​テスト​結果​を​表示​できる
  • テスト​中​に​予期​しない​シャット​ダウン​が​発生​し​て​も​レポート​ファイル​が​失​われ​ない
  • 長時間​の​テスト​で​メモリ​使用​量​の​増加​を​防止1
  • テスト​中​の​レポート​生成​の​オーバー​ヘッド​により、​場合​によって​は​テスト​の​パフォーマンス​が​低下​する​可能性​が​ある2
  • レポート​ジ​ェ​ネ​レ​ータ​の​カスタマイズ​が​難しい

 


1メモリ​使用​量​の​増加​を​防ぐ​に​は、​追加​の​設定​が​必要​です。​レポート​生成​中​の​メモリ​使用​量​の​増加​を​防ぐ​方法​の​詳細​について​は、「TestStand​で​の​レポート​生成​による​メモリ​の​問題​へ​の​対処」​を​参照​し​て​くだ​さい。

2この​問題​は​TestStand 2012​以降で軽減され、​オンザフライ​レポート​ジ​ェ​ネ​レ​ータ​が​レポート​を​再生​成​する​頻度​を​設定​できる​よう​に​な​って​い​ます。 この​設定​の​詳細​について​は、「結果​処理​の​上級​設定​ダイ​ア​ログ​ボックス」​ヘルプ​トピック​を​参照​し​て​くだ​さい。 TestStand 2012​以降​では、​500​ステップ​の​結果​が​収集​さ​れる​か​実行​時間​が​1.5​秒​経過​する​か​の​いずれ​か​早い​方​の​タイミング​で、​オンザフライ​レポート​を​生成​し​保存​する​よう​デフォルト​で​設定​さ​れ​てい​ます。 TestStand 2010 SP1​以前​では、​レポート​は​各​ステップ​の​後に​再生​成​さ​れ​ます。


​非同期​の​レポート​生成

TestStand 2012​以降​では、​レポートジェネレータ​(および​その他​の​結果​処理​プラグ​イン)​を​非同期​で​実行​し​て、​テスト​の​スループット​を​高める​こと​が​でき​ます。 この​オプション​を​設定​する​に​は、構成​→​結果​処理を​選択​し、その他​の​オプション​を​表示チェック​ボックス​を​オン​にし​ます。 新規​スレッド列​に、​各​プラグ​イン​の​現在​の​設定​が​示​さ​れ​ます。

この​機能​を​使用​すると、​下​の​画像​に​示す​よう​に、​現在​の​UUT​の​レポート​を​生成​し​ながら、​すぐ​に​次​の​UUT​の​テスト​を​開始​でき​ます。

メモ: オンザフライ​で​レポート​を​生成​する​場合、​非同期​レポート​は​使用​でき​ま​せん。

非同期​の​結果​処理​により、​次​の​ユニット​の​テスト​を​すぐ​に​開始​できる​ため、​テスト​の​スループット​が​向上

TestStand​レポート​を​カスタマイズ​する

TestStand​の​レポート​生成​プロセス​は​高度​な​カスタマイズ​が​可能​で​あり、​生成​さ​れ​た​レポート​を​TestStand​アプリケーション​の​要件​に​合わせ​て​調整​でき​ます。 レポート​は​次​の​よう​な​方法​で​カスタマイズ​でき​ます。

  • コード​を​変更​せ​ず​に​カスタマイズ​できる​よう​に、​レポート​オプション​を​設定​し​ます。
  • TestStand​の​標準​機能​を​使用​し​て、​追加​の​データ​を​レポート​に​記録​し​ます。
  • スタイル​シート​を​変更​する​か、​レポート​生成​コール​バック​を​オーバー​ライ​ド​し​て、​レポート​の​外観​に​さらに​重要​な​変更​を​実装​し​ます。

レポート​オプション​ダイ​ア​ログ​を​使用​する

レポート​オプションダイアログからアクセスできるレポート生成オプションを使用すれば、​コード​を​変更​する​こと​なく​TestStand​レポート​を​カスタマイズ​でき​ます。​TestStand 2012​以降​で​この​ダイアログ​に​アクセス​する​に​は、構成​→​結果​処理の​順に​選択​してレポート​オプションダイアログ​を​起動​し、​レポート​生成​プラグ​イン​の​設定​アイコ​ン​を​選択​し​ます。 TestStand 2010 SP1​以前​の​場合​は、構成​→​レポート​オプションの​順に​選択​し​ます。

レポート​オプション​ダイ​ア​ログ​では、​次​の​方法​で​レポート​を​設定​でき​ます。

  • レポート​の​形式​を​変更​する
  • 特定​の​タイプ​の​ステップ​結果​を​含める​よう​に​レポート​を​フィルタ​処理​する
  • レポート​の​外観​を​設定​する
  • オンザフライ​レポート​の​生成​を​有効​に​する


​以降​の​セクション​では、​これらの​各​タイプ​の​設定​について​詳​しく​説明​し​ます。

レポート​オプションダイ​ア​ログ​ボックス – コンテンツタブ


​レポート​形式

レポート​オプションダイアログ​では、​レポート​の​形式​を​選択​でき​ます。 使用​可能​な​レポート​形式​の​詳細​について​は、​この​ドキュメント​の「レポート​生成」​セクション​の​「レポート​形式」​セクション​を​参照​し​て​くだ​さい。 一部​の​レポート​オプション​は、​特定​の​レポート​形式​で​のみ​使用​でき​ます。


​ASCII​および​HTML​固有​の​レポート​オプション

ASCII​レポート​と​HTML​レポート​は、​次​の​2​つ​の​方法​の​いずれ​か​で​生成​でき​ます。

  • シーケンス​の​使用: ReportGen_txt.seqまたはReportGen_html.seqシーケンス​ファイル​内​の​シーケンス​によって​レポート​を​生成​し​ます。​この​方法​では、​レポート​生成​シーケンス​を​変更​または​オーバー​ライ​ド​する​こと​で、​レポート​ジ​ェ​ネ​レ​ータ​を​より​簡単​に​カスタマイズ​でき​ます​が、​実行​速度​は​遅​く​なり​ます。​この​オプション​は、​レポート​ジ​ェ​ネ​レ​ータ​を​カスタマイズ​する​場合​に​お​勧め​し​ます。
  • DLL​の​使用: modelsupport2.dllを​使用​し​て​レポート​を​生成​し​ます。​これ​により、​パフォーマンス​は​高速​に​なり​ます​が、​カスタマイズ​が​難​しく​なり​ます。 この​オプション​は、​カスタマイズ​を​ほとんど​または​まったく​行​わ​ず​に​デフォルト​の​レポート​ジ​ェ​ネ​レ​ータ​を​使用​する​場合​に​お​勧め​し​ます。
XML​および​ATML​固有​の​レポート​オプション

HTML​レポート​と​は​異​なり、​XML​および​ATML​レポート​に​は​形式​情報​が​含​まれ​てい​ま​せん。​XML​形式​の​未処理​データ​を​読み取り​可能​な​レポート​として​表示​する​ため​に、​XSL​スタイル​シート​が​使用​さ​れ​ます。 この​スタイル​シート​によって​レポート​の​スタイル​を​定義​し、​XML​ファイル​から​データ​を​取り込み​ます。 スタイル​シート​を​使用​する​こと​で、​XML​データファイル​を​変更​せ​ず​に​レポート​の​外観​を​変更​でき​ます。​たとえば、​以下​の​画像​は、​TestStand​で​提供​さ​れる​2​つ​の​異なる​スタイル​シート​を​使用​した​同じ​XML​レポート​の​サンプル​を​示し​てい​ます。

TestStand​に​は、​XML​および​ATML​レポート​データ​を​さまざま​な​方法​で​表示​する​ため​に​使用​できる​各種​の​スタイル​シート​が​用意​さ​れ​てい​ます。​これ​は、レポート​オプションダイアログ​で​指定​でき​ます。​TestStand​レポート​で​使用​する​カスタム​スタイル​シート​を​作成​する​こと​も​でき​ます。 スタイル​シート​の​カスタマイズ​の​詳細​と​例​について​は、「TestStand XML​および​ATML​レポート​の​形式​と​外観​の​カスタマイズ」​の​記事​を​参照​し​て​くだ​さい。


​水平​スタイル​シート​を​使用​した​ATML​レポート​セクション
 

レポート​スタイル​シート​を​使用​した​ATML​レポート​セクション


​結果​を​フィルタ​処理​する

レポート​オプションダイアログ​内​で、​次​の​よう​な​特定​の​タイプ​の​ステップ​結果​情報​を​フィルタ​処理​する​よう​に​選択​でき​ます。

  • テスト​制限値
  • テスト​計測値
  • コード​モジュール​の​実行​時間

さらに、​結果​の​フィルタ​処理​式​を​使用​し​て、​カスタム​フィルタ​を​作成​でき​ます。​TestStand​は、​ステップ​の​結果​ごと​に​この​式​を​評価​し、​式​が​True​と​評価​さ​れ​た​場合​に​その​ステップ​を​レポート​に​含​め​ます。​結果​フィルタ​処理​の​リング​制御​器​を​使用​し​て、​フロー​制御​ステップ​の​除外​など、​一般​的​な​式​を​選択​でき​ます​(下図​を​参照)。

メモ: XML​形式​を​使用​し​て​いる​場合、​または​TestStand 2010 SP1​以前​で​ATML​形式​を​使用​し​て​いる​場合、​結果​の​フィルタ​処理​式​は​使用​でき​ま​せん。 その​よう​な​場合​は、​レポート​の​スタイル​シート​を​変更​する​こと​で​結果​を​フィルタ​処理​でき​ます。

 

レポート​の​外観​を​変更​する

レポート​オプション​ダイ​ア​ログ​に​は、​次​の​よう​な​レポート​の​外観​を​カスタマイズ​する​ため​の​設定​が​あり​ます。

  • レポート​の​色:さまざま​な​プロパティ​に​関連​付け​ら​れ​て​いる​色​を​変更​でき​ます​(ASCII​レポート​では​使用​でき​ま​せん)。
  • デフォルト​数値​形式:レポート​で​の​数値​データ​の​表記​方法​を​設定​し​ます。
  • 配列​データ​形式: レポート​に​配列​を​テーブル​として​含める​か、​グラフ​として​含める​か、​または​完全​に​省略​する​か​を​選択​し​ます。

メモ: TestStand​レポート​では、​ActiveX​コントロール​を​使用​し​て、​配列​データ​から​グラフ​を​生成​し​ます。 レポート​を​表示​する​とき​に​この​コントロール​を​使用​でき​ない​場合、​データ​は​テーブル​として​表示​でき​ます。


​レポート​ファイル​の​パス​名​を​設定​する

レポート​オプションダイ​ア​ログ​ボックスのレポート​ファイル​の​パス名タブ​で、​レポート​ファイル​の​名前​と​その​ファイル​を​保存​する​パス​を​設定​でき​ます。 ファイル/​ディレクトリ​オプションで​レポート​の​保存​場所​を​選択​した​後、UUT​レポートフィールド​を​使用​し​て、​選択​した​オプション​に​基​づ​き​レポート​ファイル​名​を​プレビュー​し​ます。


ファイル/​ディレクトリ​オプションコントロールの式​による​レポート​ファイル​パス​の​指定オプション​を​選択​すると、​レポート​ファイル​の​名前​と​パス​を​さらに​細か​く​制御​でき​ます。 この​設定​を​使用​し​て​式​を​作成​すると、​TestStand​は​この​式​の​評価​結果​に​基​づ​い​て​レポート​の​保存​場所​を​決定​し​ます。​この​式​に​は、レポート​ファイル​パスの​メニュー​から​アクセス​できる​定義​済み​マクロ​を​含める​こと​が​でき​ます。

メモ: レポート​式​を​設定​する​とき​は、評価​さ​れ​た​レポート​ファイル​パスフィールド​と​プレビュー​画像​を​使用​し​て、​現在​の​式​の​動作​を​確認​し​ます。

 

UUT​の​結果​に​基​づ​い​て​レポート​ファイル​を​並​べ​替える

レポート​ファイル​パス​式でUUTStatusマクロ​を​使用​すると、​合格​した​レポート​用​と​不合格​の​レポート​用​に​ファイル​の​場所​を​個別に​作成​でき​ます。 たとえば、​ファイル​パス​で​この​マクロ​を​使用​し​て、​合格​した​レポート​と​不合格​の​レポート​を​異なる​場所​に​保存​でき​ます。​この​マクロ​が​存在​する​場合、​この​時点​まで​UUT​ステータス​は​不明​で​ある​ため、​TestStand​は​テスト​実行​の​完了​後に​レポート​ファイル​パス​式​を​再​評価​し​ます。

UUT​の​結果​に​基​づ​い​て​異なる​レポート​ファイル​パス​名​を​設定​する

バッチ​プロセス​モデル​を​使用​する​テスト​では、​バッチ​および​バッチ​内​の​個々​の​UUT​に対して、​レポート​ファイル​パス​の​処理​を​さらに​細か​く​設定​でき​ます。 これらの​設定​に​アクセス​する​に​は、モデル​の​タイプフィールド​で​バッチ​を​選択​し​ます。 たとえば、​各​バッチ​設定で新規​UUT​レポートを​使用​すると、​バッチ​ごと​に​個別​の​レポート​ファイル​を​作成​でき​ます。 使用​可能​な​すべて​の​設定​の​詳細​について​は、「レポート​オプション​ダイ​ア​ログ​ボックス」​ヘルプ​トピック​を​参照​し​て​くだ​さい。

レポート​に​カスタム​データ​を​追加​する​機能

多く​の​場合、​テスト​アプリケーション​では、​TestStand​が​デフォルト​で​記録​する​結果​以外​に、​追加​の​データ​を​レポート​に​記録​する​必要​が​あり​ます。​この​ニーズ​に​対応​する​ため​に、​TestStand​に​は、​レポート​に​カスタム​データ​を​簡単​に​記録​する​ため​の​いくつか​の​標準​機能​が​用意​さ​れ​てい​ます。

  • パラメータ​ロギング
  • 追加​の​結果
  • ReportText​プロパティ
  • カスタム​ステップ​タイプ​の​レポート​データ​の​設定

これらの​機能​の​詳細​について、​以降​の​セクション​で​説明​し​ます。


​パラメータ​ロギング

以下​に​示す​よう​に、​コード​モジュール​パラメータ​を​設定​する​ときにモジュールタブ​内の記録ボックス​を​オン​に​する​こと​で、​テスト​ステップ​の​パラメータ​データ​を​簡単​に​記録​でき​ます。​この​チェック​ボックス​を​オン​に​すると、​追加​の​設定​なし​で、​選択​した​パラメータ​が​レポート​または​データベース​ログ​に​自動的​に​表示​さ​れ​ます。


​コード​モジュール - 記録チェック​ボックス​を​オン​に​する


​追加​の​結果


​以下​に​示す​よう​に、ステップ​設定ペ​ーンのプロパティタブ​に​ある追加​の​結果パネル​を​使用​し​て、​ステップ​結果​の​追加​の​カスタム​データ​を​含める​こと​が​でき​ます。

追加​の​結果​を​設定​する


​TestStand​では、​ステップ​の​コメント​や​要件​情報​など、​一般​的​な​プロパティ​を​記録​する​ため​に、​いくつか​の​追加​の​結果​が​事前​に​設定​さ​れ​てい​ます。 これらの​結果​に​アクセス​する​に​は、次​から​結果​を​追加リスト​ボタン​を​選択​し、​リスト​から​項目​を​選択​し​ます。​追加​の​結果​エントリ​ごと​に​条件​式​を​指定​する​こと​も​でき​ます。 結果​が​記録​さ​れる​の​は、​式​が​True​と​評価​さ​れ​た​場合​のみ​です。


​追加​の​結果​設定​の​詳細​について​は、​TestStand​ヘルプ​の「追加​の​結果​の​編集​タブ」​トピック​を​参照​し​て​くだ​さい。


​Result.ReportText​を​使用​する

Result.ReportTextは、​ステップ​の​カスタム​情報​を​格納​する​ため​の​Result​コンテナ​内​の​追加​の​文字​列​要素​です。​文字​列​が​空​で​ない​場合、​レポート​ジ​ェ​ネ​レ​ータ​は​ReportText​文字​列​を​レポート​内​の​フィールド​として​含​め​ます。​ReportText​フィールド​は、​ASCII​を​除く​すべて​の​レポート​形式​の​HTML​タグ​を​サポート​し​て​いる​ため、​この​フィールド​を​使用​し​て、​関連​画像​や​ハイ​パー​リンク​など​の​リッチ​テキスト​要素​を​含める​こと​が​でき​ます。

レポート​に​画像​を​挿入​する​方法​の​詳細​について​は、「Inserting Images into a TestStand Report」​を​参照​し​て​くだ​さい。

以下​の​画像​は、​ReportText​プロパティ​で​HTML​を​使用​し​て、​ステップ​の​結果​に​画像​を​埋め込む​例​を​示し​てい​ます。

Result.ReportText​に​画像​を​表示​する​レポート


​レポート​に​カスタム​ステップ​タイプ​プロ​パテ​ィ​を​追加​する

TestStand​では、​特定​の​機能​を​実装​する​ため​の​独自​の​カスタム​ステップ​タイプ​を​作成​でき​ます。​多く​の​場合​に​は、​その​よう​な​カスタム​ステップ​タイプ​の​データ​を​レポート​に​記録​する​必要​が​あり​ます。

メモ: TestStand​の​カスタム​ステップ​タイプ​に​慣​れ​てい​ない​場合​は、​この​セクション​を​読む​前​に、「カスタム​ステップ​タイプ​開発​の​最善策」​の​記事​で​詳細​を​参照​し​て​くだ​さい。

レポート​に​表示​さ​れる​カスタム​ステップ​プロ​パテ​ィ​を​作成​する​に​は、​次​の​手順​に従います。

  1. タイプペ​ーン​で、​ステップ​の​結果​コンテナ​に​カスタム​プロ​パテ​ィ​を​追加​し​ます。 これ​により、​結果​収集​プロセス​で​プロパティ​が​ResultList​に​追加​さ​れる​よう​に​なり​ます。
  2. プロパティのIncludeInReportフラグ​を​有効​にし​て、​レポート​ジ​ェ​ネ​レ​ータ​が​レポート​に​データ​を​追加​する​よう​にし​ます。
  • プロパティ​を​右​クリック​し、プロパティを​選択​し​ます。
  • 上級ボタン​を​クリック​し、フラグを​選択​し​ます。
  • IncludeInReportオプション​を​オン​にし、​両方​の​ダイアログでOKを​クリック​し​ます


レポート​コール​バック​を​オーバー​ライ​ド​する

プロセス​モデル​に​は​多く​の​コール​バック​が​含​まれ、​これら​を​オーバー​ライ​ド​する​こと​で、​特定​の​ク​ライアン​ト​シーケンス​ファイル​用​に​モデル​の​機能​を​変更​する​こと​が​でき​ます。 この​メカニズム​は、​レポート​ジ​ェ​ネ​レ​ータ​の​カスタマイズ​に​も​役​立ち​ます。 この​セクション​では、​次​の​一般​的​な​カスタマイズ​方法​について​説明​し​ます。

  • レポート​オプション​を​プログラム​で​設定​する
  • 追加​の​UUT​および​ステーション​データ​を​レポート​に​追加​する
  • レポート​ジ​ェ​ネ​レ​ータ​を​直接​カスタマイズ​する

メモ: プロセス​モデル​の​コール​バック​に​慣​れ​てい​ない​場合​は、​先に​進む​前​に、「コール​バック​シーケンス​を​使用​した​プロセス​モデル​の​変更」ヘルプ​トピック​を​参照​し​て​くだ​さい。

レポート​オプション​を​プログラム​で​設定​する

レポート​オプションダイアログ​を​使用​する​以外​に、​テスト​シーケンスでReportOptionsコール​バック​を​オーバー​ライ​ド​する​こと​により、​プログラム​で​レポート​オプション​を​設定​する​こと​も​でき​ます。 シーケンス​ファイル​の​コール​バック​を​オーバー​ライ​ド​する​に​は、​次​の​手順​に従います。

  1. シーケンス​ペ​ーン​で​右​クリック​し、シーケンス​ファイル​の​コール​バックを​選択​し​ます。
  2. ReportOptions​コール​バック​を​選択​し、追加を​クリック​し​ます。
  3. OKを​クリック​し​て​ダイアログ​を​閉​じ​ます。 以下​に​示す​よう​に、​新しい​ReportOptions​シーケンス​が​作成​さ​れ​ます。



​シーケンス​を​実行​すると、​プロセス​モデル​は、​レポート​オプション​ダイ​ア​ログ​で​設定​さ​れ​た​現在​の​レポート​オプション​を​ロード​した​直後​に、​この​コール​バック​シーケンス​を​呼び出し​ます。 現在​の​レポート​オプション​は、Parameters.ReportOptions変数​に​含​まれ​てい​ます。 これらの​プロパティ​の​値​を​変更​し​て、​現在​の​実行​の​レポート​オプション​を​変更​でき​ます。 これらの​オプション​は、レポート​オプションダイアログ​の​設定​や​その他​の​実行​の​設定​に​は​影響​しま​せん。​たとえば、​シーケンス​ファイル​の​オンザフライ​レポート​を​有効​に​する​に​は、​次​の​式​を​使用​し​て​ステートメント​ステップ​を​作成​でき​ます。

Parameters.ReportOptions.UseOnTheFlyReporting =True


​追加​の​UUT​および​ステーション​データ​を​レポート​ヘッダ​に​記録​する​(TestStand 2013​以降)

テスト​アプリケーション​では、​製造元​の​場所​など、​UUT​に関する​追加​の​識別​情報​を​含める​こと​が​必要​に​なる​場合​が​あり​ます。 UUT​および​ステーション​に関する​データ​は、​プロセス​モデル​によって​Parameters.UUT​および​Parameters.ModelData.StationInfo​変数​に​格納​さ​れ​ます。 作成​する​ほとんど​の​モデル​コール​バック​に​は、​これらの​プロパティ​が​パラメータ​として​含​まれ​て​いる​ため、​コール​バック​で​この​データ​に​アクセス​でき​ます。​TestStand 2013​以降​では、​UUT​プロパティ​と​StationInfo​プロパティ​に、​構造​化​さ​れ​てい​ない​コンテナ​で​ある​AdditionalData​サブプロパティ​が​含​まれ​てい​ます。 UUT​および​StationInfo​データタイプを変更せずに、​実行​時に​この​プロパティ​に​データ​を​追加​でき​ます。

AdditionalDataコンテナ​を​使用​し​て​プログラム​で​ヘッダ​に​カスタム​UUT​データ​を​追加​する​に​は、​次​の​手順​に従います。

  1. ク​ライアン​ト​シーケンス​ファイルのPreUUT​コール​バックを​オーバー​ライ​ド​し​ます。 新しい​コール​バック​シーケンス​に​は、Parameters.UUTプロパティ​が​含​まれ​てい​ます。
  2. ステートメント​ステップ​を​追加​し​て、Parameters.UUT.AdditionalDataコンテナ​に​プロパティ​を​動的​に​追加​し​ます。​たとえば、​次​の​式​は​2​つ​の​文字​列​データ​サブ​プロ​パテ​ィ​を​作成​し​ます。

Parameters.UUT.AdditionalData.SetValString("Manufacturer.Name",​1,"National Instruments"),
Parameters.UUT.AdditionalData.SetValString("Manufacturer.Location",​1,"Debrecen, Hungary"),

メモ: プロパティ​が​存在​しない​場合、​PropertyOption​に​1​を​指定​し​て​SetValString​メソッド​を​使用​すると、​プロパティ​が​作成​さ​れ​ます。

  1. ステートメント​ステップ​を​追加​し​て、​レポート​に​すべて​の​サブプロパティ​を​含める​よう​に​AdditionalData​プロパティ​の​IncludeInReport​フラグ​を​設定​し​ます。

Parameters.UUT.AdditionalData.SetFlags("",​0,PropFlags_IncludeInReport)


​以下​の​レポート​に​は、AdditionalDataコンテナ​内​の​カスタム​データ​が​含​まれ​てい​ます。 カスタム​ステーション​データ​を​追加​する​プロセス​も​同様​ですが、Parameters.UUTの​代わりにParameters.ModelData.StationInfoプロパティ​を​使用​し​ます。


​UUT.AdditionalData​コンテナ​を​使用​し​て​レポート​ヘッダ​に​製造元​情報​を​追加​する


メモ: または、​編集​時に​プロセス​モデル​の​エントリ​ポイントのLocals.UUTまたはLocals.ModelData.StationInfoコンテナ​に​手動​で​データ​を​追加​してIncludeInReportフラグ​を​有効​に​する​こと​で、​すべて​の​ク​ライアン​ト​シーケンス​ファイル​の​UUT​または​ステーション​データ​を​追加​でき​ます。


​レポート​ジ​ェ​ネ​レ​ータ​の​機能​を​直接​カスタマイズ​する​(HTML​および​ASCII​形式)

レポート​ジ​ェ​ネ​レ​ータ​は、​ク​ライアン​ト​シーケンス​ファイル​で​オーバー​ライ​ド​できる​多く​の​コール​バック​を​定義​し​てい​ます。​これらの​各​コール​バック​は、​対応するレポートテキストが生成された後に実行され、​レポート​ジ​ェ​ネ​レ​ータ​の​デフォルト​の​出力​を​変更​でき​ます。 これらの​コール​バック​を​使用​し​て​カスタム​データ​を​追加​する​の​は、​前述​の​方法​が​いずれ​も​使用​でき​ない​場合​のみ​にし​て​くだ​さい。

これらの​コール​バック​は、レポート​オプションダイ​ア​ログ​ボックスのコンテンツタブ​で、レポート​本文​を​生成​する​ため​の​レポート​ジ​ェ​ネ​レ​ータ​の​選択オプションのシーケンスオプション​を​有効​に​した​場合​のみ​実行​さ​れ​ます。 この​オプション​は、​HTML​および​ASCII​レポート​で​使用​でき​ます。  

  • ModifyReportHeader:  レポート​ジ​ェ​ネ​レ​ータ​の​結果​処理​コンポーネント​は、​Post​シーケンス​から​この​コール​バック​を​呼び出し​ます。​これ​を​オーバー​ライ​ド​し​て、​レポート​ヘッダ​を​変更​し​ます。 Parameters.ReportHeader​プロパティ​に​は、​デフォルト​の​レポート​ヘッダ​が​含​まれ​てい​ます。
  • ModifyReportEntry:  レポート​ジ​ェ​ネ​レ​ータ​の​結果​処理​コンポーネント​は、​ResultList​の​各​結果​に対して​Post​シーケンス​から​この​コール​バック​を​呼び出し​ます。​これ​を​オーバー​ライ​ド​し​て、​各​結果​に対して​生成​さ​れ​た​レポート​セクション​を​変更​し​ます。​Parameters.ReportEntry​プロパティ​に​は、​現在​の​ResultList​エントリ​に対して​生成​さ​れ​た​レポート​データ​が​含​まれ​てい​ます。
  • ModifyReportFooter: レポート​ジ​ェ​ネ​レ​ータ​の​結果​処理​コンポーネント​は、​Post​シーケンス​から​この​コール​バック​を​呼び出し​ます。​これ​を​オーバー​ライ​ド​し​て、​レポート​フッタ​を​変更​し​ます。​Parameters.ReportFooter​プロパティ​に​は、​デフォルト​の​レポート​フッタ​が​含​まれ​てい​ます。


​レポート​の​外観​を​カスタマイズ​する

レポート​の​外観​を​カスタマイズ​する​方法​は、​レポート​形式​によって​大​きく​異​なり​ます。 ASCII​レポート​と​HTML​レポート​の​場合、​外観​情報​と​レポート​データ​は​密接​に​関連​し​てい​ます。 結果​として、​レポート​の​外観​を​変更​する​に​は、​レポート​ジ​ェ​ネ​レ​ータ​の​コード​を​直接​変更​する​必要​が​あり​ます。​これ​に​は、​レポート​ジ​ェ​ネ​レ​ータ​に関する​詳細​レベル​の​理解​が​必要​で​あり、​この​ドキュメント​の​範囲​を​超​え​てい​ます。 レポート​ジ​ェ​ネ​レ​ータ​の​実装​の​詳細​について​は、「レポート​生成​の​説明」​の​記事​を​参照​し​て​くだ​さい。

この​ドキュメント​の​「レポート​オプション」​セクション​で​説明​さ​れ​て​いる​よう​に、​XML​および​ATML​レポート​は、​スタイル​シート​を​使用​し​て、​未処理​の​レポート​データ​から​読み取り​可能​な​レポート​を​生成​し​ます。 これらの​レポート​の​外観​は、​レポート​ジ​ェ​ネ​レ​ータ​自体​を​変更​する​必要​なし​に、​スタイル​シート​を​編集​する​こと​で​カスタマイズ​でき​ます。 スタイル​シート​の​カスタマイズ​の​詳細​と​例​について​は、「TestStand XML​および​ATML​レポート​の​形式​と​外観​の​カスタマイズ」​の​記事​を​参照​し​て​くだ​さい。

まとめ

TestStand​で​の​レポート​の​カスタマイズ​は​一般​的​な​タスク​で​あり、​TestStand​は​レポート​の​コンテンツ、​機能、​および​スタイル​を​カスタマイズ​する​ため​の​多く​の​機能​を​備え​てい​ます。​以下​の​フローチャート​を​参照​し​て、​カスタム​レポート​の​実装​方法​を​決定​し​て​くだ​さい。

 

レポート​を​カスタマイズ​する​ため​の​正しい​手法​を​選択​する​フローチャート レポート​を​カスタマイズ​する​ため​の​正しい​手法​を​選択​する​フローチャート