Configuring services

This Management Station script adds, removes, and update properties to services in your Nuance Network. The changes are immediately reflected in the Management Station interface.

Syntax:

  • Windows: > service-configuration.bat options
  • Linux: > ./service-configuration.sh options

Options

Description

-configuration file

Required. Path and name of a text file that sets service properties.

Syntax in the file:

  • The format is property=value. For example: tts_license_ports=120
  • Only one property/value pair per line.
  • Values are alphanumeric. Tabs and special characters are not allowed.
  • Comments (#) are allowed.

For a list of available properties, see the service's template configuration file (see Configuration roadmap).

-hostname Host

Required. Name of the managed host where the service is being configured.

Must be the display name defined on the Service properties page in Management Station .
-https

Optional. Flag to indicate that Management Station is configured for HTTPS. The default is HTTP.

-operation operation

Required. The action to perform. Values are case sensitive:

  • Add — Seldom used. Adds properties that are not currently in the service's configuration file.
  • Remove — Seldom used. Deletes properties from the service's configuration file.
  • Update — Most often used operation. Changes property values the service's configuration file.

For details on the configuration files, see Configuration roadmap.
-password MS_username_password

Optional. Account password. If not specified, the script prompts you for the password. Recommended only if you plan on invoking this script via a custom script used to automate some operations.

-port MS_port

Optional. Port assigned to Management Station. Default is 8080 (http) or 8444 (https).

-restart

Optional. Restarts the service.

Note: To avoid alarms, ensure that statistics collector service is started before using restart.

-servername MS_host

Required. Name or IP address of the Management Station.

-servicename service

Required. Name of the service enclosed in quotations. Must be the display name defined on the Service properties page in Management Station. For example, "Nuance Recognition Service" or "Nuance Recognition Service num", where num is the instance number.

-username MS_username

Optional. Management Station login user name. Default is Administrator.

The script prompts for the account password. Your typing is not echoed on the screen.

Example: updating service configurations

Use the Update operation to re-load the serivce's configuration file. (For configuration file details, see Configuration roadmap.)

This command updates every property defined in paramsNVS.txt in a vocalizer service:

> service-configuration.bat -configuration C:\config\paramsNVS.txt -operation Update -hostname venus -restart -servername ms-bladerunner -servicename "Nuance Vocalizer Service 1"

Example: adding service properties

Use the Add operation to add a property to a service. For example, if Nuance requests that you add a custom property.

This command adds all properties contained in paramsNSS.txt to a Speech Server service:

> service-configuration.bat -configuration C:\config\paramsNSS.txt -operation Add -hostname venus -restart -servername ms-bladerunner -servicename "Nuance Speech Server"