Creating Packed Project Libraries with LabVIEW

Create a packed project library with LabVIEW to condense a LabVIEW project into a single file.

Note This build output requires Application Builder. LabVIEW Professional edition includes Application Builder. If you use another LabVIEW edition, you can purchase the LabVIEW Application Builder Module separately at ni.com.

Before creating packed project libraries with LabVIEW, do the following:

  • Create code to include in the packed project library you create, including a project library. Include the code in a project.
  • Prepare the source files for distribution.
  • Understand the specific caveats and recommendations for packed project libraries.
  • Save the project. To create a build specification, the project must be saved.
Prerequisites
LabVIEW Edition Requirements for Application Builder
Caveats and Recommendations for Packed Project Libraries
Preparing Files to Create a Build Output

This procedure describes the basic options to create this build specification. For details on each configuration option for the build specification, refer to the links for each page of the dialog box.

To use your LabVIEW project to create a packed project library, complete the following steps.

  1. In the Project Explorer window, right-click Build Specifications and select New » Packed Library.
  2. Required: Under Source Files, specify which project files to include in the distribution.
    1. Specify a single Top-level Library.

      This item must be a project library.

    2. Add support files to include in the packed project library with the Always Included listbox.
    Note You must add certain VIs to the Always Included listbox on the Source Files page in the following situations:
    Item When to Always Include
    Dynamically loaded VIs

    You can also distribute dynamically loaded VIs for an application by including them within a source distribution.
    Custom run-time menus If you save the custom run-time menu for a front panel control as a separate run-time menu file (.rtm).
  3. (Recommended) Under Information, name the packed project library and the build specification, and choose the highest-level save directory for the build product.
  4. (Recommended) Under Destinations, define the locations on disk for the main packed library file and any support files.

    Destination path defines the location of these files relative to the overall save directory for the build you specified in step 3.

    Note If you intend to include this distribution in an installer, specify the build output of the build specification relative to the primary destination of the build specification. For details, see Caveats and Recommendations for Building Installers with LabVIEW.
  5. (Recommended) Under Source File Settings, edit destinations and properties for the files and folders included in a packed project library.

    LabVIEW displays different options based on the type of item you select in Project Files.

  6. Optional: Under Additional Exclusions, configure options to leave out certain items from the distribution.

    Excluding items can reduce the size of the distribution or reduce memory usage.

  7. Optional: Under Connector Pane State, toggle whether caller VIs adapt to connector pane changes of the exported VIs without recompiling.
  8. Optional: Under Version Information, specify the version of the packed project library and provide metadata about your organization.

    For more information about setting versions, refer to Managing Application Versions.

  9. Optional: Under Pre/Post Build Actions, define VIs to run before or after the build.
  10. Optional: Under Advanced, configure debugging, logging, compatibility settings.
  11. Optional: Under Preview, generate a preview of the build to ensure that it appears as you expect.
  12. Apply any updated settings for your build specification by clicking OK.
    The dialog box closes and the build specification name appears in the project under Build Specifications.
  13. Build the distribution.
    OptionDescription
    Interactive
    • Right-click the build specification and select Build.
    • From the Package window, click Build.
    Programmatic Use the Build VI or the ExecuteBuildSpec command line operation.