LabVIEW NXG Module Tab

TestStand 2019 Help

Edition Date: May 2019

Part Number: 370052AA-01

»View Product Info
Download Help (Windows Only)

Insert a step configured to use the LabVIEW NXG Adapter and select Specify Module or Step Settings from the context menu to display the LabVIEW NXG Module tab in the TestStand Sequence Editor.

You can use the LabVIEW NXG Module tab to complete the following tasks:

  • Select the LabVIEW NXG project that refers to the VI if the step will execute in the LabVIEW NXG Development System
  • Select the GLL that contains the VI if the step will execute in the LabVIEW NXG Runtime
  • Select the VI the step executes
  • Create and edit a VI or a LabVIEW NXG project in LabVIEW NXG
  • Specify whether LabVIEW NXG shows the front panel of the VI when TestStand calls the VI in the LabVIEW NXG Run-time Engine

The LabVIEW NXG Module tab has different configuration options depending on if the step is configured to run in the LabVIEW NXG Development System or the Runtime Engine. TestStand can only run a VI contained in a project in the Development System and only a VI present in a GLL (built binary output of a component in a project) in the LabVIEW NXG Runtime Engine.

Note Note  NI recommends that you place all VIs inside components, since this helps organize their code and the component can be built into a GLL that can be executed in the LabVIEW NXG Run-time engine. A VI that is in a project but not in a component cannot be called from the LabVIEW NXG Run-time engine since you cannot build a GLL containing the VI.
  1. Module configured to run in the LabVIEW NXG Development System—The Step settings pane for a LabVIEW NXG module uses this view when the Always run in LabVIEW NXG Runtime Engine option is disabled in the Advanced Settings Window and when the LabVIEW NXG Development System is selected as the Server for execution in the LabVIEW NXG Adapter Configuration dialog box. This view is used to configure the module settings that are required to execute a VI in the context of a LabVIEW NXG project in the Development System.

    This view has the following options:

    • Project Path—The path of the LabVIEW NXG project the step uses. The control contains a most recently used (MRU) list of the last ten selected LabVIEW NXG projects. Every LabVIEW NXG VI must be contained in a project so specifying the project is mandatory, unlike for LabVIEW modules.
    • Browse for LabVIEW NXG Project—Launches the Select the Step's LabVIEW NXG Project File dialog box, which you can use to browse for the LabVIEW NXG project (.lvproject) file to open.
    • Create LabVIEW NXG Project—Creates an empty LabVIEW NXG project. If the LabVIEW NXG project you specify does not already exist, the LabVIEW NXG Adapter creates it. If the file already exists, the LabVIEW NXG Adapter prompts you to overwrite the existing file.
    • Module Name—The Module Qualified Name of the VI the step calls. The control contains an MRU list of the last ten VIs selected for the configured project.
    • Browse for VI—Launches the Select Module from Project dialog box, which you can use to select a VI from the project that the step is configured to use.
    • Configure Settings For Property Node—Displays the Configure Property Node (link to help topic) dialog, in which you can specify the I/O Reference type and select properties for the Property Node call. This option is only enabled if a valid project is specified in the Project Path.
    • Undock/Dock LabVIEW VI Help—Attaches or detaches the VI Help panel from the Module tab.
    • VI Description—Displays the description of the VI from the VI Description window in the Document tab of the LabVIEW NXG VI Properties pane.
    • Parameter Description—Displays the description of the parameter selected in the Parameter Table. This is the description available in the Description window in the Items Tab of a LabVIEW NXG VI's properties pane, when the corresponding control or indicator is selected.
    Note Note  To show the Front Panel of a VI that is executing in the LabVIEW NXG Development System, choose the Separate Window option under the Run Behavior options of the VI's Panel properties. When VIs with Separate Window enabled are executed from TestStand, their Front Panels are displayed in front of TestStand's main window.
  2. Module configured to run in the LabVIEW NXG Runtime Engine—The Step settings pane for a LabVIEW NXG module uses this view when the Always run in LabVIEW NXG Runtime Engine option is enabled in the Advanced Settings window or when the LabVIEW NXG Runtime Engine is selected as the Server for execution in the LabVIEW NXG Adapter Configuration dialog box. The following options are used to configure the module to execute a VI from a GLL in the LabVIEW NXG Runtime Engine:
    • GLL Path—The path of GLL the step uses. The control contains a most recently used (MRU) list of the last ten selected GLLs.
    • Browse for GLL—Launches the Select the GLL for the Step dialog box which you can use to browse for the GLL (.gll) to open.
    • GLL Source code —This option launches the GLL Source Code Files Dialog where the user can specify the project that contains the component used to build the GLL configured in the step.
    • Module Name —The Module Qualified Name of the VI the step calls. The control contains an MRU list of the last ten VIs selected for the configured GLL.
    • Browse for VI —Launches the Select Module from GLL dialog box, in which you can select a VI from the GLL that the step is configured to use.
    • Show VI Front Panel—When you enable this option, the front panel of the VI opens when the LabVIEW NXG Adapter calls the VI and closes when it is done executing. The button has two modes:
      • Show Front Panel Modal—The Front Panel is shown as a dialog box that is modal to TestStand's main window.
      • Show Front Panel Modeless—The Front Panel is shown as a dialog box that is not modal to TestStand's main window. You can still interact with TestStand while this dialog box is shown.
  3. Some options are common to both views:
    • Edit LabVIEW NXG Project—Edits the configured LabVIEW NXG project, if any.
    • Advanced Settings—Launches the LabVIEW NXG Advanced Settings window, in which you can configure a LabVIEW NXG step to execute a VI with the LabVIEW NXG Run-time engine.
    • Reload VI Prototype—Allows the user to refresh the parameter information of the VI.
    • Create VI—Displays the Create Module dialog box. The Create Module dialog box allows you to specify the name and location of the new VI in the project. When you hit OK on the dialog, TestStand creates a code shell for the VI specified and adds it to the project at the specified location. If a VI with the same path already exists, the LabVIEW NXG Adapter prompts you to overwrite the existing file. If a VI code template file exists for the step type you are using for the step, the LabVIEW NXG Adapter uses the template to create the new VI. When configuring a step using the Runtime Engine, the project and Module Qualified Name should be specified for this option to work correctly.
    • Edit VI—Edits an existing VI, opening it in the LabVIEW NXG project. When configuring a step using the Runtime Engine, the project and Module Qualified Name should be specified for this option to work correctly.
    • VI Parameter Table—Contains information about each control or indicator wired to the connector pane of the VI. These are the parameters of the VI.
      • Parameter Name—Label text of the control or indicator.
        Note Note  Parameters with attributes include an Edit Attributes button in the Name column of the VI Parameter Table. You can edit attributes for fields of containers and elements of arrays. TestStand associates parameter attributes with the module parameter, which TestStand stores with the step configuration information, not with the parameter value that TestStand passes to the module. Right-click an item in the VI Parameter Table to access the VI Parameter Table context menu, from which you can launch the Attributes dialog box.
      • Type—TestStand equivalent data type for the control or indicator.

        For one-dimensional arrays, you can specify an expression value for the entire array, or you can specify values for each element of the array. Use the plus (+) buttons to insert a new element in the array, and the minus (-) buttons to remove specific elements from the array.

        When you select Binary String in the Type column of the VI Parameter Table on the LabVIEW NXG Module tab to store a LabVIEW NXG string that contains binary data in a TestStand property. TestStand compresses the binary data, encodes the compressed data, and stores the compressed data using only printable ASCII characters. To pass a compressed string to a VI, select Binary String in the Type column. TestStand unencodes and decompresses the binary data the string stores before passing it to the VI.
        Note Note  To retrieve the raw binary data stored in a string variable in TestStand, call the PropertyObject.GetValBinary method of the TestStand API. See the Retrieving Binary String Values from Reports and Databases topic for more information about retrieving binary data from string values.
      • Create/Update Custom Data Type—Launches the Create/Update Custom Data Type from Cluster dialog box, in which you can configure a new custom data type or update an existing custom data type.
      • Apply Cluster Passing Changes—Updates a VI parameter that contains a subproperty that no longer maps to the correct cluster element. You can use this button to update the parameter and automatically map the subproperty to the correct cluster element.

        This button might also appear when TestStand cannot automatically map a subproperty to the correct element and the Value column of the VI Parameter Table contains a '??? <Unknown Value>' error for the subproperty.
    • In/Out—Specifies whether the parameter is an input (control on the VI front panel wired to the connector pane) or an output (indicator on the VI front panel wired to the connector pane).
    • Log—When you enable this option, the step logs the parameter as an additional result. Enabling this option is equivalent to using the checkbox next to the additional result name on the Additional Results panel of the Properties tab of the Step Settings pane.
    • Default—When you enable this option, TestStand uses the default value of the control for the parameter, cluster element, or array element. This option is not available when the terminal of the VI is marked as Required.
    • Value—A TestStand expression. For input parameters, TestStand passes the value of this expression to the VI unless you place a checkmark in the option in the Default column. For output parameters, TestStand stores the data the VI outputs in the location this expression specifies. To help you enter an expression in the Value column, click the Expression Browse button to launch the Expression Browser dialog box. For enumerated types, a combo box displays all valid values for the type. You can also use an expression with an enumerated type.

Automatically populating the GLL Path

LabVIEW NXG specifies the output directory of a GLL that is the build output of a component for a specific target. This implies that if a project and a Module Qualified Name are specified in a LabVIEW NXG module, then there is a definitive GLL path that must be used in the step. The GLL path configured in a LabVIEW NXG module must match the path expected by LabVIEW NXG based on the project and the Module Qualified Name (component and target properties). A step that is configured with a GLL that is different from this expected path returns an error.

Note Note  When the step is executing in the Runtime Engine, the validation to check if the configured GLL path matches the expected GLL path happens only if the user has enabled the Automatically Build Missing GLLs at the Start of Execution or Validate GLL Path options in the LabVIEW NXG Adapter Configuration Dialog.
Note Note  A GLL configured in a step that doesn't have a project or Module Qualified Name specified will not be validated. On configuring a step when using the Development System view, TestStand queries for the expected GLL path from LabVIEW NXG and populates the value in the GLL Path property.

See Also

Attributes dialog box

Calling LabVIEW NXG property Nodes from TestStand

Create/Update Custom Data Type from Cluster dialog box

Effectively Using LabVIEW NXG with TestStand

Expression Browser dialog box

LabVIEW NXG Advanced Settings Window

LabVIEW NXG Data Types in TestStand

Open File dialog box

Parameters Table Context Menu for Module Tabs

Configure Property Node dialog box

Select Module from Project dialog box

Select Module from DLL dialog box

Step Settings Pane

Update VI/LV NXG VI Calls dialog box

Updating Cluster Element Mapping

WAS THIS ARTICLE HELPFUL?

Not Helpful