Generating a Test Report

TestStand 2017 Help

Edition Date: November 2017

Part Number: 370052W-01

»View Product Info

Download Help (Windows Only)
NI TestStand 2014 Help
NI TestStand 2014 SP1 Help
TestStand 2016 Help
TestStand 2016 SP1 Help
TestStand 2017 Help

You can generate a report to process collected test results. Most of the report generation capabilities are not native to the TestStand Engine or to the TestStand Sequence Editor. The default process model, which calls the Main sequence in the client sequence file to test a UUT, relies on the automatic result collection capabilities of the TestStand Engine to accumulate the raw data for each report. The engine automatically compiles the result of each step into a result list for an entire sequence, which contains the result of each step and the result list of each subsequence call made.

When you run a sequence using the Test UUTs or Single Pass Execution entry point, the default report generation process model plug-in, NI_ReportGenerator.seq, located in the <TestStand>\Components\Models\ModelPlugins directory, generates the report by traversing the results for the Main sequence in the client sequence file and all the subsequences called.

Configuring Report Options

Select Configure»Result Processing to launch the Result Processing dialog box. Place a checkmark in the Enabled column of the Report row to enable the default report generation process model plug-in. You can customize or replace any portion of the report generator process model plug-in.

Click the Options icon in the Options column for the reporting model plug-in to launch the Report Options dialog box, in which you can specify options that determine the content and format of the report and the names and locations of report files.

Viewing and Using Reports

You can use reports in the following ways in TestStand:

  • The Report pane of the Execution window displays the report for the current execution. Usually, the Report pane is empty until execution completes.

    Alternatively, you can use an external application to view reports. Select Configure»External Viewers to launch the Configure External Viewers dialog box, in which you can specify the external application TestStand launches to display a particular report format. In the Execution window, click the Viewer button on the Report pane to view the report in the external viewer you specified.
    Note Note  You must have a minimum supported version of Microsoft Internet Explorer or later to view TestStand reports. Refer to the NI TestStand Release Notes for more information about supported versions of Internet Explorer.
  • You can generate reports on-the-fly to progressively log result data concurrently with the execution instead of waiting until UUT testing completes.
  • You can generate reports in different formats. The default process model generates reports in Automatic Test Markup Language (ATML), XML, HTML, or ASCII-text formats.
  • You can include hyperlinks in supported versions of ATML, XML, and HTML reports.
  • You can distribute these types of report files to view on a computer that does not have TestStand installed.
  • You can create a custom result processing model plug-in, and you can configure multiple instances of reporting model plug-ins in the Result Processing dialog box, in which case you can use the Active Report control on the Report pane toolbar to select which report to view.
Note Note  All TestStand report generators support generating reports that contain 64-bit integer data types. Signed 64-bit integers use the %d format string, and unsigned 64-bit integers use the %u format string.

See Also

Adding Custom Images to a Report (Example)

Including Hyperlinks in a Report - TDMS File (Example)

WAS THIS ARTICLE HELPFUL?

Not Helpful