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

Using a TestStand Workspace File to Create a Deployment

NI TestStand™ 2012 Help

Edition Date: August 2012

Part Number: 370052K-01

»View Product Info
Download Help (Windows Only)

Use TestStand workspaces and projects to organize the files in a TestStand system. A workspace contains projects, and projects contain files or folders, which group files logically. For example, you can use a process model folder to contain process model sequences.

When you use a workspace, you must define at least one project. However, defining multiple projects in a workspace can help you better organize a test system. For example, you can define product model projects that contain all the tests required for the specific product model. When a model becomes obsolete, you can remove only the corresponding project from the workspace to update the test system.

Use workspace files to help organize and access development files, to perform source code control (SCC) operations in the TestStand Sequence Editor or in a TestStand User Interface, and to store debugging information, such as breakpoints and watch expressions. You can use the TestStand Deployment Utility to create a deployment that contains all the files you specify in a workspace file.

Using workspaces and projects as the source for deployments offers the following advantages:

  • Workspaces can contain files from multiple paths, which is more flexible than creating a deployment from a single root directory in the following ways:
    • You can map a directory in a workspace to a directory on the hard drive
    • You can add files from multiple directories to a single workspace directory
    • You can include only specific files from a directory on the hard drive in a workspace directory
  • Workspaces contain references to files, not the files themselves. Therefore, deleting files from a workspace does not delete the files from disk.
  • You can use projects as reusable, modular components that multiple workspaces can share. Defining projects by functionality can also help you easily add or remove features to or from a deployment by adding or removing the specific project to or from the workspace. For example, you can create a user interface project that includes all the files for the user interface you want to deploy.

Enable the From TestStand Workspace File option in the Deploy Files section on the System Source tab of the TestStand Deployment Utility and browse to or enter the path to the workspace file you want to use. When you add new files to the workspace, the deployment utility includes the new files the next time you build the deployment.

Note Note  When you use the deployment utility to deploy only the TestStand Engine or to deploy only the components in the <TestStand Public> subdirectories, you do not need to use a workspace file to organize the files for the deployment.

Creating a Workspace File

Complete the following steps to create a workspace file.

  1. Create a list of files to add to the workspace by identifying the components and required files for the test system.
  2. Select File»New»Workspace File to create a workspace file. You must add one or more TestStand project files to the workspace.
  3. Add individual files or all the files in a directory to the project file.

Inserting Code Modules in a Workspace

You can right-click a sequence file in the workspace and select Insert Code Modules from the context menu to automatically include the code modules a sequence file uses. However, for the following reasons, National Instruments does not recommend inserting code modules that sequence files use in the workspace if you are using the workspace only to create a deployment:

  • Before creating a deployment, the deployment utility analyzes all the files in the workspace and includes the files that test sequences statically reference, including code modules.
  • The list of code modules you insert in the workspace is a static list and does not automatically refresh when the sequence file changes. Therefore, you might deploy files that the test system no longer requires.

Refreshing the Code Modules Directory in a Workspace

When a sequence file in a workspace changes or if you are using a workspace to interface with an SCC system, complete the following steps to manually refresh the code modules directory to avoid deploying files that the test system no longer requires.

  1. Delete the current code modules directory from the workspace.
  2. Right-click the sequence files for which you want to add code modules.
  3. Select Insert Code Modules from the context menu.

See Also

Adding Dynamically Called Files to a Workspace

Distributing Tests from a Workspace

Including the <TestStand Public> Directory

Understanding Workspace Files section of Chapter 2, Loading and Running Sequences, of the Getting Started with TestStand manual


 Was this document helpful?  submit
  Helpful Not Helpful