Create a New VIPM Package to install a Blue Custom Step

This guide is part 3 of 4. Part 1 is creating an initial class and override VI. Part 2 is writing the scripting code for your step using TDD. This part, part3 is creating a vipb buildspec and building a package to install your custom step.

Sam Taggart
16 steps
4 minutes

Scribe for Windows

Windows Explorer

In order for Blue to find your custom step, it first has to be in the right location (this guide) and then you have to create a blue-steps.json file (the next guide).

In the VIPM GUI open the window drop down and select Show VI Package Editor

Select New

Point the Source Directory at the Directory that include your custom step class.

Give your package an appropriate name.

Then click ok.

Fillout the Build Information, Display Information, and Description tabs as neeeded. \ \ The source directory should already be correct. The build output directory is worth paying attention to as that is where your built package will end up. You can adjust it as needed\ \ The rest of the info in these tabs just determines what information is shown in VIPM when someone looks at your package. If you are going to distribute it, the license is worth paying attention to, otherwise everything else is mostly cosmetic and you can change it later.

You can uncheck the functions pallette - we won't need that.

Under Destinations, be sure to set the Toolkit VIs path to SAS/blue/My Custom Step and replace My Custom Step with the name of your class. This is important. In order for Blue discover your class it has to be in a folder of the same name as the class inside the Steps folder.

This next step is optional. Blue will still find your class if you don't add the prefix. However the prefix helps to prevent crosslinking, so I highly recommend it. The prefix does need to be "lib\_" if you are going to add one. Only add it to the class file.

Goto to the destination page and highlight your .lvclass file. Check the box to enable renaming and rename the class file by adding a lib\_ prefix.

The rest of the settings should be fine the way they are, but feel free to edit them if needed. When done save your vipb file next to your lvproj file.

An useful exercise is to add a prebuild action that runs your unit tests before you build and aborts the build if they fail, so you don't have to manually remember to run them every time you build your package. It's pretty trivial. I'll leave that as an exercise for the reader (can't give away all my secrets).

Once saved, then you can build.

Click ok to dismiss the launching LV warning.

When done open the package in VIPM.

Now you can install it.

Once installed you can close VIPM

Doublecheck that everything was installed in the correct place by navigating to vilib/SAS/blue/Steps You should find a folder with the name of your class. Inside should be the class file with the lib\_ prefix and the Format Core override VI.\ \ Now you are ready for the next guide - how to tell Blue about your Custom Step.