April 2022
This file contains installation instructions and compatibility information for TestStand 2021 SP1.
You can find more release information on ni.com.
Migrating to the Current Version of TestStand
Product Security and Critical Updates
Automating the Installation of NI Products
Using NI Software with Microsoft Windows 10
Unsupported Windows Operating Systems
Additional TestStand Resources
NI recommends the system requirements described in the following table to run TestStand 2021 SP1.
| Requirement | Recommended | Minimum |
|---|---|---|
| Processor | Pentium G1 or equivalent | Pentium 4/M or equivalent |
| Memory | 2GB | 1 GB |
| Disk space for TestStand (32- or 64-bit) | 1 GB | — |
| Disk space for Microsoft .NET Framework version 4.6.2, if not already installed | 2.5 GB | — |
| Disk space for device drivers from the NI Device Drivers DVD | Amount of space required varies depending on the drivers you install. Install only the drivers necessary for the hardware you use. | — |
| Video adapter | 1366 x 768 or higher | 1024 x 768 resolution |
Refer to the LabVIEW Readme for additional system requirements and supported operating systems for LabVIEW 2021 SP1.
TestStand 2021 SP1 supports the following operating systems:
Note Refer to Unsupported Windows Operating Systems for more information about support for Microsoft Windows OSes.
Note TestStand no longer supports Windows Vista/XP/7/8.x, Windows Server 2003/2008/2012, or any 32-bit Windows operating system. You cannot deploy or distribute applications that use TestStand 2021 SP1 to an unsupported OS. Additionally, after installing TestStand 2021 SP1, you cannot use any installers built on this computer with any version of LabVIEW, LabWindows™/CVI™, NI TestStand™, or Measurement Studio on an unsupported OS.
For more information about the changes to our OS support, visit https://www.ni.com/r/win32bitsupport.
TestStand 2021 SP1 supports the following application software versions, including service packs. If you are not using NI application software, refer to Microsoft Visual Studio Support.
| Software | Versions Supported by TestStand 2021 SP1 | Allowed but not Supported | Comments |
|---|---|---|---|
| LabVIEW (32- and 64-bit) | 2021 SP1, 2021, 2020 SP1, 2019 SP1, 2018 SP1 | 2020, 2019, 2018, 2017 SP1 | LabVIEW examples and user interfaces use files created with LabVIEW 2018 SP1. TestStand API support files for LabVIEW use files saved with LabVIEW 2017 SP1. TestStand 32-bit supports calling 32-bit VIs using LabVIEW 32-bit RTE, and 32- and 64-bit VIs using the LabVIEW ADE. |
| LabWindows™/CVI™ | 2020, 2019, 2017, 2015 SP1 | Earlier versions of LabWindows™/CVI™ | LabWindows™/CVI™ examples, user interfaces, and API use files created with LabWindows™/CVI™ 2015 SP1. TestStand 32-bit supports calling only 32-bit code modules. |
| NI Switch Executive | 21.5, 2015, 3.6, 3.5 | — | — |
| Requirements Gateway | 2018, 2014, 2012 | — | — |
| SystemLink | 2021 R2, 2021 R1, 20.5 | — | — |
| Software | Versions Supported by TestStand 2021 SP1 | Allowed but not Supported | Comments |
|---|---|---|---|
| LabVIEW NXG | Not supported | — | This product no longer supports LabVIEW NXG. Refer to LabVIEW NXG on ni.com for more information about LabVIEW NXG Life-Cycle Dates and driver version support. |
| LabVIEW (32- and 64-bit) | 2021 SP1, 2021, 2020 SP1, 2019 SP1, 2018 SP1 | 2020, 2019, 2018, 2017 SP1 | LabVIEW examples and user interfaces use files created with LabVIEW 2018 SP1. TestStand API support files for LabVIEW use files saved with LabVIEW 2017 SP1. TestStand 64-bit supports calling 64-bit VIs using LabVIEW 64-bit RTE, and 32- and 64-bit VIs using the LabVIEW ADE. |
| LabWindows™/CVI™ | 2020, 2019, 2017, 2015 SP1 | Earlier versions of LabWindows™/CVI™ | LabWindows™/CVI™ examples, user interfaces, and API use files created with LabWindows™/CVI™ 2015 SP1. TestStand 64-bit supports calling only 64-bit code modules. |
| NI Measurement Studio - Visual Studio MFC Legacy Support | — | — | Measurement Studio classes cannot be used in 64-bit applications. |
| NI Switch Executive | 2020, 2018, 2015 | — | — |
| Requirements Gateway | 2018, 2014, 2012 | 1.1 | — |
| SystemLink | 2021 R2, 2021 R1, 20.5 | — | — |
TestStand can execute code modules developed with versions of ADEs other than the listed supported versions, but NI performs only limited testing with earlier versions of ADEs. TestStand might be able to execute code modules developed with versions of ADEs later than the listed supported versions, but NI cannot ensure support for versions released after TestStand 2021 SP1. Visit ni.com/info and enter the Info Code tslcp for more information about the TestStand life cycle policy.
TestStand 2021 and TestStand 2021 SP1 install NI Package Builder 20.6, which does not support building packages for TestStand 2021. NI recommends upgrading NI Package Builder when a new version is available that supports TestStand 2021.
TestStand 2021 SP1 supports the following Microsoft Visual Studio versions and associated programming languages.
| Programming Languages | Visual Studio Versions Supported by TestStand 2021 SP1 |
|---|---|
| .NET Framework 4.6.2 Languages (Visual C#, Visual Basic .NET) | 2015, 2017, or 2019 |
Note TestStand does not support Visual Studio Community. TestStand includes features that automate Visual Studio for debugging, generating, and editing code module source code. Visual Studio Community Editions do not support these features.
The .NET and Microsoft Foundation Class (MFC) examples include projects and solutions created in Visual Studio 2015.
The Python Adapter in TestStand 2021 SP1 supports the following Python versions:
| Programming Language | Full Support | Not Supported |
|---|---|---|
| Python | 3.6, 3.7, 3.8, 3.9, 3.10 | 3.5 or earlier |
Use the following recommended database client software with the database components included with TestStand:
Note You cannot install the Microsoft Office 12.0 Access Database Engine OLE DB Provider with 32-bit Microsoft Office. Visit ni.com/info and enter the Info Code 64TSaccdb to access the NI support article, Using Microsoft Access Databases with 64-bit TestStand, for more information about installing this provider.
Note NI does not recommend using the Microsoft OLE DB Provider for Oracle because it does not support all the OLE DB features TestStand requires.
Note Oracle recommends using Oracle Provider 11.1.0.6.0 or later if you want to read 64-bit integer values stored in NUMBER columns.
Download the TestStand installer from ni.com/downloads. NI software includes NI Package Manager to handle the installation. Refer to the NI Package Manager Manual for more information about installing, removing, and upgrading NI software using Package Manager.
Notes
Unless you specify another location during installation, the TestStand installer copies core files to <Program Files>\National Instruments\TestStand 2021. TestStand 2021 SP1 installs over TestStand 2021, if present.
You cannot install TestStand 2021 SP1 over a previous version, such as TestStand 2020, and you cannot install TestStand 2021 SP1 in the default installation directory for a previous version. If you installed a previous version of TestStand in a non-default directory, you can uninstall the previous version of TestStand and install TestStand 2021 SP1 to that directory.
Notes
TestStand installs the following additional software components:
Note TestStand can use newer versions of the LabVIEW RTE when you install LabVIEW on a development system. You can include newer versions of the LabVIEW RTE in deployments using the Drivers and Components dialog box of the TestStand Deployment Utility. Refer to the TestStand Help for more information about the Drivers and Components dialog box.
To use IVI, download and install IVI-compliant drivers from the Instrument Driver Network, located at ni.com/devzone/idnet. Users with a TestStand USB distribution can navigate to the Additional Installers folder to locate and run installers for IVI.
You can install TestStand 2021 SP1 on a computer that contains a previous TestStand version, but you cannot install TestStand 2021 SP1 over a previous TestStand version. You cannot install TestStand 2021 SP1 in the default installation directory for a previous version of TestStand. For example, TestStand 2021 SP1 does not install in <Program Files>\National Instruments\TestStand 2020. If you installed a previous version of TestStand in a non-default directory, you can uninstall the previous version of TestStand and install TestStand 2021 SP1 to that directory.
The TestStand Version Selector application indicates the active version of TestStand and can activate a different version of TestStand. Although you can install more than one version of TestStand on a computer, only one version of TestStand can be active and can run at a time.
The TestStand Version Selector application, TSVerSelect.exe, is located in the <Program Files>\National Instruments\Shared\TestStand Version Selector directory. To launch the TestStand Version Selector, select Start»National Instruments»TestStand Version Selector.
The Current Active Version control shows the currently active version of TestStand. Select a version in the Installed TestStand versions control and click Activate to activate a specific version of TestStand. The Path to 32-bit version and Path to 64-bit version controls show the locations of the selected version of TestStand. When activation is complete, the selector displays a message to indicate success or display any warnings. Click the Launch 32-bit or Launch 64-bit button to run the sequence editor application for the active version of TestStand.
If you activate TestStand 2021 SP1 and run a TestStand User Interface from a previous TestStand version, the user interface uses the TestStand 2021 SP1 Engine, step types, and components. If you activate a previous TestStand version and run a TestStand 2021 SP1 User Interface or the sequence editor, those applications do not function correctly.
Note The TestStand Version Selector does not typically require administrator privileges to activate a specific version of TestStand on Microsoft Windows 10. To require administrator privileges for using the TestStand Version Selector, add the /reqadmin command-line option to the selector shortcut.
Refer to the TestStand Help for more information about using the TestStand Version Selector.
After you install TestStand, you must use the NI Activation Wizard to activate the software or initiate the evaluation period for the software.
NI offers a variety of licenses for the different ways you can use TestStand in development and deployment applications. You can select from the following types of licenses:
In most cases, when you first install TestStand, you activate a TestStand Development System License. Use the other licenses to activate TestStand on computers to which you deploy TestStand custom sequence editors or user interfaces you develop.
Contact a local NI representative for more information or for questions about specific licensing needs.
Note If you upgrade TestStand with a service pack release by installing TestStand or a deployment that includes the TestStand Engine, the TestStand Engine on the computer becomes unlicensed. You must reactivate the license on the computer. A TestStand Development System License or a Debug Deployment Environment License must be current with the Standard Service Program (SSP) to reactivate a service pack license. You can reactivate a Custom Sequence Editor License for a service pack upgrade, even if the SSP for the original license lapsed. A TestStand Base Deployment License does not require SSP to reactivate a service pack license.
Refer to the Licensing Options for TestStand Systems section of Chapter 1, Introduction to TestStand, of the Getting Started with TestStand manual for information about how to use the available licenses when you build a TestStand-based test solution. Use the following descriptions only as a reference for the licensing options. Visit ni.com/activate for more information about activating TestStand licenses. Visit ni.com/teststand to purchase a TestStand license.
Note This document does not replace the NI Software License Agreement installed in the <Program Files>\National Instruments \Shared\MDF\Legal\license\NIReleased directory.
When you run TestStand in Evaluation Mode, the software expires after 7 days. You can generate a User Profile at ni.com to extend the evaluation period for an additional 45 days.
The Evaluation Mode software runs as a fully functional TestStand Development System during the evaluation period. You can activate a license at any point during or after the evaluation period.
Activate the TestStand Development System License to develop and edit test sequences and to save sequence files within the TestStand Sequence Editor, within a TestStand custom sequence editor, or programmatically using the TestStand API. This license also grants the right to develop custom sequence editors and operator interfaces. You must have an ni.com User Profile to activate a TestStand Development System license.
Activate the TestStand Custom Sequence Editor License to develop and edit test sequences and sequence files within a custom sequence editor or programmatically using the TestStand API.
The TestStand Debug Deployment Environment License offers the most flexibility for deploying TestStand and LabVIEW-based, LabWindows/CVI-based, and Measurement Studio-based systems.
Activate this license to install the development versions of TestStand, LabVIEW, LabWindows/CVI, Measurement Studio, and any corresponding add-on toolkits on a single test station so you can debug deployed test applications on the test station. This license grants the right to make minor edits to fix bugs in deployed test applications but does not grant the right to perform any development tasks using TestStand, LabVIEW, LabWindows/CVI, or Measurement Studio on the test station.
You cannot activate and deactivate the TestStand Debug Deployment Environment License and reuse it on multiple computers. If you need to use a single debug license across multiple computers, contact NI for more information about the Concurrent TestStand Debug Deployment Environment License.
The TestStand Base Deployment Engine License is the minimum license required for all deployed TestStand-based applications. Activate this license to deploy the TestStand Runtime, a TestStand Operator Interface, and sequence files to the single test station to which the license applies. This license does not grant the right to perform any development tasks using the TestStand Sequence Editor, a TestStand custom sequence editor, or the TestStand API.
If you are upgrading from TestStand 2010 or later, you can use the TestStand Migration Utility to migrate customizations and configuration settings from the earlier version of TestStand. You can also upgrade manually. Visit ni.com/info and enter the Info Code tsmigrate for more information about migrating to the current version of TestStand, including information about tasks you need to perform to upgrade manually from TestStand 4.2.1 or earlier.
You can also migrate from 32-bit TestStand 2021 SP1 to 64-bit TestStand 2021 SP1 or from 64-bit TestStand 2021 SP1 to 32-bit TestStand 2021 SP1. Refer to the Cross-Bitness Migration section of the TestStand Help for more information about migrating to or from 64-bit TestStand 2021 SP1.
Complete the following steps to use the TestStand Migration Utility to copy settings, configuration, and public component files from the directories of TestStand 2010 or later to the current version of TestStand.
Launch the TestStand Migration Utility.
Select Start»National Instruments»TestStand Migration Utility.
If you have more than one version of TestStand installed on the computer, the utility launches a dialog box in which you can specify the previous version of TestStand from which you want to migrate.
Note When you migrate from TestStand 2010 SP1 or TestStand 2010 to the current version of TestStand, the utility migrates the report and database options to the format for result processing configuration options for the current version of TestStand. Refer to the TestStand Help for more information about using the TestStand Migration Utility. Visit ni.com/info and enter the Info Code tsmigrate for more information about using the utility to migrate result processing configuration options.
Select the previous version of TestStand.
The utility checks the computer for all the files you can migrate to determine whether the files have changed since installation. The utility launches a status indicator dialog box during this process. When the utility finishes checking the files for changes, the utility main window launches.
Use the Files to Copy control to select the files you want to copy.
By default, the utility selects files you added or modified in the previous version of TestStand.
Expand the directories in the Files to Copy control to view the files you can migrate and whether those files have changed since installation.
The Conflicts column includes any conflicts that might affect the migration of the files you specify.
Note The utility overwrites any file you create or modify in the current version of TestStand if the file also exists in the corresponding directory of the previous version of TestStand and if you select the file in the Files to Copy control. Although the utility creates a backup copy of all overwritten files, verify that the utility will not overwrite any files you intend to keep in the version of TestStand to which you are migrating.
Click Migrate Files to begin the migration.
When the migration completes successfully, the utility generates a text file report that contains the results of the migration, including where the utility stored the file backups and which files were moved.
Note Consider the following behavior when using the TestStand Migration Utility:
If the <TestStand Public>\Components directory of the previous version of TestStand includes files installed by an installer other than the TestStand installer, you might need to use that specific installer to move the files for the files to function and uninstall properly from the <TestStand Public>\Components directory of TestStand 2021 SP1.
NI recommends that you use an installer that targets TestStand 2021 SP1 to install any such components instead of using the utility to copy the components. However, some installed components can function properly when copied to another directory and are safe to migrate with the utility.
The TestStand 2012 or later process models include significant changes to implement a plug-in architecture for model sequence files. TestStand 2012 or later uses the plug-in mechanism to decouple result processing from the process models. As part of this change, the result processing options move from the TestStandModelReportOptions.ini and TestStandDatabaseOptions.ini files into a single ResultProcessing.cfg file, located in the <TestStand Application Data>\Cfg directory, that stores configuration information for all result processing model plug-ins.
The result processing options files from TestStand 2010 SP1 or earlier are not compatible with TestStand 2012 or later process models. Refer to the Process Model Result Processing Plug-in Architecture section of the TestStand 2012 New Features topic in the TestStand Help for more information about the TestStand 2012 or later process models. Refer to the Using the Legacy Model Switcher Tool section of the TestStand 2012 New Features topic in the TestStand Help for more information about using the Legacy Model Switcher tool to use the equivalent legacy TestStand 2010 process models.
The following table describes the migration actions you can select in the TestStand Migration Utility to migrate the result processing configuration options from TestStand 2010 SP1 or earlier to the current version of TestStand.
Note The utility does not support migrating the configuration files from TestStand 2010 SP1 or earlier if you modified the ReportOptions or DatabaseOptions data types defined in the default process models.
| Migration Action | Description |
|---|---|
| Apply to new models | Creates a new configuration in a configuration set named Migrated from TestStand <Version>. The utility automatically selects a unique name for the configuration if the utility has already used the default name in a previously completed migration. Refer to the migration report for the specific configuration names the utility uses. |
| Apply to legacy models | Copies the options files from TestStand 2010 SP1 or earlier to the current TestStand directory so you can use the previous configurations with the equivalent legacy TestStand 2010 process models in the current version of TestStand. When you migrate database options, the utility renames TestStandDatabaseOptions.ini to TestStandDatabaseSchemas.ini. |
| Apply to new and legacy models | Adds a new configuration in the Migrated from TestStand <Version> configuration set and copies the options files from a previous version of TestStand. |
If you are upgrading from TestStand 4.2.1 or earlier, you can manually migrate result processing options for use with TestStand 2012 or later process models or the equivalent legacy TestStand 2010 process models. Visit ni.com/info and enter Info Code tsmigrate for more information about manually migrating result processing options to TestStand 2021 SP1.
Visit ni.com/security to view and subscribe to receive security notifications about NI products. For information about critical updates from NI, refer to Available Critical and Security Updates for NI Software.
Refer to the TestStand Help for information about TestStand 2021 SP1. You can access the TestStand Help in the following ways:
TestStand includes a variety of example programs that you can use to help you learn key concepts or to serve as a starting point for applications you create. You can browse the examples in the following ways:
Select Help»Find Examples to launch the NI TestStand Example Programs Help from the TestStand Sequence Editor.
You can automate the installation of most NI products using command-line arguments to suppress some or all of the installer user interface and dialog boxes.
If the NI product you are installing uses Microsoft .NET 4.6.2, the .NET installer may run before any NI software installs and may require a reboot before the installation of NI software begins. To avoid a .NET reboot, install .NET 4.6.2 separately before you install NI software.
For more information about automating the installation of NI products, refer to Automating an Installer in the NI Package Manager manual.
For more information about NI support for Windows 10, refer to NI Product Compatibility for Microsoft Windows 10.
TestStand no longer supports Windows Vista/XP/7/8.x, Windows Server 2003/2008/2012, or any 32-bit Windows operating system. Versions of this product that ship after May 1, 2021, may not install or execute correctly on these operating systems. For detailed information about NI operating system support, visit https://www.ni.com/r/win32bitsupport.
Refer to the Technical Support page at ni.com/support and search for TestStand to access the TestStand Support website, which contains online documentation, KnowledgeBase articles, tutorials, example code, discussion forums, and other resources.
Copyright
© 2000–2022 National Instruments Corporation. All rights reserved.
Under the copyright laws, this publication may not be reproduced or transmitted in any form, electronic or mechanical, including photocopying, recording, storing in an information retrieval system, or translating, in whole or in part, without the prior written consent of National Instruments Corporation.
NI respects the intellectual property of others, and we ask our users to do the same. NI software is protected by copyright and other intellectual property laws. Where NI software may be used to reproduce software or other materials belonging to others, you may use NI software only to reproduce materials that you may reproduce in accordance with the terms of any applicable license or other legal restriction.
End-User License Agreements and Third-Party Legal Notices
You can find end-user license agreements (EULAs) and third-party legal notices in the following locations after installation:
U.S. Government Restricted Rights
If you are an agency, department, or other entity of the United States Government ("Government"), the use, duplication, reproduction, release, modification, disclosure or transfer of the technical data included in this manual is governed by the Restricted Rights provisions under Federal Acquisition Regulation 52.227-14 for civilian agencies and Defense Federal Acquisition Regulation Supplement Section 252.227-7014 and 252.227-7015 for military agencies.
IVI Foundation Copyright Notice
Content from the IVI specifications reproduced with permission from the IVI Foundation.
The IVI Foundation and its member companies make no warranty of any kind with regard to this material, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The IVI Foundation and its member companies shall not be liable for errors contained herein or for incidental or consequential damages in connection with the furnishing, performance, or use of this material.
Trademarks
Refer to the NI Trademarks and Logo Guidelines at ni.com/trademarks for information on NI trademarks. Other product and company names mentioned herein are trademarks or trade names of their respective companies.
Patents
For patents covering the NI products/technology, refer to the appropriate location: Help»Patents in your software, the patents.txt file on your media, or the NI Patent Notice at ni.com/patents.
376434N-01