Easy Add-On Distribution with VI Package Manager

[David_L]

One of the most important steps in developing a LabVIEW add-on is creating an effective way to distribute and install the add-on.  However this is also one of the most overlooked steps in the process. Fortunately, distributing your add-on is extremely easy with the free VI Package Manager (VIPM) by JKI.

A VI Package is the file format (.vip) used for add-ons built by VIPM.  You can think of a package as a smart zip file: the package contains all the VIs and resources for a specific LabVIEW add-on, as well as instructions that enable VIPM to install, remove, and manage the add-on. Here are some more of the benefits of using VIPM as a distribution method:

Single File Installation

When you create a VI Package, all parts of your add-on are bundled into a single file (known as a package) including VIs, examples, documentation, palettes, etc.  This allows you to easily distribute your code to users without the chance of forgetting files.  Also, if your add-on is part of the LabVIEW Tools Network and you use VIPM for packaging, the add-on will automatically be included in the LabVIEW Tools Network VIPM repository. This means that customers will not even need a file to install your add-on.  All they need to do is open VIPM and browse to the add-on, or navigate to an install link that will automatically open VIPM and start the installation.

Multiple Version Support

If you need to distribute your toolkit for multiple versions of LabVIEW, you only need to develop it in one. During installation, VIPM will detect what versions of LabVIEW are installed and automatically compile the toolkit for that version of LabVIEW.  This means only one version of the installer is needed for all versions of LabVIEW.

File destinations

When VIPM installs an add-on, it places all of the different files into exactly the correct location that they need to be installed in.  This way your entire toolkit will plug into LabVIEW with the same user experience on every computer.  VIs, Examples, help documents and more will all seamlessly plug into LabVIEW without the customer having to know the details of where they should go.  Plus, the VI Package Manager will detect where LabVIEW is installed in case customers have LabVIEW installed in a non-default location.

Palettes

If your add-on has VIs or custom controls that need to be added to the functions or controls palette, you can use VIPM to automatically create custom palettes for your add-on. These palettes will then show up in the main functions/controls palette so the user can easily access and search all of the VIs in your add-on. 

Dependencies

If your add-on depends on other VIs or controls that are available on the LabVIEW Tools Network, you can use VIPM to automatically install required dependencies when your add-on is installed.  This way you do not have to explicitly include the necessary files that are already available on VIPM such as OpenG Libraries or the UI Control Suite.

Licensing

If you use the Third Party Licensing and Activation Toolkit for creating licensing and evaluation versions of your add-on, you can use VIPM to automatically license your library at build time and place the library and license file in the correct location at installation.  Note: build-time licensing requires the VIPM Professional Edition. 

Getting Started is Simple

Building your toolkit into a package using VIPM is easy.  For a step by step tutorial on how to build your first package, see the following video on the VIPM community portal:

Video Tutorial: How to Build Your First LabVIEW Add-on / VI Package

Useful Links

Download VI Package Manager

LabVIEW Add-on Dev Center

LabVIEW Tools Network

Contribute an Add-On to the Tools Network

Third Party Licensing & Activation Toolkit

JKI - VI Package Manager Community