Upgrading Speech Suite software for version 11.0.3 or earlier

To upgrade Speech Suite software, run the Speech Suite installer on each host in one of the following ways:

  • Standard upgrade: Use the installer interface to perform a manual upgrade.
  • Silent upgrade: Use the command line to configure a silent upgrade. For example, use a script.

You do not need to stop or restart services. The installer does this automatically during the upgrade. The installer does not upgrade data packs. To install new data packs, see Managing data packs.

If you need to upgrade the database software, it's best to perform the database upgrade before upgrading Speech Suite. See Upgrading database software.

Note: Schedule the upgrade to run during a time when system use is low to minimize potential impact on callers. Nuance recommends that you upgrade clusters in a single maintenance window, if possible. Otherwise, schedule your maintenance window so that you have enough time to upgrade an entire cluster during each window.

Upgrade compatibility details

This section is for 11.0.3 and earlier. For 11.0.4 and later, see Upgrading Speech Suite software for version 11.0.4 or later.

You can upgrade from Speech Suite 11.0.4 (and later) to this release. You cannot upgrade directly from any other version.

If you are upgrading from 11.0.3 or earlier, the upgrade procedure does not preserve your custom configurations. Operators should back up the system before the upgrade and restore values to individual parameters after the upgrade. You cannot restore whole configuration files because the new release might contain new parameters.

If upgrading from 11.0.4 or if you have an earlier version, you must remove all engines from the Zookeeper database before installing this release: remove all entries under these folders: /Engines/KRYPTON, /Engines/NLE, /Engines/NTPE. You can do this manually with the Zookeeper client.

Required change for NLE service startup on Linux

If upgrading from 11.0.3 or earlier, you might need a small, but important, change when starting NLE from the command line. This change is relevant to all users of Dragon Voice on Linux systems with no Management Station. You must add a final / symbol to the classpath:config/ value in the NLE startup command. If the command line syntax is not updated, the NLE service stops unexpectedly. For example:

> su -s /bin/bash nuance -c '$NLE_HOME/bin/start.sh 9091 --spring.config.location=classpath:config/, file:$NUANCE_DATA_DIR/system/config/User-nle01.properties config.LoggingLevel=STATUS watcher.SendAlarmsToWatcher=FALSE'

Required change for Dragon Voice

At least one data pack is required. If you are upgrading from 11.0.4 or earlier, you must uninstall version 3.x data packs and install the version 4.x data packs.

Required changes for the NLP service

If upgrading from 11.0.3 or earlier, note that these NLP service properties are renamed to support HTTPS security among services:

Property name in previous releases New property name as of 11.0.5

resourceManager.httpClient.requestTimeout

httpClient.requestTimeout

resourceManager.httpClient.followRedirects

httpClient.followRedirects

resourceManager.httpClient.maxRedirects

httpClient.maxRedirects

resourceManager.httpClient.hostNameVerificationEnabled

httpClient.hostNameVerificationEnabled

resourceManager.httpClient.keystore

httpClient.keystore

resourceManager.httpClient.keystorePassword

httpClient.keystorePassword

resourceManager.httpClient.truststore

httpClient.truststore

resourceManager.httpClient.truststorePassword

httpClient.truststorePassword

Required changes for the Management Station

If you are upgrading Speech Suite 11.0.3 or earlier and are using Management Station, you must reassign all current role files (those role files in use before the upgrade) that contain the Nuance Resource Manager, Krypton, Natural Language Engine, or Nuance Text Processing Engine services, and manually reapply the changes to the custom role files. Do this after the upgrade, and before starting services. If the commands are not updated, services will fail to start after this upgrade. See the Speech Suite documentation topic called "Reassigning role files" for instructions.

Note: If upgrading from 11.0.3 or earlier and you have many role files, or large and complex role files in a distributed deployment, contact Nuance technical support for assistance.

Standard upgrade

This section is for 11.0.3 and earlier. For 11.0.4 and later, see Upgrading Speech Suite software for version 11.0.4 or later.

To upgrade Speech Suite software:

  1. Review the prerequisites before starting. See Preparing for upgrades.
  2. Log on to the host as root.
  3. If upgrading Management Station from Speech Suite 11.0.2 (or earlier) on Linux, ensure the correct ownership of any existing log files. See Changing ownership of Management Station logs.

  4. Change to the directory containing the Speech Suite installation package and extract the package.

    Note: If you are upgrading Nuance products on multiple hosts, you can extract the package to a network location that other hosts can access.

  5. Change to the Nuance_Speech_Suite-version directory.

  6. Enter > ./setup.sh and follow the on-screen instructions.

    The upgrade is similar to a fresh install. See Running the Speech Suite installer on Linux. To summarize:

    • Ensure your license is valid.

    • Verify the paths to the 64-bit Java JDK or JRE location.

    • Specify the location of the License Manager host and, if used, Management Station database host.

    • Confirm you have a supported version of Apache Tomcat installed and specify its location.

    • Verify the location of the Connector/J.

    • Provide the information for the Management Station database, if used. Management Station reuses the mserver and audit (if created) databases, but you are required to re-enter the database information to keep audit logging enabled.

      The Management Station installation has character restrictions for database passwords. See the list of unsupported characters in Create a MySQL user account.

      • 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 .

    • Specify the location of the Recognizer language pack, Vocalizer voice pack, or Dragon Voice data pack you want to install. If any of these are already installed, you do not need to re-install them.

      Note: If you are upgrading from a Speech Suite version 11.0.2 or earlier and you are using Management Station with the Dragon Voice engines, you must reassign the role files to apply new commands for the Watcher service. See Upgrading from Speech Suite 11.0.2 or earlier.

  7. Repeat for the remaining hosts.
  8. If you run speech products and License Manager on different hosts, you must verify the parameters which point the speech products to the License Manager location and update them if needed.

  9. After the Speech Suite upgrade is complete, all Management Station user accounts, including the default 'Administrator' account will be locked. The Administrator user must then proceed to unlock all accounts and once a given user account is unlocked, the given user will be forced to change their passwords when they log in for the first time (using the default password). See Upgrading Management Station for steps to unlock all user accounts and update the given user passwords, along with any SMTP server email configuration passwords (if the SMTP server email configuration was previously configured).

  10. Once you have updated the Administrator password, log in to Management Station and check that configured services started successfully.

    Skip this topic if not using Management Station, and see Starting services without Management Station instead.

    Note: If you upgraded from 11.0.3 to 11.0.4 and are using Management Station with the Chrome browser, you should clear the browsing history. Otherwise, you might get a browser error when navigating through the documentation: "The Management Station has encountered an error and the operation cannot be completed."

  11. Recommended. Restore non-default configuration values. The upgrade procedure does not preserve your custom configurations. After the upgrade, operators should restore custom values to individual parameters. (You cannot restore whole configuration files because the new release might contain new parameters.)

To upgrade Speech Suite software:

  1. Review the prerequisites before starting. See Preparing for upgrades
  2. Log on to the host as a user with administrator privileges.

  3. Change to the directory containing the Speech Suite installation package and extract the package.

    Note: If you are upgrading Nuance products on multiple hosts, you can extract the package to a network location that other hosts can access.

  4. Run the Speech Suite installer (.exe) as Administrator from the directory where you extracted the file.

  5. Follow the on-screen instructions.

    The upgrade is similar to a fresh install. See Running the installer on Windows. To summarize:

    • Ensure your license is valid.

    • Verify the paths to the 64-bit Java JDK or JRE location.

    • Select the database type (MySQL or SQL Server) for Management Station and specify the database host information.

    • Confirm you have a supported version of Apache Tomcat installed and specify its location.

    • Verify the location of the Connector/J.

    • Provide the information for the Management Station database, if used. Management Station reuses the mserver and audit (if created) databases, but you are required to re-enter the database information to keep audit logging enabled.

      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.

      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 .

    • Specify the location of the Recognizer language pack, Vocalizer voice pack, or Dragon Voice data pack you want to install. If any of these are already installed, you do not need to re-install them.

    • Verify the location of the Connector/C, which Management Station requires to receive statistics from the Nuance speech software.

    Note: If you are upgrading from a Speech Suite version 11.0.2 or earlier and you are using Management Station with the Dragon Voice engines, you must reassign the role files to apply new commands for the Watcher service. See Upgrading from Speech Suite 11.0.2 or earlier.

  6. Repeat for the remaining hosts.
  7. If you run speech products and License Manager on different hosts, you must verify the parameters which point the speech products to the License Manager location and update them if needed.

  8. After the Speech Suite upgrade is complete, all Management Station user accounts, including the default 'Administrator' account will be locked. The Administrator user must then proceed to unlock all accounts and once a given user account is unlocked, the given user will be forced to change their passwords when they log in for the first time (using the default password). See Upgrading Management Station for steps to unlock all user accounts and update the given user passwords, along with any SMTP server email configuration passwords (if the SMTP server email configuration was previously configured).

  9. Once you have updated the Administrator password, log in to Management Station and check that configured services started successfully.

    Note: Skip this topic if not using Management Station, and see Starting services without Management Station instead.

  10. Recommended. Restore non-default configuration values. The upgrade procedure does not preserve your custom configurations. After the upgrade, operators should restore custom values to individual parameters. (You cannot restore whole configuration files because the new release might contain new parameters.)

Silent upgrade

This section is for 11.0.3 and earlier. For 11.0.4 and later, see Upgrading Speech Suite software for version 11.0.4 or later.

Review the prerequisites before starting. See Preparing for upgrades.

Notes:

If the syntax contains errors, such as incorrect format or invalid values, the installation might switch from silent to standard or not complete successfully.

After the Speech Suite upgrade is complete, all Management Station user accounts, including the default 'Administrator' account will be locked. The Administrator user must then proceed to unlock all accounts and once a given user account is unlocked, the given user will be forced to change their passwords when they log in for the first time (using the default password). See Upgrading Management Station for steps to unlock all user accounts and update the given user passwords, along with any SMTP server email configuration passwords (if the SMTP server email configuration was previously configured).

For descriptions of the required options, see Running silent installations on Linux.

Use the -s option with these required options: -U (upgrade) -f (license), -c (Connector/J), -j (Java), -o (Tomcat), and -V (root location of language, voice, and data packs), -H (database host:port pair), -Q (MySQL user), -W (MySQL password), -G (database name). For example:

> ./setup.sh -s -U -f "Nuance license location" -c "MySQL Connector/J location" -j "/usr/java/JDK or JRE version" -o "Tomcat location" -V "language and voice location" -H "MySQLHost:3306" -Q "ms" -W "msp" -G "mserver"

To keep audit logging enabled, these options are also required: -A (database name), -B (database username), -S (database password). For example:

-A mserver_audit -B ms -S MyPass123!

Note: The Management Station installation has character restrictions for database passwords. See the list of unsupported characters in Create a MySQL user account. If the password contains $, type \ before each one to escape them. For example, you type password MyPa$$123$ as MyPa\$\$123\$

If running Speech Suite components on different hosts, instead of running all components on the same host (the default), the -I option is required. For example, to upgrade Nuance speech software (NSS), such as Vocalizer and Recognizer, only:

> ./setup.sh -s -U -f "Nuance license location" -j "/usr/java/version" -V "language and voice location" -I "NSS"

Note: If you are upgrading from a Speech Suite version 11.0.2 or earlier and you are using Management Station with the Dragon Voice engines, you must reassign the role files to apply new commands for the Watcher service. See Upgrading from Speech Suite 11.0.2 or earlier.

For descriptions of the required options, see Running silent installations on Windows.

Note: The spaces in the examples (and lack of spaces) is intentional. When using the example, do not add random spaces.

Use the /silent option with these required options: LICENSE=, TOMCAT_HOME=, JAVA_HOME=, CONNECTORJ=, CONNECTORC=, MSSQL_INSTANCE=, MS_DBTYPE=, MS_DBSERVICE=, MS_DBHOST=, MS_DBPORT=, MS_DBSCHEMA=, MS_DBUSER=, MS_DBPASS=, and SUPPLEMENTSPATH= . For example (using a SQL Server database): 

> "C:\tmp\downloads\Nuance Speech Suite 11.0.exe" /debuglog"C:\tmp\downloads\install.log" /log"C:\tmp\downloads" /silent LICENSE="Nuance license location" TOMCAT_HOME="Tomcat location" JAVA_HOME="C:\Program Files\Java\version" CONNECTORJ="Connector/J location" CONNECTORC="C:\Program Files\MySQL\MySQL Connector.C\lib\libmysql.dll" MSSQL_INSTANCE=MSSQLSERVER MS_DBTYPE=sqlserver MS_DBSERVICE=sqlserver MS_DBHOST=SQLServerHost MS_DBPORT=1433 MS_DBSCHEMA=mserver MS_DBUSER=ms MS_DBPASS=msp SUPPLEMENTSPATH="language and voice location"

To keep audit logging enabled, these options are also required: MS_AUDITDB_ENABLED=, MS_AUDITDB_NAME=, MS_AUDITDB_USER=, MS_AUDITDB_PASS=. For example:

MS_AUDITDB_ENABLED=TRUE MS_AUDITDB_NAME=mserver_audit MS_AUDITDB_USER=ms MS_AUDITDB_PASS=msp

Note: 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. If the password contains the following characters, type ^ before each one to escape them: ^ & < >. For example, you type password My<Pass>123^ as My^<Pass^>123^^

If running Speech Suite components on different hosts, instead of running all components on the same host (the default), the ISFeatureInstall= option is required. For example, to upgrade Nuance speech software (NSS), such as Vocalizer and Recognizer, only:

> "C:\tmp\downloads\Nuance Speech Suite 11.0.exe" /debuglog"C:\tmp\downloads\install.log" /log"C:\tmp\downloads" /silent LICENSE="Nuance license location" JAVA_HOME="C:\Program Files\Java\JDK or JRE version" SUPPLEMENTSPATH="language and voice location" ISFeatureInstall="NSS"

If you are running a silent installation or upgrade in a script file, prefix the call to the installation or upgrade command with start "" /wait. The prefix ensures that the command completes before returning execution back to the script. For example:

> start "" /wait "C:\tmp\downloads\Nuance Speech Suiteversion.exe" rest of command...

Note: If you are upgrading from a Speech Suite version 11.0.2 or earlier and you are using Management Station with the Dragon Voice engines, you must reassign the role files to apply new commands for the Watcher service. See Upgrading from Speech Suite 11.0.2 or earlier.

Upgrading from Speech Suite 11.0.2 or earlier

This topic is relevant when upgrading from Speech Suite 11.0.2 (or an earlier 11.0.x version).

The startup commands for the Watcher service changed between 11.0.2 and 11.0.3.

  • If using Management Station, you must apply the new commands to all assigned role files, as described below. This ensures that all services start and connect to the watcher service correctly. If managing the Watcher service explicitly, ensure you use the new commands. See Starting and stopping the watcher service manually.
  • If not using Management Station, ensure you use the newest forms of the service startup commands. See Starting services without Management Station.

To apply the new commands, after upgrading Speech Suite, you need to reassign all role files that contain Nuance Resource Manager, Krypton, Natural Language Engine, or Nuance Text Processing Engine services. If you are using the default role files, you can unassign and then reassign them. For instructions, see Reassigning role files.

If you have any custom role files, you must update them with new commands before reassigning. (A custom role file is any default role file that you modified.) Follow these steps:

  1. Log in to Management Station.
  2. Select Monitoring & Control > System View.
  3. Expand Nuance Network to display the hosts.
  4. Select a host that uses a custom role file and click Network Design.
  5. Click Save Host Role to save the current host configuration as a role file. This step ensures that the custom role file you update contains the current settings.
  6. Enter a name for the host role file and click OK. Management Station saves the file to $NUANCE_DATA_DIR/system/customRoles

    Note: The name you enter only appears in Management Station. The actual role file is XML and the filename is the hostname with timestamp when you saved the file.

  7. Log in to the Management Station host as root (Linux) or Administrator (Windows).
  8. Locate your custom role file: $NUANCE_DATA_DIR/system/customRoles
  9. Locate the new role file (provided in the upgrade) that contains the same services as your custom role file: $MSTATION_HOME/mserver/webapps/mserver/config/roles
  10. Compare the contents of the two files, and replace the contents of the <command> element in the custom file with the contents from the new file.
  11. Locate the <command> element for a service in a new role file.
  12. Save the custom role file.
  13. Repeat these steps to update all other custom role files.

    Note: If you have custom role files not currently assigned to a host, make sure you update those as well in case you do assign them in the future.

  14. Reassign your custom role file to the host. See Reassigning role files.

You must run ZooKeeper before starting the Nuance Resource Manager and Dragon Voice engines. Otherwise, Management Station displays alarms as Dragon Voice engines attempt to register. If services still do not start, reboot the host, which restarts the services, and make sure that ZooKeeper is running.

On Linux: You might notice that some services fail to start, appear twice, or appear under the wrong host. You can modify the etc/hosts file for a host experiencing these problems.

You must install at least one language pack for Nuance Recognizer, a voice pack for Nuance Vocalizer, and a data pack for the Krypton engine. If you did not install languages/voices/data packs during the installation process, you can download, extract, and install them now.

Note: If you install Speech Suite on a Krypton/NTpE host without a data pack, you must stop the watcher service before installing the first data pack. (Otherwise, the required NDP_HOME environment variable will not be set.) For instructions on manually starting and stopping services, see Starting and stopping the watcher service manually.

You must set full permissions on directories where logs are written to disk. Otherwise, services fail to start because they can’t begin logging. Set permissions on the NUANCE_DATA_DIR directory, the parent location for all logging.

To check the permissions:

  1. Open Explorer.
  2. Right-click the %NUANCE_DATA_DIR% directory and select Properties.
  3. Select the Security tab.

    The Name box must contain one of either "Everyone" or "SYSTEM" with full permissions (all Allow boxes must be checked).

  4. If either of these names aren’t named, then click Add.
  5. Choose Entire Directory for the Look In: field.
  6. Add either of these names and click OK.

To check the permissions, log in as root and set full permissions on $NUANCE_DATA_DIR; by default, var/local/Nuance. For example: 

> chmod -R 755 NUANCE_DATA_DIR

It’s important that only the root user have full permission to avoid allowing other users to modify files.