Installing Kanzi Monitor¶
You can install Kanzi Monitor in two ways:
Extract the package for your platform to
<KanziWorkspace>/Engine/plugins/. The package holds themonitorfolder. This works on every platform.On Windows, run the installer (MSI). It installs the Win64 and Android packages into your Kanzi workspace for you, so that you can build for Windows and Android.
Both give you the same files in the same place. After installing, continue with Getting started with Kanzi Monitor.
Using the Windows installer¶
The installer is named after the Win64 package and is published next to it: kanzi_<X_Y_Z>-monitor_<version>-Win64-installer.msi. There is one installer for each Kanzi version, and it installs only into a workspace of that Kanzi version.
Before you start, close Kanzi Studio. When Kanzi Studio has Kanzi Monitor loaded, for example in the Preview, the installer cannot replace the plugin while it is in use.
To install Kanzi Monitor with the installer:
Run the installer. Windows asks for administrator rights.
Accept the license terms.
Choose the Kanzi workspace. The installer suggests the workspace of its Kanzi version, the one that the Kanzi installation set up, and you can choose another one.
The installer shows what it will install: the Kanzi Monitor libraries for Windows and Android, the tools, and the number of files. If the
Engine/plugins/monitorfolder of that workspace already has Kanzi Monitor files, for example from a package that you extracted, it also shows what it found and what it will do with it. Files that the installer also installs become part of the installation: uninstalling Kanzi Monitor removes them.Select Install.
The installer copies the Win64 and Android packages of its Kanzi Monitor version to <KanziWorkspace>/Engine/plugins/monitor/, unchanged, and adds the Kanzi Monitor plugin for Kanzi Studio to the Kanzi Studio plugins folder of its Kanzi version, as a shortcut. See Using the Kanzi Studio plugin.
The installer does not install into a folder that:
Is not a workspace of the installer’s Kanzi version. The installer reads the version from the
Engine/version.txtfile in the workspace.Already contains a different version of Kanzi Monitor that you extracted from a package. Remove that
Engine/plugins/monitorfolder first. Extracting other packages over it would leave files of the earlier version behind. Packages of the same version are fine: see Adding other platforms to an installed Kanzi Monitor.Has a path longer than 44 characters. Windows Installer cannot write the longest Kanzi Monitor file paths below a deeper folder.
The installer also does not install while Kanzi Studio already has a Kanzi Monitor plugin that the installer did not put there: a shortcut to the plugin of another Kanzi Monitor package, a second shortcut to the plugin, or a copy of the plugin DLL. With two Kanzi Monitor plugins, Kanzi Studio shows every Kanzi Monitor menu item twice. The installer looks in the Kanzi Studio plugins folder of its Kanzi version, %ProgramData%RightwareKanzi <KanziVersion>plugins, and in your own, %APPDATA%RightwareKanzi <KanziVersion>plugins, which Kanzi Studio also loads plugins from. It cannot look in the folders of other Windows users. Remove that shortcut or copy first. In the %ProgramData% folder, a shortcut that File Explorer made to the plugin in the chosen workspace, named KanziMonitorStudioPlugin.dll - Shortcut.lnk, is fine: the installer replaces it with its own. So is a shortcut whose target no longer exists.
The installer tells you the reason in each case.
Upgrading and uninstalling¶
To upgrade, run the installer of a later Kanzi Monitor release for the same Kanzi version. It installs into the same workspace without asking, and removes the files of the earlier release that the new one no longer has. The installer does not install an earlier release over a later one.
To repair, run the installer again and select Repair. It restores the files that it installed, in the same workspace.
For another Kanzi version, run the installer for that version. Installations for different Kanzi versions are separate: each one has its own workspace, and you upgrade and uninstall each one on its own.
To uninstall, in Windows Settings > Apps > Installed apps, uninstall Kanzi Monitor <version> for Kanzi <Kanzi version>. This removes the files the installer copied, and leaves any files that you added to the
monitorfolder.This includes build output, for example from building the example project in
monitor/examples. Android and CMake builds create paths longer than Windows Explorer can delete. To delete such a folder after you uninstall Kanzi Monitor, close the applications that use it and run this in a command prompt:rd /s /q "\\?\C:\KanziWorkspace_<X_Y_Z>_<build>\Engine\plugins\monitor"
If the folder is still in use, stop the Gradle daemon first, for example with
gradlew --stopin the Android project.
Close Kanzi Studio before you upgrade or uninstall Kanzi Monitor, as before you install it.
Adding other platforms to an installed Kanzi Monitor¶
The installer installs Kanzi Monitor for Windows and Android. To build for other platforms, such as Linux, from the same workspace, extract the package of that platform for the same Kanzi Monitor version to <KanziWorkspace>/Engine/plugins/, as you do without the installer. You can do this before or after you install Kanzi Monitor with the installer.
The installer does not install or remove those packages’ files:
When you upgrade, the other platforms keep their earlier version. After the upgrade, extract their packages of the new Kanzi Monitor version again.
When you uninstall, the files of the other platforms stay in the
monitorfolder, but the files they share with Kanzi Monitor for Windows and Android are removed. To use those platforms again, extract their packages again, or delete the folder.
Before it changes anything, the installer shows the other platforms that it found and what it will do with them. It does this for an install and an upgrade, and when you run the installer again and choose Repair or Remove. When something is left for you to do after an install or upgrade, such as extracting a package again, the last page says so. A silent install, repair or uninstall writes all this to the installer log only.
Installing from the command line¶
To install without the installer’s dialogs, run this in a command prompt that runs as administrator:
msiexec /i kanzi_<X_Y_Z>-monitor_<version>-Win64-installer.msi WORKSPACEDIR=C:\KanziWorkspace_<X_Y_Z>_<build> /qn /norestart
Keep /norestart: without it, an install that cannot replace a file in use can restart Windows without asking. Give the workspace path without a trailing backslash. If you leave out WORKSPACEDIR, the installer uses the workspace it would suggest. A silent install closes any application that has Kanzi Monitor files in use, so close Kanzi Studio first.