How To Deploy an NI-XNET Database to a Real-Time Target

Updated Oct 5, 2026

Environment

Software

  • LabVIEW

Driver

  • NI-XNET
  • NI-XNET Database Editor

Operating System

  • LabVIEW Real-Time (NI Linux Real-Time)

This document describes how to properly deploy an XNET database to an NI Real-Time (RT) target. It highlights the main options for deployment and the detailed steps for each method.

There are several ways to deploy an NI-XNET database to an RT target:
 

  • Through the NI-XNET Database Editor
  • Using the LabVIEW environment
  • Programmatically using the NI-XNET API

 
Deploying Through NI-XNET Database Editor 

  1. Please make sure that you have NI-XNET Database Editor installed. In the newer versions, it is a part of the NI-XNET driver and does not have a standalone installer. Please see How to Install the NI-XNET Database Editor. 
  2. Open the NI-XNET Database Editor and navigate to View>> Alias Manager, or click Manage Aliases in the Start section of the main window.  
  3. In the Local Aliases section, click the cluster icon at the right of an empty row to open the Open Database window.
  4. Use the Open Database Explorer window to locate a database file you want to add.
  5. Select the database file, and click Open.
  6. In Local Aliases, click the add symbol (+) to add a new row to the bottom of the list.
  7. To add an alias for an RT target, you must first provide the target hostname or IP address and valid connection credentials in the appropriate fields, and then click Connect. Once connected, click Deploy Alias to select a database to deploy.

     

          Figure 1. Alias Manager in NI-XNET Database Editor

 

Deploying manually using LabVIEW

  1. Add your RT target to your LabVIEW project using the steps from Adding RT Targets to a LabVIEW Project 
  2. Right-click your target and click Connect
  3. Create a VI under the RT target and add an XNET Create Session VI on the block diagram
  4. All of the types of the XNET Create Session VI (Except XNET Create Session (Generic) VI) have an input to specify the names of the signals or frames in your database. The input names differ based on the XNET Create Session type. Those names can be: cluster (:memory:) ; Frame ; Frame List ; Signal List ; PDU ; PDU List , but if you create a constant or control of those inputs, you will see an option called Manage Database Deployment on each of them.


    Figure 2. Manage Database Deployment option on Front Panel or Block Diagram

In the appeared Manage NI-XNET Databases window make sure that the IP target of your device is correct, select the database you want to deploy from your computer and click the Deploy button. The deployed database will appear under XNET Databases of RT Target.


Figure 3. Manage NI-XNET Databases window
   

Deploying Programmatically

The XNET Database Deploy.vi function programmatically deploys database files onto RT targets. It is located in the LabVIEW functions palette under Measurement I/O >> XNET >> Database >> File Mgt >> XNET Database Deploy.vi. 

To see an example of programmatically deploying where XNET Database Deploy.vi, function is used, please refer to Managing RT Databases.vi in NI Example Finder. To find it, navigate to the Help tab in LabVIEW and select Find Examples >> Hardware Input and Output >> CAN >> NI-XNET >> Databases (Editing and Managing) >> Managing RT Databases.vi.