Upgrading Speech Suite software for version 11.0.4 or later

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.

If your system is set up in a distributed architecture and you are using Management Station, upgrade Management Station first (before other hosts).

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

Applications should still function properly after upgrade. However, you must test thoroughly before using them in production environments.

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

Back up the system before and after the upgrade. Backups from previous versions are not compatible with 11.0.4 or later. Use the backups as reference copies of your custom configurations.

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 Dragon Voice

At least one data pack is required.

Standard upgrade

To upgrade Speech Suite software:

  1. Review the prerequisites before starting. See Preparing for upgrades.
  2. Perform a backup to ensure you have a copy of the custom configurations as a reference. The upgrade procedure will preserve your custom configurations.
  3. Ensure you have noted the port@host value for the SWILicenseServerList parameter in Recognizer's SpeechWorks.cfg configuration file.

  4. Log on to the host as root.

    Note: If your system is set up in a distributed architecture and you are using Management Station, upgrade Management Station first (before other hosts).

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

  6. Change to the Nuance_Speech_Suite-version directory.

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

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

  8. Repeat for the remaining hosts.
  9. 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.

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

  11. Once you have updated the Administrator password, log in to Management Station and verify that all your configured services started as expected.

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

  12. Perform a backup of the system to ensure you have a copy of the new version of the configuration.

To upgrade Speech Suite software:

  1. Review the prerequisites before starting. See Preparing for upgrades.
  2. Perform a backup to ensure you have a copy of the custom configurations as a reference. The upgrade procedure will preserve your custom configurations.
  3. Ensure you have noted the port@host value for the SWILicenseServerList parameter in Recognizer's SpeechWorks.cfg configuration file.
  4. Log on to the host as a user with administrator privileges.

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

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

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

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

  8. Repeat for the remaining hosts.
  9. 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.

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

  11. Once you have updated the password, log in to Management Station and verify that all your configured services started as expected.

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

  12. Perform a backup of the system to ensure you have a copy of the new version of the configuration.

Silent upgrade

Review the prerequisites before starting. See Preparing for upgrades. Perform a backup to ensure you have a copy of the custom configurations as a reference. The upgrade procedure will preserve your custom configurations.

Note: 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 performing the upgrade, perform a backup of the system to ensure you have a copy of the new version of the configuration.

Note: 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!

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: The spaces in the examples (and lack of spaces) is intentional. When using the example, do not add random spaces.

You 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

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