Model Plug-in - Basic Step Time Report

Purpose

This example demonstrates how to a basic step time report for each UUT so you can benchmark and analyze the performance of a sequence file. The example generates a summary report, a file of unprocessed data, and a report in format that includes processed time data. You can also run a stand-alone executable to a basic step time report in .csv format to Excel format. You can basic step time reports in Excel format for multiple UUTs.

Example File Location

Highlighted Features

Process model plug-in architecture

Major API

None

Prerequisites

You must have Microsoft Office Excel 2007 SP2 or later installed on the computer to a basic step time report in Excel format and to run the executable to a .csv file to Excel format. If Excel is not installed on the computer, this custom reporting plug-in generates only a .csv file.

How to Use This Example

You can use this example to a basic step time report. The example generates a summary report, a file of unprocessed data, and a report in format that includes processed time data. You can also run a stand-alone executable to a basic step time report in .csv format to Excel format. You can basic step time reports in Excel format for multiple UUTs.

Generating a Basic Step Time Report

Complete the following steps to use this example to generate a basic step time report.

1. Open <TestStand Public>\Examples\Customizing Result Processing\ModelPlugin Basic Step Time Report\SetupBasicStepTimeReportGenerator.seq, click OK in the About This Example dialog box to copy the example and support files to the <TestStand Public>\Components\Models\ModelPlugins directory, and click Yes in the Setup Simple Text Report Example Files dialog box.
2. Open a sequence file for which you want to generate a basic step time report.
3. Select Configure»Result Processing to launch the Result Processing dialog box.
4. Select Basic Step Time Report from the context menu to add the Basic Step Time Report plug-in to the active configuration.
5. Enable the checkbox in the Display column of the Basic Step Time Report plug-in to display the HTML summary report in the Report pane.
6. Click the icon in the Options column of the Basic Step Time Report plug-in to launch the Basic Step Time Report Configuration dialog box, in which you specify the directory in which to store the report and specify whether to launch the report in Excel.
7. Click OK in the Basic Step Time Report Configuration dialog box and in the Result Processing dialog box to return to the Sequence File window.
8. Execute the sequence file and view the reports.

Convert a .csv File to Excel Format

Complete the following steps to use a stand-alone application to convert a .csv file to Excel format.

1. Launch <TestStand Public>\Examples\Customizing Result Processing\ModelPlugin Basic Step Time Report\CsvToBasicStepTimeReportGenerator.exe.
2. Specify the path to the .csv file you want to convert in the Path of CSV Report control and specify the path to the Excel file you want to create in the Path of Basic Step Time Report control.
3. Enable the Launch Basic Step Time Report to open the report in Excel option and click OK.
4. View the report in Excel.

You can also use command-line arguments to launch the stand-alone application, specify the path to the .csv file, specify the path of the Excel file you want to create, and optionally display the file in Excel as follows:

CsvToBasicStepTimeReportGenerator.exe <Path of CSV Report> <Path of Excel File to Create> [/display]

Aggregating Basic Step Time Reports in Excel Format for Multiple UUTs

Complete the following steps to aggregate basic step time reports in Excel for multiple UUTs. The value in the ID column of the Raw Data worksheet must be unique across all the reports you want to aggregate.

1. Open the reports you want to combine in Excel.
2. In the main report file into which you want to aggregate all the data, unprotect the Raw Data worksheet.
3. Complete the following steps for each report file you want to aggregate into the main report file.
   1. From the Raw Data worksheet, copy the rows that correspond to the steps you want to include in the main report file.
   2. Paste the data you copied into the Steps section of the Raw Data worksheet of the main report file.
4. In the Raw Data worksheet of the main report file, click the Regenerate Processed Data and Graphs button update and overwrite the existing data and graphs in the Step, Sequence, and Sequence File worksheets.

Reports the Basic Step Time Report Generator Plug-In Creates

The Basic Step Time Report Generator plug-in generates a single report file for each UUT in , , and formats using the following filename format:

[Station ID][Sequence File Name][Test Socket Index][Batch Serial Number][UUT Serial Number][Time][Date].[html|csv|xls]

Microsoft Windows and Excel limit the number of characters in a file path. If the length of the file path for generated reports is less than 218 characters, the Basic Step Time Report Generator plug-in generates reports in HTML, .csv, and Excel format. If the length of the file path for generated reports is between 218 and 260 characters, the Basic Step Time Report Generator plug-in generates reports only in HTML and .csv formats. If the length of the file path for generated reports exceeds 260 characters, the Basic Step Time Report Generator plug-in does not generate any report and returns an error before executing the sequence file.

The Basic Step Time Report plug-in uses an underscore (_) in the place of the # character and invalid filename characters in a UUT or batch serial number.

HTML

TestStand displays the HTML report in the Report pane, and the HTML report links to the .csv and Excel reports.

The HTML report includes the following information for each UUT in the report header:

• Station ID
• Operator
• UUT Part Number (if non-empty)
• UUT Serial Number
• Batch Serial Number (if using the Batch model)
• TestSocket Index (if using the Batch or Parallel model)
• Date
• Time
• Execution Time
• UUT Result
• TSR Filename (if using the TestStand Offline Results Processing Utility)
• TSR ID (if using the TestStand Offline Results Processing Utility)
• TSR File Closed (if using the TestStand Offline Results Processing Utility)

.csv

The .csv report includes the following information for each UUT in the report header:

• Station ID
• Operator
• UUT Part Number (if non-empty)
• UUT Serial Number
• Batch Serial Number (if using the Batch model)
• TestSocket Index (if using the Batch or Parallel model)
• Date
• Time
• Execution Time
• UUT Result
• CSV File Format Version
• TSR Filename (if using the TestStand Offline Results Processing Utility)
• TSR ID (if using the TestStand Offline Results Processing Utility)
• TSR File Closed (if using the TestStand Offline Results Processing Utility)

For each step, the report includes the following information:

• Sequence Filename—Name of the sequence file that contains the step
• Sequence Name—Name of the sequence that contains the step
• Step Group—Name of the step group that contains the step
• Step ID—Unique ID of the step
• Step Name—Name of the step
• Parent ID—ID of the parent sequence call step
• Step Type—Type of the step
• ID—Unique execution ID of the step
• Status—Execution status of the step
• Start Time—Execution start time of the step
• Total Time—Total time the step takes to complete execution
• Module Time—Time the code module of the step takes or empty if the step uses the None adapter
• Sequence Call Sequence Filename—Path of the sequence file a non-asynchronous Sequence Call step calls
• Sequence Call Sequence Name—Name of the sequence a non-asynchronous Sequence Call step calls
• Number of Loops—Number of loops the step executes or empty if the step does not use looping
• Ending Loop Index—Index of the last iteration of the loop for the step or empty if the step does not use looping
• Loop Index—Index of the current iteration of the loop for the step or empty if the step does not use looping
• UUT Serial Number—Serial number of the UUT
• Batch Serial Number—Serial number of the batch that contains the UUT
• TestSocket Index—Index of the test socket the UUT uses

Excel

The Excel report includes the following information for each UUT in an Excel workbook with the following worksheets:

• Step—Contains the following processed data for the steps used to test the UUT and graphs to show the average total time of the steps and the cumulative total time of the steps. You can modify the data and graphs in this worksheet.
  • Step Name
  • Step ID
  • Cumulative Total Time (of the step)
  • Cumulative Module Time (of the step)
  • Number of Execution
  • Average Total Time
  • Average Module Time
  • Max Total Time
  • Max Module Time
  • Min Total Time
  • Min Module Time
  Note This worksheet does not contain information for the MainSequence Callback step from process model files.
• Sequence—Contains the following processed data for the sequences used to test the UUT and graphs to show the average total time of the sequences and the percentage of the cumulative total time of the sequences. You can modify the data and graphs in this worksheet.
  • Sequence File Name
  • Sequence Name
  • Cumulative Total Time (of each Sequence Call step that calls the sequence, including subsequence time)
  • Cumulative Total Time (of each Sequence Call step that calls the sequence, excluding subsequence time)
  • Number of Times Sequence Call Steps Call into the Sequence
  • Average Total Time (excluding subsequence time)
  • Max Total Time (excluding subsequence time)
  • Min Total Time (excluding subsequence time)
  Note This worksheet contains information only for non-asynchronous Sequence Call steps. You can modify the source code to insert data for Post Action Sequence Call, callback sequence, and asynchronous Sequence Call steps.
• Sequence File—Contains the following processed data for the sequence files used to test the UUT and graphs to show the cumulative total time of the sequence files and the percentage of total time for the sequence files. You can modify the data and graphs in this worksheet.
  • Sequence Filename
  • Cumulative Total Time (of Sequence Call steps calling any sequence in the sequence file)
• Raw Data—Contains all the data from the .csv file in protected mode. Click the Regenerate Processed Data and Graphs button to update and overwrite the existing data and graphs in the Step, Sequence, and Sequence File worksheets.