Poly Video Control Application Administrator Guide

November 2007 Edition

3725-26448-004/A

Administrator’s Guide for the

Polycom® Video Control Application

(VCA)

Version 1.1

Polycom Inc.

4750 Willow Road

Pleasanton, CA 94588-2708

USA

No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for

any purpose, without the express written permission of Polycom, Inc. Under the law, reproducing includes translating

into another language or format.

As between the parties, Polycom, Inc. retains title to, and ownership of, all proprietary rights with respect to the software

contained within its products. The software is protected by United States copyright laws and international treaty

provision. Therefore, you must treat the software like any other copyrighted material (e.g. a book or sound recording).

Every effort has been made to ensure that the information in this manual is accurate. Polycom, Inc. is not responsible

for printing or clerical errors. Information in this document is subject to change without notice.

Trademark Information

Polycom® and the Polycom logo design are registered trademarks and HDX™, PathNavigator™, and VSX™ are

trademarks of Polycom, Inc. in the United States and various other countries. All other trademarks are the property of

their respective owners.

Patent Information

The accompanying product is protected by one or more U.S. and foreign patents and/or pending patent applications

held by Polycom, Inc.

iii

About this Guide

This guide describes how to install, configure, and troubleshoot the Polycom®

Video Control Application (VCA) on the Cisco® Unified Application

Environment (CUAE) server, as well as how to create the proper phone

services on the Cisco Unified Communications Manager platform (also called

the Cisco CallManager).

This guide is intended for system administrators who are already familiar

with the CUAE and the Cisco CallManager.

For information about using the VCA, refer to the Polycom Video Control

Application (VCA) Quick Reference. Additional Polycom documentation is

available at the Polycom web site, http://www.polycom.com.

For support or service related to the Cisco Unified Application Environment,

Cisco CallManager, or Cisco IP telephony, please contact Cisco Support or

your reseller’s Support. For support or service related to the Polycom Video

Control Application or Polycom video conferencing systems, please contact

your Polycom distributor or go to Polycom Support at

www.polycom.com/support.

Administrator’s Guide for the Polycom Video Control Application (VCA)

iv

Contents

v

Contents

Installing the Polycom Video Control Application . . . . . . . . 1-1

Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Collecting IP Phone and Video Endpoint Information . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2

Obtaining Your Software License Key Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2

Installing the Polycom VCA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

Upgrading the Polycom VCA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8

Uninstalling the VCA Provider and Application from the CUAE Server . . . . . . . . . . . 1-8

Uninstalling the Polycom VCA Application Files and the CUAE Video Endpoint

Administrator Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13

Configuring the Polycom Video Control Application . . . . . . 2-1

Uploading and Configuring the Polycom VCA Provider . . . . . . . . . . . . . . . . . . . . 2-2

Uploading and Configuring the Polycom VCA Application Scripts and URLs . . 2-5

Adding Polycom VCA Services to the Cisco Unified CallManager . . . . . . . . . . . . 2-8

Configuring the Optional “Convert to Video” Service . . . . . . . . . . . . . . . . . . . . . 2-11

Applying the Cisco Hotfix to CUAE Version 2.4.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11

Creating the Polycom JTAPI User on the Cisco Unified CallManager . . . . . . . . . . . . . 2-12

Setting Up CUAE for the “Convert to Video” Service . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15

Adding Polycom Video Endpoints to the Cisco Unified CallManager . . . . . . . . 2-21

Running the Video Endpoint Administrator Tool . . . . . . . . . . . . . . . . . . . . . . . . . 2-24

Activating the VCA Software License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-24

Making IP Phone to Video Endpoint Associations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-25

Subscribing Cisco IP Phones to VCA Services and Creating Shortcuts . . . . . . . . 2-27

Uninstalling the Polycom Video Control Application . . . . . . 3-1

Removing Polycom VCA Services from the Cisco Unified CallManager . . . . . . . 3-2

Removing the Optional VCA “Convert to Video” Service . . . . . . . . . . . . . . . . . . . 3-5

Resetting Cisco IP Phones that were Previously Running the Polycom VCA . . 3-12

Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Common Problems and Corrective Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Polycom VCA Application Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4

Configuring VCA Logging Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4

Collecting the VCA Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6

Using the Audit Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8

Contacting Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11

Administrator’s Guide for the Polycom Video Control Application (VCA)

vi

1 - 1

1

Installing the Polycom Video Control

Application

This chapter lists the pre-installation requirements, suggests what information

you should collect before you begin the installation, and describes how to

obtain the software license key and product license. This chapter also lists the

steps you need to take to install the VCA. If you already have the VCA

installed and want to upgrade it, this chapter explains how to uninstall the

VCA before you begin the upgrade.

Before You Begin

Before installing the Polycom VCA software, you must have the following:

• Cisco Unified CallManager Version 4.1 or later installed and operational.

If you are using the SCCP protocol, you must also have the Polycom SCCP

CallManager plug-in, available at http://www.polycom.com/usa/en

/support/video/vsx_series/vsxsccp.html.

• Cisco Unified Application Environment Version 2.4.1 or later installed

and operational.

• Cisco 7970 IP phones (which will run the VCA) installed and operational.

• One of these hardware models:

— HDX™ 9004, HDX 9002, HDX 9001, HDX 8000, or HDX 4000.

— VSX™ 8000, VSX 7000e, VSX 7000s, VSX 6000, VSX 5000, VSX 3000,

V700, or V500.

• One of these software versions:

— HDX software Version 1.0.2 or later.

— VSX software Version 8.5.3 or Version 8.7 or later for H.323 endpoints.

— VSX software Version 8.6.2 for SCCP endpoints.

Administrator’s Guide for the Polycom Video Control Application (VCA)

1 - 2

• For H.323 endpoints only:

— Must be registered to an H.323 gatekeeper, such as Polycom

PathNavigator™.

— Must have an E.164 extension assigned to the endpoint.

Collecting IP Phone and Video Endpoint Information

To help facilitate the VCA configuration process, Polycom recommends that

you collect the following information for each Cisco 7970 IP phone and

Polycom video endpoint:

• Cisco 7970 IP phone:

— IP address

— MAC address (if enabling the “Convert to Video” service)

— Dialing extension

• Polycom video conferencing system:

— IP address

— Dialing extension

— Whether or not the camera is movable

— Whether or not the remote password is enabled (if it is enabled, record

the password)

Obtaining Your Software License Key Code

To properly activate the VCA, you must have both your VCA software license

(a sheet of paper that is shipped to the main customer contact who placed the

order) and your VCA software license key code.

To obtain your software license key code:

1. Go to http://extranet.polycom.com/.

2. Log in or create a new user account.

3. In the Activate Products list, click Video.

4. Enter the Polycom software license number listed on your VCA Software

License Certificate.

5. Click Generate.

6. When the license number appears, record it.

Installing the Polycom Video Control Application

1 - 3

Installing the Polycom VCA

The VCA installation package features the following components:

• Polycom Video Control Application - The software application that runs

within the Cisco Unified Application Environment (CUAE). When

installing the Video Control Application, you must install both the VCA

Provider and the Application scripts.

• Polycom CUAE Video Endpoint Administrator - A software tool that

allows you to configure the VCA Application database. This tool can be

run on the CUAE server itself (by default) or from a remote desktop that

has MySQL administrator tools installed.

To install the Polycom VCA Provider and Application:

1. Download the

PolycomVideoControlApplication.zip

file from

http://www.polycom.com/usa/en/support/video/video.html.

2. Unzip the file to the CUAE server or to the network drive that is

accessible from the CUAE Server.

When you do so, a folder called

Disk1

is created.

3. Click

Setup.exe

in the

Disk1

folder.

Note

IMPORTANT: If this is the first time you install the VCA, follow the steps in this

section. If you are upgrading the VCA, you must first uninstall the VCA as described

in the Upgrading the Polycom VCA section on page 1-8, and then you can you

re-install the VCA as described here.

Note

IMPORTANT: Be sure to download the VCA software that is appropriate for the

version of CUAE that you are running. The versions are clearly marked on the

Downloads section of the Polycom VCA Support web page. VCA software created

for CUAE Version 2.3 will not run on CUAE Version 2.4 or later.

Administrator’s Guide for the Polycom Video Control Application (VCA)

1 - 4

The InstallShield Wizard begins.

4. Click Next, and then accept the Polycom software license agreement.

Installing the Polycom Video Control Application

1 - 5

5. Click Next, and then enter the name and organization.

6. Click Next, and then select Complete or Custom.

Administrator’s Guide for the Polycom Video Control Application (VCA)

1 - 6

Select Custom if you want to install the Polycom CUAE Video Endpoint

Administrator on another system.

Note

If you are installing the CUAE Video Endpoint Administrator on a system other than

the CUAE server, the target system must have a copy of My SQL Library and the

Microsoft .NET Framework Version 1.1 available on it in order to remotely connect

to the VCA Application database.

Polycom does not redistribute these files with the CUAE Video Endpoint

Administrator installation.

Installing the Polycom Video Control Application

1 - 7

7. Click Next, and then click Install to begin the installation.

8. When you finish the installation, click Finish. You can then begin

configuring the Polycom VCA as described in the next chapter.

Administrator’s Guide for the Polycom Video Control Application (VCA)

1 - 8

Upgrading the Polycom VCA

In order to upgrade the VCA, you must first:

• Uninstall the VCA Provider and Application from the CUAE server.

• Uninstall the Polycom VCA application files and the CUAE Video

Endpoint Administrator tool from your system.

When you have completed doing this, you can re-install the VCA as described

in the Installing the Polycom VCA section on page 1-3.

Uninstalling the VCA Provider and Application from the CUAE Server

To uninstall the VCA Provider and Application from the CUAE server:

1. Log in to the CUAE Management Console.

Installing the Polycom Video Control Application

1 - 9

2. Click Providers.

3. Click Polycom CUAE Video Endpoint API.

Administrator’s Guide for the Polycom Video Control Application (VCA)

1 - 10

4. Click Disable Provider.

5. Click Uninstall Provider.

Installing the Polycom Video Control Application

1 - 11

6. Click Yes.

7. Navigate back to the CUAE Main Control Panel and click Applications.

Note

• Uninstalling the Provider and Application will not remove the VCA Application

database. All of the device association configurations that you made in the

previous revision will be preserved.

• Depending upon the type of upgrade you are performing, you may need to

generate a new software license key code. Refer to the release notes that

accompany the software upgrade for more information.

Administrator’s Guide for the Polycom Video Control Application (VCA)

1 - 12

8. Click Polycom Video Control Application.

9. Click Disable Application.

Installing the Polycom Video Control Application

1 - 13

10. Click Uninstall Application.

11. Click Yes.

12. Log out of the CUAE Management Console.

Uninstalling the Polycom VCA Application Files and the CUAE Video Endpoint

Administrator Tool

To uninstall the Polycom VCA application files and the CUAE Video Endpoint

Administrator tool:

1. From the CUAE server’s Windows Control Panel (or from the Windows

Control Panel of any desktop where you installed the Polycom CUAE

Endpoint Administrator tool), select Add or Remove Programs.

Administrator’s Guide for the Polycom Video Control Application (VCA)

1 - 14

2. Select Polycom Video Control Application.

3. Click Remove.

4. Click Yes.

The Polycom Video Control Application is removed from your system.

Note

If you now want to re-install the VCA, perform the steps in the Installing the

Polycom VCA section on page 1-3.

Page is loading ...

Poly Video Control Application Administrator Guide

Related papers

Other documents