Installation and Administration Guide for the Speech Connect for Cisco Unity Feature
System Administration
Downloads: This chapterpdf (PDF - 187.0KB) The complete bookPDF (PDF - 3.01MB) | Feedback

System Administration

Table Of Contents

System Administration

Setting Up Dialing Rules

Installing the Speech Connect License

Setting Up Error Reporting

Setting Disambiguation History

Setting Up Peers

Administering Speech Connect Services at the System Console

Using the sc_sys Commands

Starting the Services

Stopping the Services

Restarting the Services

Viewing the Status of All Services

Viewing the Versions of All Services

Creating a Complete System Backup

Performing a Complete System Restore

Reconfiguring the Network Settings

Installing the Speech Connect License by Using sc_sys

Viewing the Speech Connect License

Viewing the Speech Connect EULA

Changing the root, scadmin, or scfeeds Password

Changing the SSP Logging Level by Using sc_sys


System Administration


This chapter describes the system administrative tasks done during setup, and during normal operation of the Speech Connect system.

See the following sections:

Setting Up Dialing Rules

Installing the Speech Connect License

Setting Up Error Reporting

Setting Disambiguation History

Setting Up Peers

Administering Speech Connect Services at the System Console

Setting Up Dialing Rules

Dialing rules allow you to:

Establish rules to classify dialed numbers as either "Extension" or "External."

Set the dialing format string that is required for transferring to extensions and external numbers.

Specify the longest number that the system can call to inhibit certain types of calls.


Note Call histories are maintained internally by the Speech Connect system for an employee (ID), extension (EXT), or external number (ANI). The dialing rules that you establish are used to determine which calls are from extensions and external numbers.


To Set Up Dialing Rules


Step 1 In the Speech Connect interface, click Config and then click Dialing. The Dialing Rules page appears.

Step 2 Enter values into the fields, as applicable.

The Dialing Rules fields are described in Table 5-1.

Step 3 To update all values, press Update.


Table 5-1 Dialing Rules Fields 

Field
Description
Values

Longest Number

Sets the longest phone number that the system can call. For example, a setting of 4 inhibits external calls. A setting of 11 allows external calls but inhibits calls to some foreign countries. These settings do not overrule your call-control software configuration settings.

Range: 0 to 20

0 = Not used

Internal

Longest Extension

Sets the rules for an internal extension such that any phone number of this length or less is an extension.

Range: 0 to 20

0 = Not used

Transfer Format

Sets the dialing format used for extensions. The string is used as is in SIP transfers, with %D being replaced with the extension.

Any valid SIP endpoint address

External

Shortest Extension (Shortest External Phone Number)

Sets the rules for an external phone number such that any number of this length or more is considered an external phone number.

Range: 0 to 20

0 = Not used

Transfer Format

Sets the dialing format used for external numbers. The string is used as is in SIP transfers, with %D being replaced with the external number.

Any valid SIP endpoint address


Installing the Speech Connect License

Revised March 2008

The Licensing fields display the current license key for this system and the status of your current Speech Connect license agreement. This section describes how to obtain and upload a new or changed license code for your system.


Caution When a Speech Connect system is not licensed, only 50 employee and 50 department records can be included in the speakable directory. This limitation is not enforced during data import and management, but is enforced when the directory is compiled for call recognition. When the grammar is compiled, the first 50 employees sorted by first name/last name and the first 50 departments sorted by department code can be reached.

To Install the Speech Connect License


Step 1 In the Speech Connect interface, click Config and then click Global Settings. The Global Settings page appears. The License Information section appears on the Global Settings page.

The Licensing Information fields are described in Table 5-3.

Step 2 Click the License Key field and highlight the entire license key by pressing Ctrl + A.

Step 3 Copy the license key to your clipboard by clicking Edit > Copy (or pressing Ctrl + C).

Step 4 In your e-mail program, open a new e-mail, click in the body, and paste the license key by clicking Edit > Paste (or pressing Ctrl + V).

Step 5 E-mail the license key and all of the information listed in Table 5-2 to your Cisco license grantor at sc-licensing@external.cisco.com. You will receive a license code file in return.

Table 5-2 Information to Include in Request for License Code 

Customer Information

Company Name

Company Address

Contact Name(s)

Contact Email

Contact Phone

Product Purchase Information

PAK ID (Cisco Claim Certificate Number, included with shipment)

PO Number (if available)

Sales Order Number (if available)

Cisco or Partner Contact Information (if applicable)

Contact Name

Contact Email

Contact Phone

Server Information

Server license key (copied from the Config > Global Settings page)

Server Host Name (for example, sc.cisco.com; do not send the IP address)


Step 6 Download the license code file to your local drive or network.

Step 7 Click Browse to locate and select the license code, and click Open. The License code file appears in the the Install License File field.

Step 8 Click Install License. The license code is saved to the database, and the Information/Status field shows the status of your license including the number of ports and users granted to your system.


Table 5-3 Licensing Information Fields

Field
Description
Values

License Key

Displays the system license key.

System-generated code

Information/Status

Displays the current status of your licensing agreement.

Number of ports and users granted to your system

Install License File

Uploads the license code and saves it to the database. Used for initial loading of the license or when the license code has changed.

Valid license code


Setting Up Error Reporting

The Reporting fields allow you to set the threshold levels for error logging and alarm notification. You can enter an administrative e-mail address to receive alarm notifications. The system will e-mail the administrator if it detects an issue such as a required process not running or the disk filling up. It also e-mails a report to show the status of the processes that were run from Scheduled Tasks.

To Set Up Error Reporting


Step 1 In the Speech Connect interface, click Config and then click Global Settings. The Global Settings page appears. The Reporting section appears on the Global Settings page.

Step 2 Enter values into the fields, as applicable.

The Reporting fields are described in Table 5-4.


Caution Setting logging to the Debug level for an extended period of time can affect performance of an application. We recommend that you use Debug logging strictly for isolating a problem.

Step 3 Click Update. The system saves the Reporting settings.


Table 5-4 Reporting Fields

Field
Description
Values

Logging

Sets the threshold of event levels.

Debug (most logging)

Verbose

Average

Warnings

Errors (least logging)

Alarms

Sets the threshold level of notification for event level alarms.

1 to 10

10 = Most critical

Reporting Email

The system sends a report to this e-mail address when it detects an issue such as a required process not running or the disk filling up. It also e-mails a report from the directory update service to show the status of the processes that were run from Scheduled Tasks.

Up to 80 characters

Diagnostics

Collects system information and some current trace files into a compressed tar file, and allows you to save the tar file to your local PC. The snapshot can then be forwarded to Technical Support for further analysis.

Save Diagnostic Information—Retrieves and packages diagnostic information into a tar file.


Setting Disambiguation History

The Disambiguation History log remembers caller choices and uses the information to speed up future calls. The Disambiguation History fields allow you set the maximum number of entries and the retention times for call disambiguation history logging for employees, extensions, and external numbers.

To Set Up Disambiguation History


Step 1 In the Speech Connect interface, click Config and then click Global Settings. The Global Settings page appears. The Disambiguation History section appears on the Global Settings page.

Step 2 Enter values into the fields, as applicable.

The Disambiguation History fields are described in Table 5-5.

Step 3 Configure any remaining settings on the page, and click Update.


Table 5-5 Disambiguation History Fields 

Maximum
Maximum Number of Disambiguation History Entries
Range = 0 to 200
# Days Retained
Number of Days to Retain Disambiguation History Data Before Purging
Range = 0 to 365
Description

The following examples apply to:
ED Employee (USER)
ED Extension (EXT)
ED External (ANI)

25

0

In this example, the number of disambiguation history entries is limited to 25. There is no time limit (history entries are not purged).

0

25

In this example, the number of history entries is unlimited but they will be purged after 25 days.

0

0

Entering zero "0" in both fields disables disambiguation history for that caller group (Employee, Extension, or External). For example, if many external callers call in from the same number, you might consider disabling disambiguation history for external numbers.


Setting Up Peers

The Peer Setup option allows you to set up Speech Connect systems that when synchronized will contain identical recorded names and call history data. Setting up peers allows for load balancing of calls and provides a backup solution during maintenance and emergencies. Having the same recorded names and call history data on each peer will provide a common calling experience for users no matter which peer they call.


Note Data administration and system licensing must be consistent among peers. Prior to configuring systems as peers, ensure that employee and department data is obtained from the same Active Directory or other data source, and that data updates are shared or obtained from the same source. Systems must be network accessible by fully-qualified domain names.


To Set Up the System as a Peer with Remote Speech Connect Systems


Step 1 In the Speech Connect interface, click Config and then click Peer. The Peer Setup page appears.


Note The localhost peer is a default setup that you can use as a template to create a new peer. Do not delete the default localhost peer.


Step 2 Click Create New Peer From This, enter a name to identify the peer, and click OK.

The Peer Setup fields are described in Table 5-6.

Step 3 Enter the fully-qualified domain name of the remote Speech Connect system that you are synchronizing to. If you set the peer to be On Line, the peers will begin to synchronize automatically.

Step 4 If you want to do a full synchronization, click Synchronize.


Caution Running a full synchronization of peers may affect CPU and network performance. We recommend that you synchronize during off-peak hours.

Table 5-6 Peer Setup Fields 

Field
Description
Values

Name

Enter the fully-qualified domain name of the remote Speech Connect system that you are synchronizing to.

Any valid host name with fully-qualified domain name, for example, sc7845.cisco.com

IP Address

Enter the IP address of the remote Speech Connect system that you are synchronizing to.

Any valid IP address

On Line

Sets whether or not the remote peer is online.

Yes = Online

No = Offline

Name Data

Displays the date and time when the local host sends and receives spoken name files (8k PCM Mu-law or WAV) to or from the peer.

MM/DD/YYY HH:MM:SS

Disambiguation

Displays the date and time when the local host sends and receives employee disambiguation histories to or from the peer.

MM/DD/YYY HH:MM:SS


Administering Speech Connect Services at the System Console

The sc_sys command is used to administer only Speech Connect-specific services. The sc_sys command does not replace but compliments the Speech Connect web interface, and provides the only method of administering Speech Connect services on the system.

See the following sections:

Using the sc_sys Commands

Starting the Services

Stopping the Services

Restarting the Services

Viewing the Status of All Services

Viewing the Versions of All Services

Creating a Complete System Backup

Performing a Complete System Restore

Reconfiguring the Network Settings

Installing the Speech Connect License by Using sc_sys

Viewing the Speech Connect License

Viewing the Speech Connect EULA

Changing the root, scadmin, or scfeeds Password

Changing the SSP Logging Level by Using sc_sys

Using the sc_sys Commands

To Use the sc_sys Commands


Step 1 At the console, or remotely via Secure Shell, log in as scadmin.

Step 2 At the system console, enter sudo sc_sys. The following options appear:

[scadmin@scadmin ~]$ sudo sc_sys
Usage: /common/scadmin/bin/sc_sys
{start | stop | restart | status | version | backup | restore | reip | license | show-license | chpass |
<user> | set <parameter><value> | diag-snapshot}


Note If you logged in as scadmin, you need to run sc_sys by using the sudo command. If you are logged in as root, you do not need to run the sudo command.


Step 3 Enter commands as applicable:

sc_sys start—Starts Speech Connect services.

sc_sys stop—Stops Speech Connect services.

sc_sys restart—Restarts Speech Connect services.

sc_sys status—Shows the status of all Speech Connect services.

sc_sys version—Shows the version of Speech Connect installed on the system and also shows some software component versions.

backup—Creates a data backup.

restore—Restores from a data backup.

sc_sys reip—Allows you to reconfigure network settings.

sc_sys license—Provides an alternative method from using the administrative interface for installing a Speech Connect license.

show-license—Displays the current Speech Connect license status.

eula—Displays the End User License Agreement (EULA).

sc_sys chpass—Allows you to change the root, scadmin, or scfeeds password.

set <parameter><value>—Allows you to change certain SSP service parameters.

sc_sys diag-snapshot—Allows you to gather diagnostic logs and system information to send to Cisco for analysis. For more information, see the "Running the Diagnostic Snapshot Procedure" section on page 11-4.


Starting the Services

This command allows you to start the Speech Connect services.


Note After installing Cisco Speech Connect, the services will be running. You need to start the Speech Connect services only after they have been stopped.


To Start the Services


Step 1 At the console, enter sudo sc_sys start. The services start, as shown in the following example:

Starting Cisco Speech Connect...
Starting Database: [ OK ]
Starting httpd: [ OK ]
Starting Speech Server: [ OK ]
Setting Speech Server priority: [ OK ]
Starting SSP: [ OK ]
Waiting for SSP to initialize: [ OK ]
Starting SCsync: [ OK ]
Waiting for SCsync to initialize: [ OK ]
----------
Starting Cisco Speech Connect: [ OK ]


Stopping the Services

This command allows you to stop the Speech Connect services.

To Stop the Services


Step 1 At the console, enter sudo sc_sys stop. The services stop, as shown in the following example:

Stopping Cisco Speech Connect...
Stopping SCsync: [ OK ]
Stopping SSP: [ OK ]
Stopping Speech Server: [ OK ]
Stopping httpd: [ OK ]
Stopping Database: [ OK ]
----------
Stopping Cisco Speech Connect: [ OK ]


Restarting the Services

This command allows you to restart the Speech Connect services.

To Restart the Services


Step 1 At the console, enter sudo sc_sys restart. The services stop and restart, as shown in the following example:

[scadmin@sc7825 ~]$ sudo sc_sys restart
Stopping Cisco Speech Connect...
Stopping SCsync: [ OK ]
Stopping SSP: [ OK ]
Stopping Speech Server: [ OK ]
Stopping httpd: [ OK ]
Stopping Database: [ OK ]
----------
Stopping Cisco Speech Connect: [ OK ]
Starting Database: [ OK ]
Starting httpd: [ OK ]
Starting Speech Server: [ OK ]
Setting Speech Server priority: [ OK ]
Starting SSP: [ OK ]
Waiting for SSP to initialize: [ OK ]
Starting SCsync: [ OK ]
Waiting for SCsync to initialize: [ OK ]
----------
Starting Cisco Speech Connect: [ OK ]


Viewing the Status of All Services

This command allows you to view the status of all Speech Connect services.

To View the Status of All Services


Step 1 At the console, enter sudo sc_sys status. The status of all services appears, as shown in the following example:

[scadmin@sc7825 ~]$ sudo sc_sys status
Status for Cisco Speech Connect:
----------
Database is running
----------
Web Server is running
----------
Speech Server is running
----------
SSP is running
----------
SCsync is running


Viewing the Versions of All Services

This command allows you to view the Speech Connect software version.

To Display the Versions of All Services


Step 1 At the console, enter sudo sc_sys version. The version of all services appears, as shown in the following example:

[scadmin@sc7825 ~]$ sudo sc_sys version
Cisco Speech Connect version 1.0.1
Speech engine component version 9.0-0
SEAA component version 1.0.1-2
SSP component version 2.5.5663-4
Installed patches:
None


Creating a Complete System Backup

This command allows you to do a full Speech Connect system and database backup.

To Create a System Backup


Step 1 At the console, enter sudo sc_sys backup, as in the following example:

[scadmin@sc7825 ~]$ sudo sc_sys backup
Perform a data backup now? (y/n): y

Step 2 Enter y to perform the backup.

SpeechConnect Backup
Unloading Database -Complete.
SpeechConnect Backup to file:
/common/speechconnect/1.0.1/backups/SpeechConnectBackup-071210162301.tar.gz -Complete.
SpeechConnect Backup Complete.

Step 3 You have completed a full Speech Connect system backup.


Performing a Complete System Restore

This command allows you to restore data from a previous backup or to revert to an earlier version of the Speech Connect software.

To Perform a System Restore


Step 1 At the console, enter sudo sc_sys restore, as in the following example:

[scadmin @sc7825 ~]$ sudo sc_sys restore
Cisco Speech Connect Restore
This procedure will restore Speech Connect configuration data and spoken names from a
previous Speech Connect backup. You will be prompted to select from a list of existing backups.

WARNING: Proceeding with the Speech Connect restore will delete all current Speech Connect
data and restore the system to configuration and data contained in the selected backup file. The
system will be taken out of service during this procedure. Please be very sure that you want to
perform a restore.

Continue? (yes/no/q): yes

Step 2 Enter yes to continue.

There are (4) backups available...
(1) - SpeechConnectBackup-071208093547.tar.gz
(2) - SpeechConnectBackup-071209010101.tar.gz
(3) - SpeechConnectBackup-071210162301.tar.gz
(4) - SpeechConnectBackup-071210163002.tar.gz
(q) - quit

Select backup file instance or (q)uit: 4

Step 3 Enter the number of the backup file that you want to restore.

You selected: 4 - SpeechConnectBackup-071210163002.tar.gz

Stopping Services
Starting Database Service
Begin Restore
Restoring backup files
Restoring database information
Restoring spoken name files
SpeechConnect Restore Complete
Please wait while we restart SpeechConnect - Done

Step 4 You have completed a full Speech Connect system restore.


Reconfiguring the Network Settings

This command allows you to view and change your network configuration.

To Reconfigure the Network Settings


Step 1 At the console, enter sudo sc_sys reip. The system displays your network configuration, and allows you to change it, as shown in the following example:

[scadmin@sc7825 ~]$ sudo sc_sys reip
Cisco Speech Connect
Network Configuration
------------------------------------
IP assignment method: static
Host name: sc7825.cisco.com
Domain name: cisco.com
IP Address: 192.168.1.9
Netmask: 255.255.255.0
Gateway Address: 192.168.1.1
Network Address: 192.168.1.0
Broadcast Address: 192.168.1.255
DNS address #1: 10.0.15.1
DNS address #2:
DNS address #3:
Is this correct? (Y/N/Q): n

Step 2 To change the configuration, enter n and press Enter. Enter the new configuration, as shown in the following example:

Host name of this system (not including domain): sc7825-1
Domain name: cisco.com
System IP Address: 122.110.2.9
Netmask: 255.255.255.0
Gateway: 122.110.2.1
DNS address #1: 10.0.15.1
DNS address #2:
Network Configuration
------------------------------------
IP assignment method: static
Host name: sc7825-1
Domain name: cisco.com
IP Address: 122.110.2.9
Netmask: 255.255.255.0
Gateway Address: 122.110.2.1
Network Address: 192.168.1.0
Broadcast Address: 192.168.1.255
DNS address #1: 10.0.15.1
DNS address #2:
DNS address #3:
Is this correct? (Y/N/Q): y

Step 3 To accept the configuration changes, enter y and press Enter.

Saving network settings...
Settings have been saved.
Hit <Enter> to reboot the system.

Step 4 Press Enter to reboot the system. The configuration is changed, and the system reboots.


Installing the Speech Connect License by Using sc_sys

This command is an alternate method of installing the Speech Connect license, and should be used only if the administrative interface installation fails. For more information about installing the license by using the Speech Connect interface, see the "Installing the Speech Connect License" section.

To Install the Speech Connect License by Using sc_sys


Step 1 Using SFTP, upload the license.dat file to the scadmin user home directory.

Step 2 At the console, enter sudo sc_sys license. The license file is installed.


Viewing the Speech Connect License

This command allows you to view the status of your Speech Connect and Names Tuning licenses.

To View the Speech Connect License Status


Step 1 At the console, enter sudo sc_sys show-license, as in the following example:

[scadmin@sc7825 ~]$ sudo sc_sys show-license
Speech Connect license information
Speech Connect: LICENSED FOR 12 PORTS, 25000 USER DIRECTORY
Names Tuning Service: EXPIRES: 12/01/2008


Viewing the Speech Connect EULA

This command allows you to view the Speech Connect End User License Agreement (EULA).

To View the Speech Connect EULA


Step 1 At the console, enter sudo sc_sys eula, as in the following example:

[scadmin@sc7825 ~]$ sudo sc_sys eula
End User License Agreement

IMPORTANT: PLEASE READ THIS END USER LICENSE AGREEMENT CAREFULLY.
DOWNLOADING, INSTALLING OR USING CISCO OR CISCO-SUPPLIED SOFTWARE
CONSTITUTES ACCEPTANCE OF THIS AGREEMENT.
...
:

Step 2 The : at the bottom of the screen allows you to move forward or backward in the file. To move forward, press Enter to display the next line, or press the spacebar to go to the next screen.

Step 3 To go back one page, press b.

Step 4 To quit, press q. The command line prompt appears.


Changing the root, scadmin, or scfeeds Password

This command allows you to change the root, scadmin, or scfeeds password.

To Change the root, scadmin, or scfeeds Password


Step 1 At the console, enter sudo sc_sys chpass root|scadmin|scfeeds, as in the following example:

[scadmin@scadmin ~]$ sudo sc_sys chpass scadmin
Changing password for user scadmin.
New UNIX password:
Retype new UNIX password:
passwd: all authentication tokens updated successfully.

Step 2 Enter in the new password, and reenter it to confirm. The new password will be in effect for the next login.


Changing the SSP Logging Level by Using sc_sys

To isolate a specific problem, you may need to change the Speech Services Platform (SSP) logging level, which should be done under the direction of a Cisco technical representative. This command is an alternative to editing the $SEAA_HOME/config/seaa_settings file when you need to change the SSP logging level.

To Change SSP Logging Levels


Step 1 At the console, enter sudo sc_sys set SSP_LOGLEVEL to view the current level, as in the following example:

[scadmin@scadmin ~]$ sudo sc_sys set SSP_LOGLEVEL
Missing value argument
The current value of SSP_LOGLEVEL is Verbose
Parameter SSP_LOGLEVEL help:
Specifies the SSP log level.
Valid values: Warning Info Verbose

Step 2 To change the log level, enter the value as in the following example:

[scadmin@scadmin ~]$ sudo sc_sys set SSP_LOGLEVEL Warning
Setting SSP_LOGLEVEL=Warning
Remember to restart Speech Connect services to utilize the new settings.

Step 3 To restart Speech Connect services, run sc_sys restart (for instructions, see the "Restarting the Services" section).