Company Events Academic Community Support Solutions Products & Services Contact NI MyNI

Customizing Components You Deploy

NI TestStand™ 2012 Help

Edition Date: August 2012

Part Number: 370052K-01

»View Product Info
Identifying Components to Deploy Choosing a Deployment Mechanism Preparing Source Components for Deployment Customizing Components You Deploy Creating Deployments Transferring Files Validating Deployments

Use the TestStand Deployment Utility to specify and customize the files or directories you select to include in the deployment.

Specifying Source Files

When you specify the source files for a test system on the Distributed Files tab of the deployment utility, the utility prompts you to analyze the source files before displaying them in the Distributed Files list. You must manually add certain types of files to the deployment. If you modify files after adding them to the deployment, click the Analyze Source Files button to re-analyze the files.

When you specify a TestStand workspace file, the Distributed Files list includes the workspace file, its contents, and the dependencies, which include all the TestStand projects in the workspace, all the sequence files in each of the projects, any code modules sequence files call statically, and any other files in the project. By default, the Distributed Files list does not include code module dependencies. However, if you used the System Source tab to specify a directory from which to deploy files, the Distributed Files list on the Distributed Files tab includes all the files from that directory and their dependencies. If you want to use the Distributed Files tab to change the file properties of a code module dependency, add the code module dependency to a TestStand project because the Distributed Files list includes all files in a TestStand project.

Excluding Source Files

If the Distributed Files list includes files you do not want to include in the deployment, remove the checkmark next to the file or directory you want to exclude from the deployable image in the Source or Destination view.

Customizing Files

Select a file or directory in the Distributed Files list and use the options in the File Properties section on the Distributed Files tab to customize how to include each file or directory in the deployable image and how the installer you build with the deployment utility for the deployable image operates on the files.

Include Without Processing Item or Dependencies

Enable the Include Without Processing Item or Dependencies option in the File Properties section on the Distributed Files tab to copy the selected file to the deployment image directory without any additional processing during the build.

Note Note  You must ensure the files work correctly without modifications. The deployment utility does not attempt to find or include any dependencies of the file during analysis.

Use this technique in the following situations:

  • When you want to include the source files for a user interface without modification but process code module VIs normally
  • When you want to deploy VIs in a different version of LabVIEW from the code modules
  • When you want to deploy files with checksums

Include All Files in a LabVIEW Project

By default, the deployment utility includes only the files steps reference. Enable the Include All VIs in LabVIEW Project option in the File Properties section on the Distributed Files tab to add all the files in the selected LabVIEW project to the deployment so you can more easily modify the test system you deploy.

Installer Properties

The options in the Installer Properties section on the Distributed Files tab apply only when you use the deployment utility to build an installer. These options do not affect the files in the deployable image directory.

Select a new directory from the Installation Destination ring control to change the destination for a file. Use the Destination view to modify the Installation Destination Subdirectory control to change the destination for all files in the directory.

LabVIEW Options

Click the LabVIEW Options button on the Distributed Files tab to launch the LabVIEW VI Options dialog box, in which you can customize how the deployment utility saves VIs in the deployable image.

Output VIs to a Packed Project Library

Note Note  You must have LabVIEW 2010 or later to use LabVIEW packed project libraries in TestStand.

Using packed project libraries instead of VIs in a deployment offers the following advantages:

  • Reduces the number of files in the deployment because the packed project library contains all the VIs you select.
  • Occupies less disk space than VIs because packed project libraries are compressed.
  • Simplifies tracking file versions, updating, and installer behavior because packed project libraries use a version resource number, you specify on the Details tab of the File Properties dialog box.
  • Ensures that you do not need to recompile calling VIs when VIs inside a packed project library change their inplaceness, or ability to reuse memory. The deployment utility enables by default the Callers adapt at run time to Exported VI connector pane state option on the Connector Pane State page of the Packed Library Properties dialog box in LabVIEW for all packed project libraries it creates so you can update subsets of VIs on a test station computer without mass compiling all the VIs on the test station computer.

Click the Options button in the LabVIEW VI Options dialog box to launch the Packed Project Library Options dialog box, in which you can configure options for how the deployment utility builds LabVIEW packed project libraries, including the name of the packed library, the version number, the product name, the legal copyright statement, the company name, the internal name, and the description. You can also use LabVIEW to build packed project libraries.

Excluding VIs

The LabVIEW Development System installs vi.lib. Instrument drivers install VIs in instr.lib. Toolkits and third-party software install VIs in user.lib. Exclude dependencies 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 Engine, a custom user interface, and a TestStand Custom Sequence Editor License so other developers can modify and redeploy test sequences.

Including VIs from vi.lib, instr.lib, or user.lib in a deployment you install on a computer that includes the LabVIEW Development System can cause the following issues:

  • The VIs in the deployment have the same qualified names as the source VIs in vi.lib, instr.lib, or user.lib, which introduces the possibility of cross-linking.
  • The deployment does not reflect changes later versions of LabVIEW make to vi.lib, which can result in broken VIs or VIs that do not run correctly if the VIs do not include the changes that later versions of LabVIEW require.
  • Partial project libraries can cause broken VIs.

LabVIEW Optimizations

Enable the Remove Unused VI Components option in the LabVIEW VI Options dialog box to decrease the size of a deployment by removing unused polymorphic VIs from the distribution. When you enable this option, you cannot edit code module VIs to include calls to the removed polymorphic VIs on the test station computer.

If you call VIs in the context of multiple projects, you can enable the Consolidate Files Shared By Projects option in the LabVIEW VI Options dialog box to consolidate all files in LabVIEW projects into one project to increase build speed and decrease disk usage for multiple projects that share common subVIs by making a single source distribution for every project. This optimization is not always possible as two projects might compile the same source VI differently, which can result in slower build times. If the deployment utility cannot consolidate all projects, the utility returns a warning that explains why consolidation is not possible and builds the distribution without consolidating the projects.


Previous: Preparing Source Components for Deployment Next: Creating Deployments

See Also

Chapter 7, Effectively Using LabVIEW with TestStand, of the Using LabVIEW and LabWindows/CVI with TestStand manual


 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit