Create an installer with LabVIEW to bundle source files into an executable that provides a complete installer experience for end users.

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.
Note NI recommends using packages to distribute build objects instead of installers. Use installers only if you need the unique functionality of installers.

Before creating installers, do the following:

  • Create code or other build outputs to include in the installers you create. Include the code in a project.
  • Understand the specific caveats and recommendations for installers.
  • Prepare the source files for distribution.
  • Save the project. To create a build specification, the project must be saved.
Prerequisites
LabVIEW Edition Requirements for Application Builder
Caveats and Recommendations for Building Installers with LabVIEW
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 an installer, complete the following steps.

  1. To ensure that the LabVIEW Runtime can load all VIs in the installer, include compiled code with all VIs:
    1. In the Project Explorer window, right-click the project and select Properties or select Project » Properties.
    2. Under Project, click Mark Existing Items..., select the VIs in the project, and select Unmark Selected Items.
  2. In the Project Explorer window, right-click Build Specifications and select New » Installer.
  3. (Recommended) Under Destinations, define the directory structure on target machines that you want the installer files to map to.
    Note You cannot rename directories that Destinations represents with brackets around the name.
  4. Required: Under Source Files, specify which project files to include in the installer and assign the target directories for those files.
    The Destination View tree specifies the location and directory structure of the files in the installer when you install them on a system. Destination View reflects the directory structure you can define in step 3.
  5. (Recommended) Under Source File Settings, set attributes for the files you include in the installer.
  6. (Recommended) Under Product Information, name aspects of the installer and define the location to build the installer.
  7. (Recommended) Under Version Information, specify the version of the installer, provide metadata about your organization, and define whether the installer should replace prior versions.

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

  8. Optional: Under Additional Installers, define any other installers that your installer needs to include.
    You can include recommended installers or define custom installers to include.
    Notice When you add an NI product installer to the installer build, you are adding only the components of the installer that you installed on the computer you are using. When users run the installer you built, the installer might remove components of the product from the user computer that are not part of the installer. To minimize the risk of removing product components on user computers, ensure you have a complete and up-to-date installation of the product on the computer you are using, including all optional components, before you add the product installer to the build.
    • Include recommended installers (default): Place a checkmark in Automatically select recommended installers.
    • Manually define additional installers: Uncheck Automatically select recommended installers and define the installers to include.

      For information on the additional installers you can manually define, refer to Additional NI Installers for Installer Builds.

    • Cache installers locally to reduce prompts during future builds: Place a checkmark in the To minimize media prompts while building your installers, copy the selected installers and all future installers to this computer.

    For example, this option allows you to bundle a compatible version of the LabVIEW Runtime with your installer.

  9. Optional: Under Dialog Information, define the dialog boxes for the installation experience.
  10. Optional: Under Hardware Configuration, choose whether the installer includes configuration information for NI hardware on your system.

    Use this option to propagate a specific hardware configuration to the systems that consume your installer.

  11. Optional: (Windows) Under Shortcuts, define shortcuts to add to the Startup menu if you want your application to run as soon as the system starts up.

    You can also add a shortcut to the Desktop or Program Menu on Windows. By default, LabVIEW adds a shortcut in the Windows Program menu for each application included in the package.

  12. Optional: (Windows) Under Windows Security, configure the digital signature for install.exe when the installer runs.
  13. Optional: (Windows) Under Registry, define custom registry keys for the installer build.

    Use this option if your code relies on specific registry keys and you want the installer to preconfigure this configuration.

  14. Optional: Under Advanced, configure specific settings like system requirements, settings for physical installation media, and more.
  15. Optional: To include any LabVIEW Web services with the distribution, add the service under Web Services.
  16. 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.
  17. 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.