Custom executes are executables or batch scripts that can be run during a package transaction.
There are six types of custom executes:
Root is the root directory where the custom execute will be located. A relative path from the root to the executable can be specified in the relative executable path. The relative executable path is either just the executable name, if the executable is located immediately under the root, or a relative path from the root to the executable.
Root: [Program Files (64-bit)] Relative Executable Path: foo.exe
Typical path: C:\Program Files\foo.exe
Root: [Program Files (64-bit)] Relative Executable Path: relative\path\foo.exe
Typical path: C:\Program Files\relative\path\foo.exe
Every custom execute can define arguments to be passed into the executable. These can be literal arguments or macros surrounded by the % character.
Macros will be replaced when invoking the custom execute. In the example below, the path to the public desktop replaces %desktop% and a 1 or a 0 replaces %rebootpending%, indicating whether the package will require a reboot to install properly.
-open %desktop%\file.txt -reboot %rebootpending%
Refer to Installation Target Roots for File Packages in the NI Package Manager manual for a list of supported directory macros.
Surround an argument with quotations if it contains any spaces. In the example below, the executable reads the path 'C:\path with spaces\' as one argument instead of three separate arguments.
-open "C:\path with spaces\"
You can select the following three custom execute options within the Custom Execute dialog:
If two or more installed packages define custom Post All executes with the same executable name and arguments, NI Package Manager will only invoke one of them.
Call cmd.exe and specify the /c option within a custom execute to invoke a Windows CMD shell. The custom execute invokes the specified command/executable program passed as an additional argument.
Root: [System (32-bit)] Relative Executable Path: cmd.exe Arguments: /c "%Temp%\MyTempFile.bat"
Calls a batch file installed by the package to the [Temp] directory.
Root: [System (32-bit)] Relative Executable Path: cmd.exe Arguments: /c ""%Program Files_64%\MyTempFile.bat" "parameter 1" "parameter 2""
If NI Package Manager cannot locate the executable specified by the root and relative path, it displays the following error message:
An error occurred while installing package 'package-name'.
To debug the executable, configure the custom execute to call cmd.exe and specify the path to the executable in the argument. When calling cmd.exe, enable the 'Show Console Window' option, and specify /k instead of /c to see any status reports from cmd.exe. Enter the exit command to close the console window when debugging with the /k option.