HomeKurzweil 3000Kurzweil 3000 (General)Guide: MSI Deployment & Remote Installation - K3000 v14 (Win)

1.24. Guide: MSI Deployment & Remote Installation - K3000 v14 (Win)

Last Updated: June 2015

Applies to Versions: Kurzweil 3000 Windows Version 14 - Standalone, Network, Web License

These instructions do not apply to Kurzweil 3000 (K3000) v12 and K3000 v13. This article is written for system or network administrators attempting to create an enterprise-level silent installation/deployment of Kurzweil 3000.  Desktop technicians, teachers, or home users should conduct manual installations of the software.


Uninstall any older version of K3000 existing on your computers

Due to architecture changes in the K3000 v14 software, you cannot install K3000 v14 over previous versions (such as K3000 v13.x, v12.x, etc.). So if you have K3000 v13 installed on a computer, you must first uninstall K3000 v13 before installing K3000 v14.

All of K3000's MSI installers can also work as uninstallers if you pass the msiexec uninstall command switch (/x) to the MSI. For example, if you have K3000 v13 installed on your computers, you're looking at the following steps before you attempt to install K3000 v14:

1. Locate the K3000 v13 installer files on your distribution point (network share drive).

2. If you no longer have the K3000 v13 installer files, you can download them from here: https://www.kurzweiledu.com/k3000-previous-downloads.html

3. The command-line to silently uninstall K3000 v13 would be: msiexec /x "\\SERVERNAME\K3000InstallPackage\Software\Kurzweil 3000 v.13.msi" /qn /norestart

4. Deploy the uninstall job, ensuring that the older version of K3000 is uninstalled on the computer grouping.

5. Get ready to prepare your K3000 v14 silent install following the instructions below.


Download the K3000 software (don't use the DVD)

Use the latest downloadable build available from the link below. The downloadable build is always up-to-date, unlike printed DVDs. If you install from the copied contents of the DVD you may encounter installation errors following these instructions, as our installer archetecture is consistently updated by our engineers.

1. Download the latest build of Kurzweil 3000 (K3000) and use that to create your package.

The latest build of K3000 Windows Verison 14 can be downloaded here: http://www.kurzweiledu.com/k3win

The downloaded file is a self-extracting EXE.  The extracting process will create an InstallTemp[...] folder that contains the full contents of the Kurzweil 3000 v14 DVD.  To simplify instructions, rename the InstallTemp[...] folder that gets created to K3000InstallPackage.

2. Copy the K3000InstallPackage folder to your distribution point (i.e. a shared folder on your network, most likely hosted on a server in your data center).  All user groups will need at least read and execute permissions to this shared folder.


Before you can run a silent install (deployment) of K3000, you must first make sure that some Microsoft Visual C++ and .NET packages are already installed

A regular full UI install of K3000 (i.e. double-clicking the installer to run it) will automatically install the following Visual C++ and .NET packages if they're not already installed on the computer. Components from these packages are required to install K3000 properly. However, when the K3000 installer is run silently (e.g. a msiexec deployment made with a /qn switch) it cannot attempt to install these redistributables along with it. This means (if they're not already installed) you need to install the following redistributables prior to installing K3000 silently:

.NET 4.5.1 download: http://www.microsoft.com/en-us/download/details.aspx?id=40779

Command-line silent install for .NET:

<filename>.exe /q /norestart

C++ 2013 download: http://www.microsoft.com/en-us/download/details.aspx?id=40784

Command-line silent install for C++ 2013:

<path>\vcredist_x86.exe /install /quiet /norestart

<path>\vcredist_x64.exe /install /quiet /norestart

Warning: There's a third version of the 2013 Visual C++ redistibutable, the arm version which is made for Windows 8 tablets, and may be downloaded as part of an automatic update from the Windows Store. The arm version is not compatible with K3000. If this package is installed, make sure to uninstall it from the computer first.


Command-line silent installations

It's important that the Kurzweil 3000 v.14.msi be run from its shared folder ...\K3000InstallPackage\Software you created in an earlier step (that most likely exists on your distribution point), as it calls various resource files from its location during installation.  So keep the files and folders that "live with" Kurzweil 3000 v.14.msi in their relative location.  If Kurzweil 3000 v.14.msi is taken out of its location and run by itself it will not function. Restarting after installation is also not required.

Instructions:

Execute a Windows Installer (msiexec) installation via a command-line window (cmd.exe) or .bat script following the below parameters and examples listed in each table for whatever client type you are attempting to install.

If you want to perform a manual local test, because you're executing a silent (/qn) installation, you will not see a UI during installation. To monitor installation, you can observe the msiexec.exe process in Task Manager. The installation should be considered complete when:

a) All instances of the msiexec.exe process are no longer taking any CPU resources.
b) There is a Kurzweil 3000 shortcut created on the desktop.
c) There is an entry Kurzweil 3000 v.14 in Windows' installed programs.

Warning: If you want to perform a manual local test using Windows Vista or Windows 7 with User Account Control (UAC) enabled, make sure to Run as Administrator cmd.exe or the .bat file you execute.

Standalone Client Installation

Properties

Values

Description

AUTO

1

Required property value for silent installs.

EDITION

standalone

Determines the type of client that is installed.

Command-line example (single line):

msiexec /i "\\SERVERNAME\K3000InstallPackage\Software\Kurzweil 3000 v.14.msi" AUTO="1" EDITION="standalone" /qn /norestart

Note:

The Standalone Client will first function in Trial Mode for 30-days or until it is activated.  To activate, a user must run Kurzweil 3000 as an Administrator and complete an in-software registration chute requiring a serial number that starts with 31400[...].  This serial number is located on the packaging of the software.

 

Network Client Installation (this is a standard networked client)

Properties

Values

Description

AUTO

1

Required property value for silent installs.

EDITION

net

Determines the type of client that is installed.

SERVER

<IP address>

e.g.: 172.3.1.0

This is the internal static IP address of the computer where the Kurzweil 3000 Network Engine (the network licensing server) is installed.   The IP address of "172.3.1.0" is an example.

Command-line example (single line):

msiexec /i "\\SERVERNAME\K3000InstallPackage\Software\Kurzweil 3000 v.14.msi" AUTO="1" EDITION="net" SERVER="172.3.1.0" /qn /norestart

 

Network  Remote Client Installation (this is a non-networked take home client)

Properties

Values

Description

AUTO

1

 Required property value for silent installs.

EDITION

netpro

Determines the type of client that is installed.

Command-line example (single line):

msiexec /i "\\SERVERNAME\K3000InstallPackage\Software\Kurzweil 3000 v.14.msi" AUTO="1" EDITION="netpro" /qn /norestart

Note:

It is advised to not install Network Remote Clients remotely or through deployments.  The idea behind a Network Remote Client is to install Kurzweil 3000 on a user's home computer, where it will temporarily function without access to the Internet or a network connection.

After installation the Network Remote Client will not function until it is activated with a License-to-Go code.  You can generate License-to-Go codes from your Kurzweil 3000 Network Engine (your license server).  Generating such codes will "check out" the license from your server.

Warning: The Network Remote Client will only function when run by an Administrator.  Restricted users cannot run the Network Remote client.  On Windows Vista and Windows 7 computers, disable UAC before using a Network Remote Client.

 

Web License Client Installation

Properties

Values

Description

AUTO

1

Required property value for silent installs.

EDITION

web

Determines the type of client that is installed.

Command-line example (single line):

msiexec /i "\\SERVERNAME\K3000InstallPackage\Software\Kurzweil 3000 v.14.msi" AUTO="1" EDITION="web" /qn /norestart

 
Disabling Auto-Updates During Installation

By default, Kurzweil 3000 (any client type) will attempt to search for updates and install any updates it finds when launched by an Administrator on a computer.  This can be disabled during installation by adding the optional property value.

Properties

Values

Description

AUTOUPDATE

0

Optional.  Disables auto-updates.

 

1

Default value if not specified.  Kurzweil will check for updates and install any it finds each time it's launched by an Administrator.

Command-line example (Web License Client):

msiexec /i "\\SERVERNAME\K3000InstallPackage\Software\Kurzweil 3000 v.14.msi" AUTO="1" EDITION="web" AUTOUPDATE="0" /qn /norestart


Batch script (.bat) example (Web License Client):

@ECHO Installing Kurzweil 3000 Web Licensing from a shared folder on your network.  This may take upwards of 20 minutes.  Please wait...

@ECHO OFF

msiexec /i "\\SERVERNAME\K3000InstallPackage\Software\Kurzweil 3000 v.14.msi" AUTO="1" EDITION="web" /qn /norestart

exit


Group Policy, SCCM, Altiris, Dell KACE, ZENworks, PDQ, etc. – use Orca to modify the .msi; set the job so it caches the entire Software\ folder where the .msi resides

Kurzweil requires a certain set of property values to be passed to the .msi in order to install correctly.  These property values can be passed via command-line as noted in the above tables and examples.  However, when deploying through systems where these additional command-line switches may not be guaranteed to pass properly, it is recommended to directly modify these property values in the Kurzweil 3000 v.14.msi file's database Property table.  This way you can "bake in" everything to the .msi, so you can simply add the MSI to a job and it will install properly.  It also simplifies future redistrubtion of the .msi.

If you own a Windows server, it is recommended to download and install Orca to edit values in the database Property table of the Kurzweil 3000 v.14.msi file.

Orca is normally included in the Windows SDK.  For your convenience, we've included it as an attached download at the bottom of this article (scroll down).

Additionally, when setting up the job, it's important to cache the entire Software\ folder where the Kurzweil 3000 v.14.msi resides. This is because the .msi calls various resources from this folder, most importantly the .cab file. If you move the .msi out of this folder and run it, it will fail, as the relative links will be broken.

Instructions:

1. Download and install Orca.  Choose to do a Complete install.

2. Navigate to \\SERVERNAME\K3000InstallPackageK3000\Software\ and right-click > Edit with Orca the Kurzweil 3000 v.14.msi file.

3. Find the Property table (in the left column of Orca's GUI).

4. Rows for AUTO, EDITION, SERVER, and AUTOUPDATE are all found in the Property table (found in the table on the right side of the GUI).  Sort the Property table alphabetically so you can easily find the applicable fields.  Click in the applicable value fields to edit them.  Do not attempt to edit fields/values not specified within this article.

5. When entering values in to database fields, do not include "quotes" around each value like you would when passing Property values via command-line.  Edit the applicable values and then File > Save changes to the Kurzweil 3000 v.14.msi file.  Do not create a .mst file to apply the changes.

6. After saving the changes and exiting Orca, right-click > Edit with Orca the Kurzweil 3000 v.14.msi file again, go back to the Property table, and to verify that your changes took.

If you edit the file this way you do not have to worry about passing these property values during installation via command-line.


Installing the Acapela Voices

If you want extra high quality Text-to-Speech (TTS) voices and languages to use within K3000 v14, we recommend installing the Acapela high quality voices that are licensed for K3000 (they're free for you to download/install).

Note that K3000 will already come installed with high quality US English, Spanish, and French Canadian voices. Adding extra Acepla voices is entirely an optional step.

Instructions:

Step 1. Download the installers.

The installers for additional TTS voices are available on this page: http://www.kurzweiledu.com/k3win

The TTS Windows installers are packaged as self-extracting .exe files. The extracting process will create a folder named (for example) InstallTemp_AcapelaEnglishNonUSVoices_1400. This folder contains the full contents of a TTS installer.

Step 2. Copy the extracted folder to an applicable path on your distribution point, e.g.:

\\SERVERNAME\K3000InstallPackageK3000\InstallTemp_AcapelaEnglishNonUSVoices_1400\

Step 3. There are no special property values required to be passed to the TTS installers.

Command line example for a silent install without restarting:

msiexec /I "\\SERVERNAME\K3000InstallPackageK3000v14\InstallTemp_AcapelaEnglishNonUSVoices_1400\Acapela English Non-US Voices.msi" /qn /norestart

You can simply point your deployment job to the .msi


Installing the .msi patches/updates for K3000

If you have older versions of K3000 v14 installed, you may want to update the software (e.g. from v14.03 to v14.11) through installing a patch. We have .msi patches available that can can be installed silently.

You only need to install the latest patch to fully update K3000. For example, if you have v14.03 installed and want to update to the latest verison build (which at the time of writing this is v14.11), then you only need to install the v14.11 patch. You don't have to install the v14.04 patch, then the v14.05 patch, and so forth.

Instructions for silently installing the .msi patch can be found here: http://support.cambiumtech.com/index.php?pg=kb.page&id=1793

Knowledge Tags

Downloads

This page was: Helpful | Not Helpful