Creating a Deployable Image

TestStand 2017 Help

Edition Date: November 2017

Part Number: 370052W-01

»View Product Info

Download Help (Windows Only)
NI TestStand 2014 Help
NI TestStand 2014 SP1 Help
TestStand 2016 Help
TestStand 2016 SP1 Help
TestStand 2017 Help

The TestStand Deployment Utility collects all the files the deployment requires into one directory called the deployable image, which contains the files and statically referenced dependencies you specify on the System Source tab. Creating a deployable image with the deployment utility helps you verify that you include the required files and process the files before you build an installer or use a network drive or source code control system to deploy the files.

When you create a patch deployment, the deployment utility removes files from the patch deployable image that have not changed since the previous full or baseline patch deployment image.

Troubleshooting the Deployable Image

Use the deployment utility status log to diagnose any potential problems with the deployment. If the log has any errors or warnings, the help page displays information about the steps required to fix the issue.

Note Note  The purpose of information messages, such as the message about expressions that specify code module paths, is to alert you to common mistakes during deployment so you can take the required actions to prevent the associated problems.

Directory Structure Differences between Source Distributions and Packed Project Library Distributions

You can include in the deployable image the source files necessary to rebuild packed project libraries, but doing so places the packed project library source files in a different directory structure from the default source distribution directory structure, as shown in the following figure.

Creating a Deployable Image

When you create a source distribution that contains packed project libraries, the deployment utility includes dependent files in the SubVI Location directory you specify in the LabVIEW VI Options dialog box.

When you create a packed project library distribution, the deployment utility does not include dependent files in the SubVI Location directory you specify in the LabVIEW VI Options dialog box because the packed project library itself contains all dependent files in the same top-level directory as the packed project library.

If you previously deployed a source distribution and then switch to using a packed project library distribution, the directory structure of the new deployment changes but the functionality remains the same. Typically, you do not need to make changes to the new deployment unless you are using a source code control system for distribution and rely on consistent locations of files for revision history information.

Default Image Directory of a Source Distribution

The default image directory of a source distribution includes the following directories and files:

Notes Notes
  • The deployment utility can create additional directories depending on the destination subdirectory of the top-level files in the source distribution. Use the Distributed Files tab to change the destination subdirectory of top-level files.
  • Patch deployments use the same image directory structure, and the deployment utility automatically removes any files the patch deployment does not require.
  • Selected Installation Destination—Contains top-level files, such as VIs, sequences, LabVIEW projects, TestStand workspaces, and TestStand projects. Select a file on the Distributed Files tab of the deployment utility and use the Installation Destination option to specify this directory. Use the Installation Destination Subdirectory control to specify a subdirectory.
    • SubVI Location directory—Contains direct dependencies of the top-level VIs, including subVIs, DLLs, and libraries of the subVIs. You specify this directory in the SubVI Location option in the LabVIEW VI Options dialog box.
      Note Note  If a direct dependency of a top-level VI is also a top-level file, such as when you call a DLL from a VI and also call the DLL from a step in a sequence, the deployment utility places the file in the path you specify in the Installation Destination Subdirectory control. The deployment utility also correctly links the VIs and sequences that call the file.

      • Data directory—Contains indirect dependencies of the top-level VIs, including libraries of top-level files and classes.

    • VIs for Project_Name directory—Contains top-level files for the project. If you consolidate projects, the deployment utility creates only one VIs for Projects directory in which to store all the top-level files for all projects.
      • SubVI Location directory—Uses the same name and structure as the top-level SubVI Location directory.

        • Data directory—Uses the same name and structure as the top-level Data directory.

Image Directory of a Packed Project Library Distribution

The image directory of a packed project library distribution includes the following directories and files:

Note Note  Patch deployments use the same image directory structure, and the deployment utility automatically removes any files the patch deployment does not require.
  • Selected Installation Destination—Contains top-level files, such as packed project libraries, sequences, LabVIEW projects, TestStand workspaces, and TestStand projects. This directory also contains packed project library dependencies, such as DLLs called from VIs in the packed project library. Select a file on the Distributed Files tab of the deployment utility and use the Installation Destination option to specify this directory. Use the Installation Destination Subdirectory control to specify a subdirectory.
    • VIs for Project_Name directory—Contains top-level files for the project. If you consolidate projects, the deployment utility creates only one VIs for Projects directory in which to store all the top-level files for all projects.
    • Packed Project Library Source directory—Contains one LabVIEW project for each packed project library in the deployment and one readme file for each project. (LabVIEW 2012 SP1 or earlier) After the projects have been built in the Packed Project Library Source directory, this directory contains the packed project libraries generated by the projects with the same directory structure as the selected installation destination.

      • Source Files directory—Contains directories for each project.
        • VIs for Project_Name directory—Contains all the files added to the top-level library in the project, including top-level files, libraries of the top-level files, and other VIs in the libraries of the top-level files.
          • NI Top Level Library.lvlib, which is the top-level library for the deployment.
          • Support VIs directory—Contains dependencies of the top-level VIs in the project, including subVIs, DLLs, and libraries of the subVIs.
      • Builds directory(LabVIEW 2013 or later) After the projects have been built in the Packed Project Library Source directory, this directory contains the packed project libraries generated by the projects with the same directory structure as the selected installation destination.


See Also

Deploying 32-bit TestStand and 64-bit TestStand Systems

Deploying VIs in LabVIEW Packed Project Libraries

Installer Issues for 32-bit TestStand and 64-bit TestStand

WAS THIS ARTICLE HELPFUL?

Not Helpful