SystemLink API Installation for LabVIEW

Updated Jun 24, 2019

Reported In

Software

  • LabVIEW
  • LabVIEW NXG
  • LabVIEW NXG Web Module
  • SystemLink Client
  • Package Manager

Issue Details

I see that the SystemLink API is a method for me to communicate data between my LabVIEW VIs and WebVIs in LabVIEW NXG, but I can not seem to find it in my LabVIEW functions palette even after I have installed LabVIEW NXG and the Web Module.

I would also like to use the SystemLink API to write and read tag data from my SystemLink server. 

How do I get the SystemLink API installed in LabVIEW?

Solution

The SystemLink API for LabVIEW installs with an installation of the LabVIEW NXG Web Module or the SystemLink Client .  The installation order is important to get the SystemLink API to show up in LabVIEW.  Below are instructions for installing the SystemLink API if you are doing a fresh install and if you already have all the software components installed.
 

Fresh Install

The recommended installation order if you are starting off on a fresh install is as follows:
  1. Install NI Package Manager.
  2. Install LabVIEW and follow any restart prompts.
  3. Open NI Package Manager and search for LabVIEW NXG Web Module or SystemLink Client, whichever you are working with.  Click on the correct result and then click Install.
  4. Make sure that you select all of the SystemLink API items that you want to have installed.
    • Available SystemLink Items for LabVIEW NXG Web Module:  Message and Tag 
    • Available Skyline Items for SystemLink Client: File, Message, Tag, and Test Monitor
  5. Continue through the installation wizard. After finishing, you should be able to see the installed SystemLink VIs in LabVIEW.
 

LabVIEW NXG Web Module or SystemLink Client Already Installed

If you already have LabVIEW NXG Web Module or the SystemLink Client installed before you have LabVIEW installed, you can follow the below steps to install SystemLink support for LabVIEW:
  1. Open NI Package Manager (NIPM).
  2. Click on the INSTALLED tab.
  3. Find NI SystemLink Client or LabVIEW NXG Web Module.
  4. On the further right column, there should be a cog/gear.  Click on that icon to Install or remove related package.
  5. Make sure the following items are selected in order to use the SystemLink API within LabVIEW:
    • NI SystemLink File Support for LabVIEW 20XX
    • NI SystemLink Message Support for LabVIEW 20XX
    • NI SystemLink Tag Support for LabVIEW 20XX 
    • NI SystemLink Test Monitor Support for LabVIEW 20XX
  6. Continue through the installation wizard.
 

Install using the Packages tab

If you have already installed either the LabVIEW NXG Web Module or the SystemLink Client packages, you will be subscribed to those package's Feeds so that you can be alerted of package updates. In this case, you can install the SystemLink API from the Packages tab, which is hidden by default:
  1. Click on the Settings (Gear) icon.
  1. Check the box Show available packages and feed management tools
  2. Go to the PACKAGES tab and select the NI SystemLink Support for LabVIEW item that you need.

Additional Information

NI Package Manager needs to be installed in order to search for and install the SystemLink Client or the LabVIEW NXG Web Module.

A small subset of the SystemLink API is installed with FlexLogger, but for the full API, you will need to install the SystemLink Client from NI Package Manager.

It is not necessary to install LabVIEW NXG on the LabVIEW development computer in order to use the SystemLink API for LabVIEW via the LabVIEW NXG Web Module.

It is not necessary to install NI SystemLink Server on the LabVIEW development computer in order to use the SystemLink API for LabVIEW via the SystemLink Client Add-On.

WAS THIS ARTICLE HELPFUL?

Not Helpful