Building Packages in VIPM 2010

This page serves as documentation for how to upgrade OpenG Library sources for packaging in VIPM 2010. Along with upgrading to VIPM 2010, this OpenG 4.x version will be bought up to LabVIEW 2009. The OpenG File Tools package will be used as an example.

Initial Setup

 * Look at the dependencies of the 3.x version of the package (this can be found in the Package Info dialog of VIPM for the 3.x package or in the "build rules\package.ogpb" file under the Dependencies section). Ensure that all these packages are installed in VIPM for LabVIEW 2009 -- this will allow you to open and develop the package sources.
 * The package VIs are located in a folder named ".\source\library" -- use this as the VI Package Source Directory.
 * Name the Project's "Product Name" the same as the current "Palette Name". The "Company Name" is OpenG.org.

Build Information

 * Set "Major" Version Number to 4 (the others should reset automatically to 0, except for the Build).
 * Enter Release Notes that reflect: 1) "* Package sources upgraded to LabVIEW 2009 (package now compatible with LV2009 or greater)." 2) "* Package build with VIPM 2010.". Also add any bug-fixes or new features in the release.



Display Information

 * Set the Legal Copyright to the value of Copyright from the package.ogpb file (3.0 package build spec).
 * Set License Agreement Name to "BSD".
 * Set Author Name to "OpenG".
 * Set "Product Icon" (easiest way is to install OpenG File Package and then edit it's icon and copy it to the clipboard, then edit the "Product Icon" and paste it). When VIPM asks if you want to use this new icon for both Controls and Functions palette, say "Yes".
 * Set the "License Agreement Text File Location" to ".\docs\License Agreement.txt". Note: This requires VIPM 2010 Professional.



Palettes

 * Create a "Custom Category" named "OpenG" using the OpenG Icon located in the OpenG Toolkit project: " \source\images\openg.png".
 * "Browse" for the OpenG Functions Palette located under "Functions". When the package installs its palette files, they automatically appears under the OpenG palette.
 * In this example, OpenG File Tools does not have a Control Palette so it has been removed.




 * Configure the palette as per the current package. This will have to be done manually (it is recommended that you open LabVIEW and load the current palette to help with copying it).




 * VIPM 2010 allows you to easily add LabVIEW primitives to the palettes using a text search.





Destinations

 * Configure the Destinations - check the package.ogpb file (3.0 package build spec). In this example the Library VIs will be installed into "\_OpenG.lib\file\file.llb" where "file.llb" is treated as a directory (rather than an actual .llb).



Source File Settings

 * Configure the Source File Settings - check the package.ogpb file (3.0 package build spec). In this example, all VIs will go into the above created directory. VIs are namespaced with the suffix "__ogtk".



Dependencies

 * Scan for Dependencies (this will update the .vipc file with all the required source dependency packages). Note: This requires VIPM 2010 Professional - however, in the Community edition you can add dependencies manually - check the package.ogpb file (3.0 package build spec) and copy from there.
 * Manually add the dependency on "ogrsc_dynamicpalette >=0.19" (the "OpenG Dynamic Palette View" package).





Install Requirements

 * Set the Operating System and LabVIEW Versions from the package.ogpb file (3.0 package build spec).



Custom Actions

 * Set Pre-Build VI to ".\build support\Pre Build Utility - Run Unit Tests.vi". This will ensure that the unit tests get run before the build is allowed to proceed. Note: This requires VIPM 2010 Professional.



Package Filename

 * Edit the VI Package Output Filename, such that it matches the OpenG convention (e.g. "oglib_file").
 * Note: The 3.x package had an extension .ogp, the 4.x package has an extension .vip however, VIPM 2010 is smart as it allows this change to be consider an upgrade and not a new package.