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

1.22. Guide: MSI Deployment & Remote Installation - K3000 v15 (Win)

Last Updated: June 2016

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

This article is written for system or network administrators attempting to create an enterprise-level silent installation/deployment of Kurzweil 3000 (K3000).

Step Summary:

1. Uninstall any older version of K3000 on the computers

2. Download the latest full build installer for K3000 v15, don't use the DVD

3. Extract and copy the K3000 installation files to your distribution point

4. Install Visual C++ and .NET dependencies before K3000 v15

5. Install K3000 v15 from the MSI

6. Testing the MSI

7. Install Acapela Voices

Additional Info:

- How to install future MSI patches for K3000

- How to use Orca to modify MSI files to "bake in" property values instead of command-line arguments

1. Uninstall any older version of K3000 on the computers

For K3000 v15 to install properly, you must first uninstall any older version of K3000. For example, if you have K3000 v14 installed, you must uninstall K3000 v14 first before installing K3000 v15.

All of K3000's MSI installers can also work as uninstallers if you pass the msiexec uninstall command switch /x to the MSI.

If you still have your K3000 v14 installation files on your distribution point, you can use those to uninstall K3000 v14; you would need K3000 v13 installation files to uninstall K3000 v13, etc.

Steps:

1. Locate the K3000 v14 installation files on your distribution point (network share drive).

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

3. The command-line to silently uninstall K3000 v14 would be:
msiexec /x "<path to K3000 v14 installation files>\Software\Kurzweil 3000 v.14.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 v15 silent install following the instructions below.

2. Download the latest full build installer for K3000 v15, don't use the DVD

We release a new build of K3000 v15 (i.e. an updated version) at the beginning of each month. It's always recommended to install from the latest downloadable build, because the build on the DVD is often outdated.

Download the latest build of K3000 v15 from here: https://www.kurzweiledu.com/k3win

Make sure to download the correct edition, e.g. if your organization purchased the Web License edtion, make sure to download that; don't download Standalone if you need to install Web License.

3. Extract and copy the K3000 installation files to your distribution point (network share)

The downloaded file is a self-extracting EXE. Running or extracting the EXE will create an InstallTemp[...] folder that contains the installation files for the latest full build of K3000 v15. To simplify instructions, rename that InstallTemp[...] folder to K3000v15.

Copy the K3000v15 folder to a distribution point, usually a shared folder or drive, on your network.

4. Install Visual C++ and .NET dependencies before K3000 v15

A regular full UI install of K3000 (i.e. double-clicking Setup.exe file and following the GUI prompts) will automatically install the following Visual C++ and .NET redistributables if they're not already installed on the computer; however, when the K3000 installer is run silently (i.e. a msiexec deployment made with a /qn switch) it does not install these redistributables.

The following redistributables must be installed before doing a silent MSI install of K3000:

Microsoft .Net Framework 4.0 Full

Download: https://www.microsoft.com/en-us/download/details.aspx?id=17718

Silent install command-line example:
<filename>.exe /q /norestart

General info regarding deployment: https://blogs.msdn.microsoft.com/astebner/2010/05/12/silent-install-repair-and-uninstall-command-lines-for-the-net-framework-4/

How to create and install as a MSI: https://blogs.msdn.microsoft.com/astebner/2010/06/04/how-to-create-an-administrative-install-point-for-the-net-framework-4/

Microsoft .Net Framework 4.0 Full Update KB2468871

Download: https://www.microsoft.com/en-us/download/details.aspx?id=3556

Microsoft Visual C++ 2013 Redistributable Package x86 & x64

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

Microsoft Visual C++ 2013 Redistributable Package x86 (required for both 32-bit and 64-bit OSes)
Microsoft Visual C++ 2013 Redistributable Package x64 (required for 64-bit OS only, must be installed after the x86 package)

Silent install command-line example:
vcredist_x86.exe /install /quiet /norestart
vcredist_x64.exe /install /quiet /norestart

How to create and install as a MSI: http://www.applepie.se/visual-c-2013-silent-install-and-msi

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 computers first.

5. Install K3000 v15 from the MSI

In step 3, you extracted the installation files to a K3000v15 folder and copied it to your distribution point. Keep the files together in their relative location in the K3000v15 folder, with the path to the MSI being <path to distribution point>\K3000v15\Software\Kurzweil 3000 v.15.msi

Remember to install the correct edition of the software. So if your organization owns the Web License edition, use the command-line properties for Web License.

Standalone Edition

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 "<path to distribution point>\K3000v15\Software\Kurzweil 3000 v.15.msi" AUTO="1" EDITION="standalone" /qn /norestart

Note:

The Standalone edition in order to be usable must be activated on each computer after installation. This can be accomplished by completing a registration chute within the K3000 software after installation. Registration requires a serial number (the serial number should start with 31500...)

 

Network Edition - Standard Network 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 "<path to distribution point>\K3000v15\Software\Kurzweil 3000 v.15.msi" AUTO="1" EDITION="net" SERVER="172.3.1.0" /qn /norestart

 

Network  Edition - Remote/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 "<path to distribution point>\K3000v15\Software\Kurzweil 3000 v.15.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.

 

Web License Edition

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 "<path to distribution point>\K3000v15\Software\Kurzweil 3000 v.15.msi" AUTO="1" EDITION="web" /qn /norestart

 
Disabling Auto-Updates During Installation (Optional)

By default, Kurzweil 3000 (any edition) 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

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 Edition):

msiexec /i "<path to distribution point>\K3000v15\Software\Kurzweil 3000 v.15.msi" AUTO="1" EDITION="web" AUTOUPDATE="0" /qn /norestart

6. Testing the MSI

Before you create a deployment, you may want to test the installer manually.

1. Run cmd.exe (right-click > Run as Administrator if UAC is enabled on the computer)

2. Excecute a Windows Installer (msiexec.exe) installation via a command-line example above.3. To monitor installation, you can observe the msiexec.exe process in Task Manager.

3. 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.15 in Windows' installed programs.

You can also test by running a batch script (.bat) file.

Batch script example (Web License Edition):

     @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 "<path to distribution point>\K3000v15\Software\Kurzweil 3000 v.15.msi" AUTO="1" EDITION="web" /qn /norestart

     exit

7. Install Acapela Voices

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

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

Instructions:

1. Download the installers.

The Acapela voice installers can be found here: http://www.kurzweiledu.com/k3win

The installers are packaged as self-extracting EXE files. Running or extracting the EXE will create a folder named (for example) InstallTemp_AcapelaEnglishNonUSVoices_1500 containing the installation files. Feel free to rename the folder.

2. Copy the folder to your distribution point.

3. There are no special property values required to be passed to the Acapela voice MSI installers.

Command line example for a silent install without restarting:

msiexec /i "<path to distribution point>\AcapelaEnglishNonUSVoices_1500\Acapela English Non-US Voices.msi" /qn /norestart

How to use Orca to modify MSI files to "bake in" property values instead of command-line arguments

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.15.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.15.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).

Instructions:

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

2. Navigate to <path to distribution point>\K3000v15\Software\Kurzweil 3000 v.15.msi and right-click the MSI > Edit with Orca.

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.15.msi file. Do not create a .mst file to apply the changes.

6. After saving the changes and exiting Orca, right-click the MSI file > Edit with Orca 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.

How to install future MSI patches for K3000

If you have older versions of K3000 v15 installed, you may want to update the software (e.g. from v15.01 to v15.04) 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 v15.01 installed and want to update to the latest verison, which at the time would be v15.04, then you only need to install the v15.04 patch. You don't have to install the v15.02 patch and then the v15.03 patch.

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