Running the installer on Windows

Use the Speech Suite setup wizard to install Nuance products on each designated host. Alternatively, you can configure a silent installation from a command line (see Running silent installations on Windows).

Note: For Windows Server Core, you must use the command line installer. There is no wizard.

Before you begin:

  • You must know which components you intend to install on this host. You do not need to install every component on every host. See Deployment architecture decisions.
  • You must ensure that each host has the necessary capacity for the components. See Required hardware and memory.
  • You must prepare the host with required software and configuration. See Configure hosts.
  • Recommended. If installing Management Station, ensure this host uses static IP addresses. (If you install it on hosts with dynamic IP addresses, ensure that your network can resolve the hostnames. For example, using ping.)
  • Recommended. If you are reinstalling Management Station and you do not want to reuse your existing databases, use the drop database command to remove them. Do this before running the Speech Suite installer.

Running the installer

To run the Speech Suite installer:

  1. Run the installer (.exe) as Administrator from the directory where you extracted the files.

    Optionally, you can write a setup log during the installation procedure:

    1. Open a command prompt session with the "Run as administrator" option.
    2. Change to the local directory that contains the Speech Suite installer.
    3. Execute one of these examples:

      start "" /wait "Nuance Speech Suite 11.0.exe" /debuglog (writes to InstallShield.log in current directory)

      start "" /wait "Nuance Speech Suite 11.0.exe" /debuglog"C:\temp\install.log"

  2. Review and accept the license agreement.
  3. Select the product features to install or install all features (default). Depending on your selections, the installer displays different options. The default installation path is C:\Program Files\Nuance\. For more path information, see Install paths and environment variables.
  4. Note: You can install License Manager, Management Station, and Nuance speech software on one host or on separate hosts. The speech software includes a collection of sub-components that are installed together (and you control which ones to run). For overviews, see Installed components.

The remainder of the procedure depends on the features you install. See the topics below.

Configuring the license

If you're installing the License Manager on this host, the installer prompts for the location of your Nuance license file.

Note: It's okay if you do not have your license at this time, but you must load a license later before running services. See Loading license files

Configuring Java

The installer detects your Java installation. Optionally, specify a different path (for example, if to use a Java installation in a different location).

For details, see Install third-party software.

Configuring the database

The installer asks for configuration details. Skip this procedure if not installing Management Station.

Management Station requires a database for storing the data it collects from managed hosts. The database can reside on the same host as Management Station or on a different host.

  1. Select the type of database (MySQL or SQL Server) to use for the Management Station mserver database.
  2. Enter the following information for connecting Management Station to the mserver database:
    • Server Name: Hostname or IP address where the database resides.
    • Server Port: Port reserved for the database. Default is 3306 (MySQL) or 1433 (SQL Server).
    • Database Name: Management Station database name. Default is mserver.
    • Instance Name (SQL Server only): Database engine instance specified during the SQL Server installation.

Configuring Management Station

The installer asks for configuration details. Skip this procedure if not installing Management Station.

  1. Enter the port@hostname pair of the host(s) running License Manager. The port is always 27000. For example, 27000@localhost.
  2. Select the path to the Apache Tomcat location.
  3. Verify the path and filename for the Connector/J JAR file. For MySQL, you install this file during the MySQL installation. For SQL Server, you download the file from the Microsoft website.
  4. Enter the username and password for the database admin account. The defaults are ms (username) and msp (password). The Management Station installation has character restrictions for database passwords. See the list of unsupported characters in Create a MySQL user account or Create a SQL Server Login.
  5. Note: For MySQL, your password policy might require a secure password for the Speech Suite installation to complete successfully. If you are using Management Station and you change the MySQL user account password after installing Speech Suite, you must update Management Station with the new password. See Changing database passwords in Management Station .

  6. Enter the username and password for the mserver database. The default account is ms (username) and msp (password). The Management Station installation has character restrictions for database passwords. See the list of unsupported characters in Create a MySQL user account or Create a SQL Server Login.
  7. Optionally, select the option to use an audit database, which logs all user actions in Management Station.

    If left unchecked, the audit database is not created and audit logging is disabled. You cannot enable it at a later time without re-installing Management Station. If you’re unsure, enable it now and then disable or re-enable it at a later time.

    To disable audit logging after installation, set AuditLogging to false in %MSTATION_HOME%\mserver\webapps\mserver\config\mserver_cfg.properties.

Configuring speech components

The installer asks for configuration details for the remaining speech software. Ignore it if only installing Management Station or License Manager.

  1. Enter the address:port pair for the Management Station host. (The hostname can be the hostname or IP address. The port number is always 8080.) If not using Management Station, accept the default value. (The installation will ignore the configuration.)

    Optionally, you can enter the address of an offline, standby Management Station. For example: mtl-venus:8080,mtl-mars:8080. The first entry is the primary and the second entry is the standby.

    Note: To change the Management Station address after installation, modify %NUANCE%\data\oam\mserver_hosts.txt and enter the address:port pairs on separate lines.)

  2. Browse to the directory containing the extracted packages for the Recognizer language, Vocalizer voice, and the data pack for Krypton and the Natural Language Engine.
    You do not have to select the executable files. The installation recursively scans the specified directory to find and run the executables.

    In the following example, the language and voice packages have been extracted and the executables are located in their own subdirectories under the Downloads directory:

    This example shows the path to the Downloads directory:

    Note: All packages in this location get installed. If, for example, you plan to run Recognizer and Vocalizer on different hosts, or use only one or the other, then put the language and voice in different directories.

  3. If using Management Station, select the option to run the Nuance statistics collector service on this host. The installer automatically detects the location of the Connector/C library (which is part of the database installation) and updates the PATH. Optionally, click Browse to select a different location.

Ready to install

Review the installation settings, begin the installation, and wait for the installation to complete.

Next steps

If installing Speech Suite on Windows Server 2019 Core or 2022 Core, reboot the system.

If using Management Station, see Testing installations with Management Station. (When you have Management Station you use it to control startups, restarts, and shutdowns of all Speech Suite services. You do not use operating system mechanisms such as Linux daemons or Windows services.)

If you are not using Management Station, see Starting services without Management Station.

If you are not using Management Station, you need to configure every speech software host in a distributed architecture for licensing. See Pointing products to a remote license manager.

Tip: For instructions on installing and configuring multiple languages and voices for Recognizer and Vocalizer on a separate dedicated host, see Adding languages and voices.