Identifying Components to Deploy

Use the following table to identify the files to explicitly include in the deployment to ensure that the test system executes successfully on the test station computer:

Component Guidance
TestStand license Review the TestStand license options to determine which license to use.
Sequence files Identify the set of sequence files the test system requires by creating a list of the high-level tasks the test system performs, including trouble-shooting, calibrating devices, and performing other diagnostic tasks. For each task, identify the root sequence or sequences that accomplish the task. For each sequence, identify the process models the sequence uses. The TestStand Deployment Utility automatically identifies and includes sequence files for the sequences that Sequence Call steps statically reference. You must manually identify and include sequence files for sequences that Sequence Call steps dynamically reference. Use the Sequence Hierarchy window in the TestStand Sequence Editor to display a graph of the hierarchy of all sequences and sequence calls that use expressions for a sequence file.
TestStand Runtime A test system you deploy to a test station computer requires the TestStand Runtime to execute TestStand sequence files. You can customize the features of the TestStand Runtime to include in the installer you build with the deployment utility, such as excluding the default TestStand examples and tutorials. The TestStand Engine is part of the TestStand Runtime. The TestStand Engine includes a backward-compatible API so you can use existing property and method calls in later versions of the TestStand Engine without modification and so you can run user interfaces built in earlier versions of TestStand with later versions of the TestStand Engine.
Code modules The deployment utility automatically includes static dependencies of code modules, such as utility DLLs statically linked to code module DLLs and VI dependencies. However, you must manually include implicitly referenced files, such as documentation, images, and support files, and dynamically referenced files, such as VIs you call using VI Server or dynamically loaded DLLs.You must verify that the test system uses all the dynamically called files you added to the workspace or to destination directories, including code modules you added to a workspace by using the Insert Code Modules context menu item in the Workspace Browser dialog box or the Insert Code Modules context menu item in the Workspace pane.
Files that Property Loader steps call The deployment utility automatically includes source files that Property Loader steps reference. If the file is specified dynamically through a TestStand expression that can only be evaluated at runtime, you must manually include all the files the expression could potentially reference. TestStand Deployment Utility will display a message listing any expressions that it could not evaluate.
Image files, support files, configuration files, or data files Because other files in a test system typically implicitly reference image, support, configuration, and data files, you must manually include these types of files.
LabVIEW toolkits Most LabVIEW toolkits do not require the toolkit license to execute VIs you build with the toolkit. Refer to the toolkit licensing requirements to determine if you need to include the toolkit license or any additional components required to execute these VIs.
LabWindows/CVI Run-Time Engine You can use the shared or side-by-side version of the LabWindows/CVI Run-Time Engine (RTE) to execute DLLs built with LabWindows/CVI from TestStand.
LabVIEW Run-Time Engine By default, the deployment utility includes all required dependencies and compiles all VIs included in the deployment. You must manually include any dynamically-called VIs in the deployment.
LabVIEW NXG Run-Time Engine By default, the deployment utility invokes LabVIEW NXG to recompile all GLL binaries included in the deployment using the associated source files. You can optionally include source files in the deployment to make changes to LabVIEW NXG code modules on the test station computer. The LabVIEW NXG run-time engine is required to execute test code within GLLs.
LabVIEW modules The LabVIEW DataLogging and Supervisory Control (DSC) Module requires the LabVIEW DSC Module Run-Time System installed on the test station computer. In contrast, you can run LabVIEW Real-Time Module VIs on a pre-configured, real-time computer without including the LabVIEW Real-Time Module in the deployment. Refer to the documentation for the LabVIEW module to determine whether you need to include it.
Configuration files in the <TestStand Application Data>\Cfg directory Include the configuration files you customized for the settings you want to use on the test station computer. You can use configuration files customized for test sequence developers to use on development computers that are different from configuration files you customize for operators to use on test station computers.
TestStand components

Include the components you customized in the <TestStand Public>\Components directory, such as a process model you modified to launch a customized dialog box for entering scanned UUT serial numbers or a user interface you customized to provide debugging information for operators. Enable the From TestStand Public Directories option in the Deploy Files section on the System Source tab of the deployment utility to include all files in the <TestStand Public>\Components directory.

If you deploy a process model based on an NI model, the model uses a language resource file to support localized strings. For model strings to appear correctly, you must also include the required language file in your deployment:<TestStand>\Components\Language\English\ModelStrings.ini. To ensure this file is included, copy it to the <TestStand Public>\Components\Language\English directory before deploying.
User interface executable You can deploy the default user interfaces TestStand includes or you can create a customized user interface to deploy. If you deploy a customized user interface, include the following files:
  • The user interface executable
  • Configuration files
  • Dependent DLLs, ActiveX controls, or .NET assemblies or controls
  • Language .ini files for localization, if required
  • Required run-time engines
Run-time engines The following file types require certain components on the test station computer to execute correctly. You do not need to include the required component in the deployment if the test station computer already has the component installed.
  • Code modules, executables or DLLs you built with LabVIEW—
    • Version of LabVIEW RTE that matches the version of LabVIEW you used to create the code module, executable, or DLL
    • You can install multiple versions of the LabVIEW RTE on a test station computer. However, NI recommends using only one version of the LabVIEW RTE in a single test system to simplify deployment.
  • Code modules, executables or DLLs you built with LabVIEW NXG—
    • Version of LabVIEW NXG RTE that matches the active version of LabVIEW NXG you used to rebuild the GLL binaries
    • You can install multiple versions of the LabVIEW NXG RTE on a test station computer. However, NI recommends using only one version of the LabVIEW NXG RTE in a single test system to simplify deployment.
  • DLL code modules or executables you built with LabWindows/CVI—
    • Version of LabWindows/CVI RTE that matches or that is later than the version of LabWindows/CVI you used to create the executable or DLL
      • You can install or upgrade only one version of the default LabWindows/CVI RTE on a test station computer at a time, but you can install or upgrade multiple versions of the side-by-side version of the LabWindows/CVI RTE.
      • When you deploy a user interface executable or a DLL module that is bound to a side-by-side version of the LabWindows/CVI RTE, you must explicitly include the side-by-side version of the LabWindows/CVI RTE in the deployable image you use to build an installer with the deployment utility.In the Drivers and Components dialog box, you must enable the item in the Components to Include list that corresponds to the side-by-side version of the LabWindows/CVI RTE you want to use, such as NI LabWindows/CVI Side-By-Side Run-Time Engine 2012.
  • .NET assembly—Version of .NET that supports executing the assembly (Refer to Microsoft documentation for more information about .NET version compatibility and deployment.)
NI hardware drivers Refer to the documentation for the NI device the test system uses to determine the driver to include. You do not need to include the NI hardware driver in the deployment if the test station computer already has the driver installed. You can also include NI hardware configuration information.
Third-party components Include the third-party hardware drivers or software components required to execute the test system correctly. You can include the collection of third-party files in the single installer you build with the deployment utility using custom commands.

Components to Deploy for Editing on a Test Station

In some cases you might need to make changes to debug or fix an issue with the test system. Typically, after you correct the issue with the test system, you re-deploy the entire test system or you deploy a patch that contains only the updated module.

If you want to edit code modules on the test station computer, you must install the LabWindows/CVI Development System to debug or recompile DLLs you built with LabWindows/CVI, and you must install the LabVIEW Development System and all toolkits and modules required to debug or edit VIs. You can use a TestStand Debug Deployment Environment License on the test station computer to edit code modules on the test station computer.

Exclude VIs from vi.lib, instr.lib, or user.lib from deployments when you deploy VIs that you expect others to edit, such as when you deploy VIs to another development computer or to a test station computer that includes the LabVIEW Development System, the TestStand Runtime, a custom user interface, and a TestStand Custom Sequence Editor License so other developers can modify and redeploy test sequences.

To include source files for LabVIEW NXG code modules, enable the Include LabVIEW NXG source files option, located in the LabVIEW NXG options tab of the LabVIEW VI options dialog. Launch the LabVIEW VI options dialog using the LabVIEW Options button on the Distributed Files tab.