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.

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

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.