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

Installing Speech Connect

Table Of Contents

Installing Speech Connect

System Requirements

Hardware

Software

Installing the Speech Connect Operating System

Configuring the Speech Connect Server

Post-Installation Procedures

Setting Up Speech Connect on Speed Dial

Upgrading Speech Connect

Reverting an Upgraded Speech Connect System to the Previous Version

Installing a Language Pack

Uninstalling a Language Pack

Changing the NTP Time Source After Installation


Installing Speech Connect


This chapter describes how to install and configure the Speech Connect operating system and server software.

See the following sections:

System Requirements

Installing the Speech Connect Operating System

Configuring the Speech Connect Server

Post-Installation Procedures

Setting Up Speech Connect on Speed Dial

Upgrading Speech Connect

Reverting an Upgraded Speech Connect System to the Previous Version

Installing a Language Pack

Uninstalling a Language Pack

Changing the NTP Time Source After Installation

System Requirements

This section describes the hardware and software requirements for installing Speech Connect.

Hardware

Revised February 2008

The Speech Connect system is a software product that is loaded onto a hardware server. The hardware server must meet the following requirements:

The following Cisco 7800 Series Media Convergence Server (MCS) server models—configured as shipped—are supported:

Cisco MCS 7825-H3

Cisco MCS 7825-I3

Cisco MCS 7835-H2

Cisco MCS 7835-I2

Cisco MCS 7845-H2

Cisco MCS 7845-I2

The following RAM is required:

2 GB of RAM for MCS 7825 and MCS 7835

4 GB of RAM for MCS 7845

The correct number of hard drives is required, as follows (too few or too many will cause installation errors):

2 hard drives for MCS 7825

4 hard drives for MCS 7835 and MCS 7845

DVD-ROM drive

Keyboard, mouse, and monitor


Note The Speech Connect installer checks for the presence of the DVD-ROM drive, sufficient hard drive and memory sizes, sufficient CPU type and speed, and the correct number of hard drives. If too few or too many hard drives are installed, the installer will be unable to complete RAID configuration properly, and will report a failure.


Software

Revised May 2009

Server Software

The Speech Connect server runs on the Cisco Linux-based operating system. This operating system is included with the application.

Client Software

The Speech Connect system is designed to be administered through a web browser:

Internet Explorer 6.0 or later

Firefox 2.0.0.0 or later


Note At this time, Internet Explorer 8.0 is not officially supported. We recommend that administration be performed by using Internet Explorer 6.0 or 7.0, or Firefox 2.0.0.0 or later.


Both the Speech Connect server and the web browser client must be connected to the network. In addition, the client system (with the web browser) must be allowed to connect to the Speech Connect server through port 80 (HTTP).

Call-Control Software

The Speech Connect server requires integration with one of the call-control systems:

Cisco Unified Communications Manager (CM) (formerly known as Cisco Unified CallManager) version 4.0 or later (via TIMG/PIMG telephony gateway)

Cisco Unified CM version 5.0 or later (via SIP trunk)

Cisco Unified CM version 6.0 (via SIP trunk)

Installing the Speech Connect Operating System

To Install the Speech Connect Operating System


Step 1 Insert the Speech Connect DVD into the DVD-ROM drive of the server on which you are going to install Speech Connect.


Note The server on which you install Speech Connect will be reformatted during the installation. We suggest using an unformatted server.


Step 2 Boot the computer from the DVD.

The system checks that this is a valid platform.

If your platform is invalid, the system displays an error message, aborts the installation, and displays a log with information.

If your platform is valid, the installation continues.

Step 3 The system checks that there is an existing operating system. If you have an existing operating system, the system asks if you want to overwrite it.

If you choose not to overwrite the existing operating system, the installation process aborts and the DVD ejects.

If you choose to continue the installation, the system overwrites the existing operating system and any existing data will be lost. You have 30 seconds to choose to continue; otherwise, the system aborts the installation and ejects the DVD.

If your system does not have an operating system, the installation continues.

Step 4 The system continues to the media check screen. You can check the media disk by clicking Check. We strongly recommend that you perform this check.


Note By default, this step is not skipped.


If the media check fails, you can either abort the installation or continue. If you continue with the installation, there may be errors. Note that the media check can take up to five minutes.

Step 5 The computer performs a system check that inspects the hard drive, the RAID, and the BIOS.

If the system does not need to reconfigure any part of the system, it displays a green check mark next to each component name and continues.

If the system needs to reconfigure any part of the system, it displays two green circular arrows next to the component name and automatically reboots after 15 seconds. During these 15 seconds, you can hit any key to pause the check and read the message. After pausing, you must click Restart to continue. After rebooting, the installation process continues from where it left off.

Depending on your system configuration, it may reboot up to three times. This happens automatically.

Step 6 The Speech Connect operating system loads and installs from the DVD. This takes approximately 10 to 15 minutes.

Step 7 Speech Connect software loads and installs from the DVD. This takes approximately 5 to 10 minutes.

Step 8 When the Speech Connect for Cisco Unity software installation is complete, the installation runs a final check of the hard drive and security policies, and backs up the system.

Step 9 The system displays a message informing you that the installation is complete. When the DVD-ROM drive ejects the DVD, remove the DVD from the drive.

Step 10 Click Reboot to reboot your computer.


Note After you complete the installation and reboot the system, a timezone error may appear. You can ignore this error.


Step 11 Continue with the "To Configure the Speech Connect Server" procedure.


Configuring the Speech Connect Server


Note If at any time a dialog box seems to disappear, it is probably in the background. Press Alt+ Escape to switch back to the dialog box.


To Configure the Speech Connect Server


Step 1 When you have finished the "To Install the Speech Connect Operating System" procedure, the Speech Connect system displays the Welcome page with an introductory message informing you that there are a few more steps to take before your system is ready to use. Click Next.

Step 2 The License (EULA) page appears. Read the license agreement, and select Yes, I Agree to the License Agreement. Click Next.

Step 3 The Root Password page appears. The root login is used for upgrades to Speech Connect and diagnostic assess only. The password must be a minimum of eight characters long, and have at least one lowercase character (a-z), one uppercase character (A-Z), one numeric digit (0-9), and one special character (!"#$%&`()"+,-./:;<=>?@[\]^_'{/}~). Enter the secure Root password that you want to set for the root login two times, and click Next.

Step 4 The Admin Password page appears. The scadmin login is used for console and web administration access to Speech Connect. The password for the scadmin login must be a minimum of eight characters long, and have at least one lowercase character (a-z), one uppercase character (A-Z), one numeric digit (0-9), and one special character (!"#$%&`()"+,-./:;<=>?@[\]^_'{/}~). Enter the secure Admin password that you want to set for Speech Connect administrator login two times, and click Next.

Step 5 The Feeds Password page appears. The scfeeds login is used for automatic periodic directory updates supplied from an external data source (if available and configured). The password for the scfeeds login must be a minimum of eight characters long, and have at least one lowercase character (a-z), one uppercase character (A-Z), one numeric digit (0-9), and one special character (!"#$%&`()"+,-./:;<=>?@[\]^_'{/}~). Enter the secure Feeds password that you want to set for the Speech Connect feeds two times, and click Next.


Note The Feeds (scfeeds) account is used for remote directory updates and cannot be used as a system login. For more information about the scfeeds account, see the "Importing Employee and Department Data" chapter.


Step 6 The Network Setup page appears. Enter values in the following fields. All fields are required except for the Secondary DNS Information field.


Caution Be sure you enter the correct network setting information here. If you need to change any of this information after the installation is complete, you must use the sudo sc_sys reip command.

DNS Information:

Primary

Secondary

Domain Name

Ethernet Port 1 (device eth0): use for HTTP & VOICE access:

Host Name

IP Address

Subnet Mask

Gateway

Auto Negotiation

Speed (Full Duplex)

Mail Server

Step 7 Click Next.

Step 8 On the Timezone page, set the time zone for the system:

a. On the world map, click your approximate location.

b. If necessary to refine your selection, scroll through the list of time zones, and select the time zone that best represents where the system resides.

c. Check the System Clock Uses UTC check box.

d. Click Next.

Step 9 On the Date and Time page, set the date and time for the system:

a. In the Date box, select today's date. Click the left and right arrows to move to a different month or year.

b. In the Time box, set the hour, minute, and second of the current time in 24-hour format.

c. (Optional) Enable NTP (Network Time Protocol). This allows the Speech Connect system to synchronize its clock with a remote time server by using NTP. Check the check box next to this option to enable NTP, enter the NTP server name in the field, and click Add. You can add more than one NTP server to the list by repeating this action for each NTP server.

d. Click Next.

Step 10 The Finish screen appears. Installation is complete. Click Reboot.


Troubleshooting the Installation

If your system hangs at any time during installation or configuration, it may be because you skipped the media check in Step 4 of the "To Install the Speech Connect Operating System" procedure. If you skipped the media check, abort the installation and start over. Do not skip the media check this time.

Post-Installation Procedures

You can avoid failed calls by doing the following required post-installation steps:

1. Log into the Speech Connect interface, and verify the basic system operation. See the "Logging In and Calling the System to Verify Operation" chapter.

2. Do the Speech Connect licensing procedure. See the "Installing the Speech Connect License" section on page 5-2.

3. Configure dialing rules for outbound dialing. See the "Setting Up Dialing Rules" section on page 5-1.

4. Configure applications with operator phone numbers for day, night, weekend, and holiday modes. See the "Day and Night Settings" section on page 6-6 and the "Weekend and Holiday Settings" section on page 6-8.

5. Make sure you follow the instructions for importing employee data into the database. See the "Importing Employee and Department Data" chapter.

6. Make sure adds, changes, and deletes to employee records are made in the speakable directory by rebuilding the grammar. See the "Grammar Setup" section on page 6-11.

Setting Up Speech Connect on Speed Dial

To enhance the numberless experience of Speech Connect, employees should use speed dial to call Speech Connect. Where possible, administrators should programmatically add a Speech Connect speed dial to all employee phones. You can configure speed dials for individual users by using the Cisco Unified Communications Manager interface, or in bulk by using the Cisco Unified Communications Manager Bulk Administration tool (BAT). In locations where employees define their own speed dials, you can send instructions to users for configuring a speed dial through their User Options web pages.

For general guidelines on adding speed dials in bulk by using the bulk administration tool, see the "BAT Overview" chapter of the Cisco Unified Communications Manager Bulk Administration Guide, at http://www.cisco.com/en/US/products/sw/voicesw/ps556/prod_maintenance_guides_list.html.

For end-user instructions on configuring a speed dial through the User Options web pages, see the "Using the Phone Book and Speed Dial" chapter of the Cisco Unified Wireless IP Phone Guide for Cisco Unified Communications Manager, at http://www.cisco.com/en/US/products/hw/phones/ps379/products_user_guide_list.html.

Upgrading Speech Connect

Revised November 2008

This section describes how to upgrade a Speech Connect system.

To Upgrade a Speech Connect System


Note A backup snapshot is automatically generated during the upgrade, so you do not need to back up the system before starting this upgrade.



Step 1 Close any open browser that is running the Speech Connect interface.

Step 2 Download the SpeechConnect-1.0.3_upgrade.sh file, and copy it via sftp to the /tmp directory of the Speech Connect system.


Note SFTP transfers files in binary mode. All file downloads and transfers must be in binary mode.


Step 3 Log on to the Speech Connect system as scadmin, and then enter su - to become the root user.

Step 4 Move the file to the /common directory by entering mv /tmp/SpeechConnect-1.0.3_upgrade.sh /common.

Step 5 Enter cd /common to change to the /common directory.

Step 6 Run the upgrade sh ./SpeechConnect-1.0.3_upgrade.sh and follow the prompts.

Depending on how many spoken names are on the system, it will take between two and thirty minutes to complete the upgrade. When the upgrade is complete, the Speech Connect services will start automatically.


Note After the upgrade, we recommend that you clear the browser cache before connecting to the Speech Connect system.



Note Speech Connect supports language packs. If you are installing a language pack, see the "Installing a Language Pack" section.



Reverting an Upgraded Speech Connect System to the Previous Version

Revised July 2008

This section describes how to revert a Speech Connect system to the previous version. Do this procedure only if you installed an upgrade and want to revert to the previous version.

Reverting to a previous Speech Connect version should only be done as a last resort.

To Revert a Speech Connect System to a Previous Version


Caution It is very important to understand that following these instructions will result in data loss. Any modifications to the Speech Connect directory, employees, departments, and spoken names that were made since the previous upgrade will be deleted. All Speech Connect data will be restored to the point at which the Speech Connect system was upgraded, as the reversion process makes use of a backup that was automatically generated during the upgrade.

Step 1 Close any open browser that is running the Speech Connect interface.

Step 2 Log on to the Speech Connect system as scadmin, and then enter su - to become the root user.

Step 3 Enter cd /common/speechconnect/<previous version>. For example, enter cd /common/speechconnect/1.0.1.

Step 4 Enter ls -l. You should see the revert.sh file.

If you do not see the revert.sh file, then the system is not able to revert to a previous release, and you can stop here.

Step 5 Enter ./revert.sh to begin the reversion process.

You will see output as the reversion progresses. Depending on how many spoken names are on the system, it will take between two and thirty minutes to complete the reversion. When the reversion process is complete, the Speech Connect services will start automatically.

Step 6 Enter cd to change to the current scadmin directory.


Note We recommend that you clear the browser cache before connecting to the Speech Connect system.



Installing a Language Pack

Added July 2008

The Speech Connect system is shipped with US English language and TTS; you can optionally install a different language by installing a language pack.


Note The Speech Connect en-GB language pack is a very large download. The language pack requires approximately 550 MB of free disk space on the root file system (/) of the Speech Connect system in order to install the language pack. To verify that the Speech Connect system has sufficient space, SSH into the system as scadmin, and enter df -h.


To Install a Language Pack


Step 1 Close any open browser that is running the Speech Connect interface.

Step 2 Download the SpeechConnect-Languagepack-<language-code>-1.0.1.sh file, and copy it via sftp to the /tmp directory of the Speech Connect system.


Note The language pack version number is the version of that language pack, not the version of the core software.


Step 3 Log on to the Speech Connect system as scadmin, and then enter su - to become the root user.

Step 4 Move the file to the /common directory by entering mv /tmp/SpeechConnect-Languagepack-<language-code>-1.0.1.sh /common.

Step 5 Enter cd /common to change to the /common directory.

Step 6 Run sh ./SpeechConnect-Languagepack-<language-code>-1.0.1.sh and follow the prompts to complete the installation.

After installing a language pack, we recommend that you clear the browser cache before connecting to the Speech Connect system.


Note The system will be usable immediately after the language pack is installed. Depending on the number of employees, departments, and tiebreaker fields using TTS on the system, some names and tiebreakers may be spelled alphabetically until the TTS generation has time to complete.



Uninstalling a Language Pack

Added July 2008

Do this procedure only if you installed a language pack and want to restore the system language and TTS to US English.

When uninstalling a language pack, no loss of data will occur.

To Uninstall a Language Pack


Caution Uninstalling a language pack will reassign all applications that use that language code and TTS to US English.


Step 1 Close any open browser that is running the Speech Connect interface.

Step 2 Log on to the Speech Connect system as scadmin, and then enter su - to become the root user.

Step 3 Enter cd /common/speechconnect/languagepack-<language-code>-1.0.1.

Step 4 Enter ls -l. You should see the uninstall .sh file.

If you do not see the uninstall .sh file, then the system is not able to uninstall a language pack, and you can stop here.

Step 5 Enter ./uninstall.sh to begin the uninstall process. A message similar to the following appears.

Cisco Speech Connect Language Pack <language-code> version <version> uninstall script.
This script will remove language <language-code> support from Speech Connect.
WARNING: Answering yes to the following question will reassign all applications using language <language-code> to the default language. Support for the <language-code> language will then be removed from this system.
The Speech Connect system will be taken out of service in order to uninstall the language pack.
Are you sure you want to uninstall Speech Connect Language Pack <language-code>? (yes/no):

Step 6 Enter yes. When the language pack has been uninstalled, a message similar to the following appears.

Cisco Speech Connect Language Pack <language-code> has been removed.
You may start using the system now.


Note After installing a language pack, we recommend that you clear the browser cache before connecting to the Speech Connect system.



Changing the NTP Time Source After Installation

Added November 2008

This section describes how to change the Network Time Protocol (NTP) time source and to verify that it is being used. During Speech Connect configuration, you can set the Speech Connect server to synchronize its clock with a remote time server by using NTP. This procedure is required only if you want to change the NTP settings after the initial installation and configuration.

To Change the NTP Time Source Configuration


Step 1 On the Speech Connect server console, log on as root.


Note This procedure must be done from the Speech Connect server console. It cannot be run remotely via SSH.


Step 2 From the Applications menu, click System Settings, then click Date & Time.

Step 3 In the Date/Time Properties window, click the Network Time Protocol tab.

Step 4 Confirm that Enable Network Time Protocol is checked.

Step 5 In the NTP Servers field, enter the name or IP address of your NTP Server, and click Add.

You can add more than one NTP server to the list by repeating this action for each NTP server.

Step 6 Click OK. A window appears with the message "Contacting NTP server. Please wait."


To Verify That NTP Is Being Used


Step 1 On the Speech Connect server console (or remotely via SSH), open a terminal window and log on as root.

Step 2 Enter the following command:

ntpq -p

Step 3 A list of configured NTP servers appears.

Step 4 Look for an asterisk (*) to the left of an NTP server name. An asterisk indicates that the Speech Connect server is successfully communicating with that NTP server.


Note Normally, it takes some time for an asterisk to appear next to the NTP server. If an hour passes and no asterisk appears, your network configuration may not allow the Speech Connect server to communicate with the NTP server. Contact your Network Administrator for assistance in determining why the Speech Connect server is not synchronizing with the NTP server. For example, you may need to open UDP port 123 on your firewall to allow the NTP server to synchronize correctly.