Purpose

This example demonstrates how to include hyperlinks in reports that TestStand generates. You can use the Path type, with the attribute TestStand.Hyperlink set to True, to convert any path displayed in the report to a hyperlink.

Example File Location

<TestStand Public>\Examples\Customizing Result Processing\Including Hyperlinks in a Report\Including Hyperlinks in a Report.seq

Highlighted Features

Path data type

Major API

None

Prerequisites

None

How to Use This Example

Complete the following steps to run the example.

  1. To link to an image, select the Create a link to an image on disk step. This step stores an image path in a local variable and adds this variable to the report as an additional result. This data must be stored in a TestStand property before logging so that the hyperlink attribute can be set to True for the property. Click Edit Attributes next to the local variables to view this attribute.
  2. To link to a web page, select the Create a link to a webpage step. This step stores a URL in a local variable and adds this variable to the report as an additional result.
  3. Select the CPU Test step. If this step fails, an additional result is logged to link to an HTML file that contains troubleshooting instructions for the operator.
  4. Select Execute»Single Pass.
  5. When the execution completes, review the report, which contains links to the image, web page, and local HTML file.
  6. Click the links to open the corresponding locations.