Report Options Dialog Box

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

Contents Tab

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.

The Contents tab contains the following options:

  • Report Format—The output format of the report file. Use this ring control to specify an HTML document (.html), an ASCII-text file (.txt), an XML document (.xml), or an Automatic Test Markup Language (ATML) report document (.xml). ATML reports validate against the approved version 6.01, non-finalized version 5.0, or approved version 2.02 of the Test Results and Session Information schema the ATML standard defines.
    Note Note  No plans exist to approve version 5.0 of the ATML Test Results and Session Information schema.
  • Style Sheet—The path to an XML or ATML style sheet file TestStand stores in the processing instruction of an XML or ATML report. You can specify an absolute or relative pathname for the file. Report generation determines the absolute path to a style sheet file using the TestStand search directory paths. This option is available for the XML and ATML report document formats.
  • Store Absolute Path—When enabled, instructs TestStand to use the absolute path for the style sheet file when storing the path in the processing instructions of an XML or ATML report. The style sheet file path is determined using the FindFile method in the TestStand API. Style sheet paths are relative with respect to the file path of the XML or ATML report.

    When you disable this option, the path specified in the Style Sheet option is stored in the processing instructions of the XML or ATML report.
  • Default Numeric Format—Determines how the report formats numeric values for which you did not specify a numeric format. Click Edit Format to launch the Numeric Format dialog box.
  • Report Colors—The colors of the report. This option is available only for the HTML or XML Document formats.
  • Include Step Results—Displays the results of each step. Disable this option when you want to only include a header for each UUT. The header indicates the UUT status.
    Note Note  TestStand does not generate a report when you disable the Include Step Results option and you specify the report format as ATML in the Report Format ring control.
    • Result Filtering Expression—Applies a filtering expression the report generator evaluates for each step result to determine which steps appear in the report. The report generator includes the step in the report when the expression evaluates to True. Use the ring control to select predefined expressions for including all steps, failing steps only, or passing steps only.

      Alternatively, you can create a custom expression for this field or modify one of the predefined expressions. You can use any subproperty within the Step.Result container in the Result Filtering Expression, but you must use Result in place of Step.Result. For example, if you want to include only failing steps in the report, set the expression to Result.Status == "Failed".

      Note Note  This option is not available for XML reports. You can filter XML results by modifying the XML style sheets.
    • Include Test Limits—Adds to the report all result properties that indicate that they contain test limits.
    • Include Attributes—Adds to the report all attributes associated with result properties. This option is disabled by default.
    • Include TestStand Extension Elements—Adds to the report TestStand extension elements. This option is disabled for XML reports because XML reports use style sheets to filter TestStand extension elements.
    • Include Measurements—Adds to the report all result properties that indicate that they contain measurements.
    • Use the following options to configure how the report displays arrays:
      • Include Arrays—Options for including or excluding arrays in reports. The following options are available in the ring control:
        • Do Not Include Arrays—Array values do not appear in the report.
          Note Note  This option instructs the report generation to not include array data in HTML and TXT report files. Report generation always includes array data in ATML 6.01, ATML 5.0, and XML report files, and this option instructs the report stylesheets to not display array data.
        • Insert Table—Array values appear in tables.
        • Insert Graph—Numeric array values appear in graphs. This option is available only for ATML 6.01, ATML 5.0, XML, and HTML reports.
          Note Note  ATML 6.01, ATML 5.0, and XML reports might display a table of measurement data instead of a graph under certain conditions.
      • Filter—Options for limiting the amount of data the arrays add to the report. The following options are available in the ring control:
        • Include All—All array elements appear in the report.
        • Include Up To Max—The report truncates arrays to the maximum size in the Max Elements control.
        • Exclude If Larger Than Max—The report does not display arrays that contain more than the number of elements in the Max Elements control.
        • Decimate If Larger Than Max—The report samples and displays the specified maximum number of elements from arrays that contain more than the number of elements in the Max Elements control.
      • Max Elements—The maximum array size that applies to options you select in the Filter control.
  • Include Execution Times—Adds to the report the time each step module takes to execute. This information includes the time the subsequence, LabVIEW VI, or C function requires to execute. It does not include the time the TestStand Engine requires to evaluate preconditions, load the step module, and so on.
  • Append if File Already Exists—Appends the report to the target file, if the target file already exists. When you disable this option, the report overwrites the target file.
    Note  If you create a separate report for each UUT and disable this option, the report for each UUT overwrites any existing target file.
  • On-The-Fly Reporting—Specifies whether TestStand generates reports after testing a UUT or generates reports concurrently with execution. When you enable this option, the process model uses Post Result callback sequences to append new formatted results to the report. When you disable this option, the process model creates the report after testing each UUT.
  • Only Display Latest Results—When you enable this option, the report generator periodically purges results maintained in memory while generating on-the-fly reports. When you enable this option, the displayed report only contains results that have not been previously purged. The purged results are appended to the report file saved to disk. Typically, you use this option when executions run for a long period and you want to limit the size of the report in memory.
    Note Note  Enable the Discard Results or Disable Results when not Required by Model option in the Model Options dialog box to further reduce the amount of memory used during TestStand executions.
  • Select a Report Generator for Producing the Report Body—Contains options that direct TestStand to use a sequence or DLL to produce the body of the report. The report body is the section of the report between the header and footer that contains individual results for each sequence and step TestStand called. In the default process model, the TestReport callback determines whether TestStand builds the report body with a sequence call or with a DLL call.

    If you select the Sequence option to generate the report, the TestReport callback calls the AddReportBody sequence in either ReportGen_txt.seq or ReportGen_html.seq to build the report body. The sequence report generator uses a series of sequences with steps that recursively process the result list for the execution.

    If you select the DLL option to generate the report, the TestReport callback calls a function in a DLL to build the report body. The DLL report generator is a single call into a C-language DLL that processes the entire result list for the execution before returning. You can access the project and source code for the LabWindows/CVI-built DLL. When you select the DLL option, TestStand generates reports faster but does not call ModifyReportEntry callbacks.
    Note Note  The DLL option is not available for XML or ATML reports.

See Also

Comparing Report Format Features

Displaying Measurement Data as Graphs

Model Options dialog box

Numeric Format dialog box

WAS THIS ARTICLE HELPFUL?

Not Helpful