Home | Skip to Content | Skip to Search | Skip to Navigation | Skip to Footer |
Worldwide [change] |Register |About Cisco
Guest

Hierarchical Navigation

Cisco Unified Communications Manager (CallManager)

Integration Note for Configuring the Cisco Click-to-Conference Plug-In with IBM Lotus Sametime

Downloads

Table Of Contents

Configuring the Cisco Click-to-Conference Plug-In with IBM Lotus Sametime

About the Cisco Click-to-Conference Plug-In for IBM Lotus Sametime

Overview of Components

Requirements for this Integration

Installing the Cisco Click-to-Conference Plug-In on the IBM Lotus Sametime Server

How to Configure the Cisco Click-to-Conference Plug-In on the IBM Lotus Sametime Server

Setting Cisco Click-to-Conference Plug-In Properties

Configuring the IBM Lotus Sametime Server for Cisco Click-to-Conference Plug-In Integration

How to Configure Cisco Unified Communications Manager for Cisco Click-to-Conference Plug-In Integration

Enabling Click-to-Conference Functionality on Cisco Unified Communications Manager

Configuring a SIP Trunk Security Profile

Configuring a SIP Trunk for Lotus Sametime Server

Configuring Digest Authentication on the SIP Trunk

Creating and Authenticating an Application User

How to Optimize the Cisco Click-to-Conference Plug-In Integration

Cisco Click-to-Conference Plug-in Deployment in a Mixed User Environment

Enabling and Disabling the Cisco Click-to-Conference Plug-In Functionality on a Per-User Basis

How to Troubleshoot the Cisco Click-to-Conference Plug-In Integration

Known Limitations

Joining Calls Across Clusters Fails

Cisco Unified Communications Manager Fails to Notify Dropped Conference

Incorrect Status for Participant Added into Sametime Conference via the Phone Conf Key

Enabling Detailed Logging

Getting More Information

Cisco Click-to-Conference Plug-In Release Notes

Cisco Click-to-Conference Plug-In Compatibility Matrix:

Cisco Unified Communications Manager

IBM Lotus Domino Server

IBM Lotus Sametime

Cisco Phone Control and Presence Plug-In


Integration Guide

Configuring the Cisco Click-to-Conference Plug-In with IBM Lotus Sametime

Revised: July 30, 2008

1 About the Cisco Click-to-Conference Plug-In for IBM Lotus Sametime

•Overview of Components

•Requirements for this Integration

Overview of Components

The Cisco Click-to-Conference plug-in for IBM Lotus Sametime allows users to activate an audio call with another person from a Sametime Connect client, and to invite additional people to participate in the call if required.

Administrators need to follow these configuration steps to install the Cisco Click-to-Conference plug-in on an IBM Lotus Sametime server and to configure Cisco Unified Communications Manager to handle the calls that the plug-in originates.

Figure 1 shows how the Cisco Click-to-Conference plug-in integrates with Sametime servers in the Cisco Unified Communications Manager network.

Figure 1 Cisco Click-to-Conference Plug-In Architecture

Requirements for this Integration

For this integration, ensure that you install and configure the following components:

•One of the following versions of Cisco Unified Communications Manager:

–For click-to-call functionality only —Cisco Unified Communications Manager version 6.0(1) or a later release

–For click-to-conference functionality —Cisco Unified Communications Manager version 7.0(1) or a later release

•IBM Lotus Domino Server—version 7.0 or a later release

•IBM Sametime Server and Client—versions 7.5.1 and 8.0 are supported. Version 8.0 of the IBM Sametime server is recommended as the optimum platform.

•[Optional] IBM Lotus Notes—version 8.0.1 or a later release. IBM Lotus Sametime can be integrated with IBM Lotus Notes to achieve the following:

–IBM Lotus Sametime displays in a pane within the IBM Lotus Notes client

–The native capabilities of IBM Lotus Sametime, as well as those exposed through plug-ins, can be accessed from within IBM Lotus Notes.

Related Topics

See the Release Notes for the Cisco Click-to-Conference Plug-In Integration with IBM Lotus Sametime, at the following URL:

http://www.cisco.com/en/US/products/ps9830/prod_release_notes_list.html

2 Installing the Cisco Click-to-Conference Plug-In on the IBM Lotus Sametime Server

The Cisco Click-to-Conference plug-in must be installed on the IBM Sametime server to enable call and conference functionality within the IBM Sametime Connect client.

Before You Begin

•Ensure that you have installed and configured the prerequisite software for this configuration.

•If a Click-to-Call or Click-to-Conference plug-in is already installed on the Sametime server, uninstall the existing plug-in before you install the new plug-in. To do this, click Start > Control Panel > Add or Remove Programs.

•Stop the Lotus Domino Server service on the computer where you want to install the Cisco Click-to-Conference plug-in and verify that this service is no longer running. Given that you must stop the Lotus Domino Server service on the server, it may be appropriate for you to choose to perform this install procedure after hours.

Procedure

Step 1 Browse to http://www.cisco.com/pcgi-bin/tablebuild.pl/cucplugin.

Step 2 Download the Cisco Click-to-Conference plug-in .exe file to the computer where you want to install the plug-in.

Step 3 Double-click the Cisco Click-to-Conference plug-in .exe file.

Step 4 Click Next when the InstallShield Wizard displays.

Step 5 Click Finish to complete the installation.

Troubleshooting Tips

For instructions about stopping a service, see the documentation that accompanied your operating system. For more information about stopping the Lotus Domino Server service, see the IBM Lotus Domino documentation.

Related Topics

•Requirements for this Integration

3 How to Configure the Cisco Click-to-Conference Plug-In on the IBM Lotus Sametime Server

•Setting Cisco Click-to-Conference Plug-In Properties

•Configuring the IBM Lotus Sametime Server for Cisco Click-to-Conference Plug-In Integration

Setting Cisco Click-to-Conference Plug-In Properties

You must enable Cisco Unified Communications Manager to support click-to-conference functionality from the Lotus Sametime server. The settings depend on which version of Cisco Unified Communications Manager you are currently deploying.

Before You Begin

•Stop the Lotus Domino Server service, and verify that this service is no longer running. Do not restart the Lotus Domino Server until after you have configured at least one Cisco Unified Communications Manager to integrate with the Cisco Click-to-Conference plug-in.

•Install the Cisco Click-to-Conference plug-in on the Lotus Sametime server.

•If you do not change the plug-in configuration when the plug-in is installed, the plug-in points, by default, to the Cisco Unified Communications Manager server for Release 6.x and allows only click-to-call functionality. To enable conferencing functionality, set the CUCM_VERSION variable in ClickToConfCUCM.properties to 7 or greater if you want the plug-in to point to a Cisco Unified Communications Manager server for Release 7.x.

Procedure

Step 1 Open the following file using a text editor:

ClickToConfCUCM.properties

Step 2 Navigate to the following directory on the computer where you installed the Cisco Click-to-Conference plug-in:

\lotus\domino

Step 3 Specify the following variables for your Cisco Unified Communications Manager server as required:

•CUCMx_HOST [either a hostname or IP address]

•CUCMx_PORT [defaults to port 5060 if left unconfigured]

•CUCM_VERSION

Note The CUCM_VERSION parameter in the ClickToConfCUCM.properties file does not contain a default value. Set this parameter to 7 or greater to enable click-to-conference functionality within the Sametime Connect client. If you choose not to provide a value for this parameter, the plug-in defaults to work with version 6.x of Cisco Unified Communications Manager. In addition, note that the plug-in behavior may be unpredictable if you configure an incorrect version of Cisco Unified Communications Manager.

Step 4 Specify any other parameters that are required for your installation.

Note To enable authentication, you must populate the appropriate REALMx, REALMx_USERNAME, REALMx_PASSWORD fields in the ClickToConfCUCM.properties file.

Step 5 Click Save.

Step 6 Perform the following actions:

a. Start the Lotus Domino Server service.

b. Verify that the Lotus Domino Server service is running.

Troubleshooting Tips

•A README.txt file is delivered with the installer, and contains detailed information.

•See the ClickToConfCUCM.properties file for more information about the variables that you can configure.

•For instructions about starting or stopping a service, see the documentation that accompanied your operating system. For more information about starting or stopping the Lotus Domino Server service, see the IBM Lotus Domino documentation.

Related Topics

•Installing the Cisco Click-to-Conference Plug-In on the IBM Lotus Sametime Server.

•Configuring Digest Authentication on the SIP Trunk

Configuring the IBM Lotus Sametime Server for Cisco Click-to-Conference Plug-In Integration

Before You Begin

•Stop the Lotus Domino Server service and verify that this service is no longer running. Do not restart the Lotus Domino Server until after you have configured the Lotus Sametime Server.

•Install and set the properties for the Cisco Click-to-Conference plug-in on the Lotus Sametime server.

Procedure

Step 1 Enter the following URL to access your Lotus Sametime Server:

http://server-address/stcenter.nsf

where

server-address is the domain name or IP address of your Lotus Sametime Server.

Step 2 Click Administer the Server.

Step 3 Log in to Lotus Sametime Server.

Step 4 Click Policies after you log in.

Step 5 Check Allow telephony for contact lists, instant messaging, and instant meetings.

Step 6 Perform the following actions:

a. Start the Lotus Domino Server service.

b. Verify that the Lotus Domino Server service is running.

Troubleshooting Tips

For instructions about starting or stopping a service, see the documentation that accompanied your operating system. For more information about starting or stopping the Lotus Domino Server service, see the IBM Lotus Domino documentation.

Related Topics

•Installing the Cisco Click-to-Conference Plug-In on the IBM Lotus Sametime Server.

•Setting Cisco Click-to-Conference Plug-In Properties

4 How to Configure Cisco Unified Communications Manager for Cisco Click-to-Conference Plug-In Integration

•Enabling Click-to-Conference Functionality on Cisco Unified Communications Manager

•Configuring a SIP Trunk for Lotus Sametime Server

•Configuring Digest Authentication on the SIP Trunk

•Creating and Authenticating an Application User

Enabling Click-to-Conference Functionality on Cisco Unified Communications Manager

You must enable Cisco Unified Communications Manager to support click-to-conference functionality.

Procedure

Step 1 Select System > Service Parameters in Cisco Unified Communications Manager Administration.

Step 2 Select the Cisco Unified Communications Manager server with which your Sametime server is integrated.

Step 3 Select the Cisco CallManager service.

Step 4 Perform the following tasks:

a. Locate the Enable Click-to-Conference for Third-Party Applications service parameter.

b. Set its value to True.

Step 5 Click Save.

What To Do Next

Configuring a SIP Trunk Security Profile

Related Topics

•Cisco Unified Communications Manager Administration Guide

Configuring a SIP Trunk Security Profile

You must configure a SIP trunk interface with Cisco Unified Communications Manager for click-to-conference functionality to work in Lotus Sametime. As you apply your security profile, ensure that you configure the SIP trunk for Out-Of-Dialog REFER processing.

Before You Begin

Enable Click-to-Conference functionality on Cisco Unified Communications Manager.

Procedure

Step 1 Select System > Security Profile > SIP Trunk Security Profile in Cisco Unified Communications Manager Administration.

Step 2 Click Add New in the Find and List SIP Trunk Security Profiles window.

Step 3 Enter a name and description for this SIP trunk security profile, for example, Click2Call Security Profile.

Step 4 Check Accept Out-of-Dialog REFER.

Step 5 Click Save.

What To Do Next

Configuring a SIP Trunk for Lotus Sametime Server

Related Topics

•Enabling Click-to-Conference Functionality on Cisco Unified Communications Manager

Configuring a SIP Trunk for Lotus Sametime Server

Configure a SIP trunk for Lotus Sametime Server and associate it with your SIP Trunk Security Profile.

Before You Begin

Configure a SIP trunk security profile.

Procedure

Step 1 Select Device > Trunk in Cisco Unified Communications Manager Administration.

Step 2 Click Add New in the Find and List Trunks window.

Step 3 Select SIP Trunk from the Trunk Type drop-down menu.

Step 4 For Device Protocol, accept the default value, SIP.

Step 5 Click Next.

Step 6 Enter a device name and description for this trunk, for example, Click2Call.

Step 7 For Device Pool, select Default.

Step 8 For Destination Address, enter the IP address of the Lotus Sametime Server.

Step 9 For SIP Trunk Security Profile, select the SIP trunk security profile that you created.

Step 10 For SIP Profile, select Standard SIP Profile.

Step 11 Click Save.

Step 12 Click Reset for your changes to take effect.

What To Do Next

[Optional] Configuring Digest Authentication on the SIP Trunk

Related Topics

•Configuring a SIP Trunk Security Profile

Configuring Digest Authentication on the SIP Trunk

This procedure is optional. However, we recommend that you configure digest credentials to allow only authenticated users to make and receive calls.

If you configure digest authentication for SIP trunks, Cisco Unified Communications Manager challenges the identity of the SIP user agent that connects to the trunk every time that the trunk sends a SIP request to Cisco Unified Communications Manager. The SIP user agent, in turn, can challenge the identity of Cisco Unified Communications Manager.

Before You Begin

Configure a SIP trunk for Lotus Sametime server.

Procedure

Step 1 Select System > Security Profile > SIP Trunk Security Profile in Cisco Unified Communications Manager Administration.

Step 2 Click Find in the Find and List SIP Trunk Security Profiles window.

Step 3 Click the SIP trunk security profile that you created for Cisco Click-to-Conference.

Step 4 Check Enable Digest Authentication.

Step 5 Click Save.

Step 6 Click Reset for your changes to take effect.

Step 7 Select System > Enterprise Parameters to configure the realm.

Step 8 Enter the appropriate value for the Cluster ID field.

Step 9 Click Save.

What To Do Next

Creating and Authenticating an Application User

Related Topics

•Configuring a SIP Trunk for Lotus Sametime Server

Creating and Authenticating an Application User

If you enable digest authentication on the SIP trunk, and allow Cisco Unified Communications Manager to challenge the identity of the SIP user agent, you must create an application user and provide the credentials for SIP authentication.

Before You Begin

•Configure digest authentication on the SIP trunk.

•To enable authentication, you must populate the appropriate REALMx, REALMx_USERNAME, REALMx_PASSWORD fields in ClickToConfCUCM.properties file, and then restart the Domino server for the changes to take effect.

Procedure

Step 1 Select User Management > Application User.

Step 2 Click Add New in the Find and List Application Users window.

Step 3 Enter and confirm the User ID and password of the application user.

Step 4 Enter and confirm the digest credentials for the application user.

Step 5 Check Accept Out-of-dialog REFER.

Step 6 Click Save.

Step 7 Select System > Security Profile > SIP Trunk Security Profile.

Step 8 Click Find in the Find and List SIP Trunk Security Profiles window.

Step 9 To add the new application user to the profile, click the SIP trunk security profile that you created for the Cisco Click-to-Conference plug-in.

Step 10 Click Reset for your changes to take effect.

Related Topics

•Configuring Digest Authentication on the SIP Trunk

5 How to Optimize the Cisco Click-to-Conference Plug-In Integration

•Cisco Click-to-Conference Plug-in Deployment in a Mixed User Environment

•Enabling and Disabling the Cisco Click-to-Conference Plug-In Functionality on a Per-User Basis

Cisco Click-to-Conference Plug-in Deployment in a Mixed User Environment

This document covers the Click-to-Conference server-side plug-in that works with IBM Lotus SameTime version 7.5.1 and version 8.0. A client plug-in, called Cisco Phone Control and Presence, is also available to enable phone control of Cisco IP Communicator from the Sametime Connect client.

Your organization may need to deploy the Cisco Click-to-Conference plug-in for some users of IBM Sametime and the Cisco Phone Control and Presence plug-in for others. Cisco will support the simultaneous deployment of both plug-in types on a single Sametime server. However, we recommend that you do not allow users simultaneous access to both plug-ins.

In a mixed user environment, you should disable the Click-to-Conference plug-in for any users who are using another call or conferencing plug-in. You can create multiple policies and do the following:

•assign users of the Click-to-Conference server plug-in to a policy that has telephony enabled

•assign users of any other client plug-in to a policy that has telephony disabled

What To Do Next

•Enabling and Disabling the Cisco Click-to-Conference Plug-In Functionality on a Per-User Basis

Enabling and Disabling the Cisco Click-to-Conference Plug-In Functionality on a Per-User Basis

You can configure a new policy on the Lotus Sametime Server, assign users to it, and enable or disable the functionality provided by the Cisco Click-to-Conference plug-in.

Before You Begin

Review the rational for enabling and disabling Click-to-Conference functionality in a mixed plug-in environment.

Procedure

Step 1 Enter the following URL to access the IBM Lotus Sametime Server:

http://server-address/stcenter.nsf

where

server-address is the domain name or IP address of your Lotus Sametime Server.

Step 2 Click Administer the Server.

Step 3 Log in to Lotus Sametime Server.

Step 4 Click Policies after you log in.

Step 5 Click New.

Step 6 Enter a name and description for the new policy.

Step 7 Select the policy attributes to enable or disable telephony, and click OK.

Step 8 Click Assign Users.

Step 9 Perform the following actions in the Assign Users window:

•Select the directory from which to add users or groups to the policy.

•Search for or enter the names of the users or groups to add to the policy

•Add the selected users to the policy.

•Click OK.

Step 10 Complete the following actions to ensure your policy changes take effect:

•Restart the Lotus Domino Server service.

•Verify that the Lotus Domino Server service is running.

Related Topics

•Cisco Click-to-Conference Plug-in Deployment in a Mixed User Environment

•For more information about configuring the IBM Lotus Sametime server, see http://www-128.ibm.com/developerworks/lotus/documentation/sametime/

6 How to Troubleshoot the Cisco Click-to-Conference Plug-In Integration

•Known Limitations

•Enabling Detailed Logging

Known Limitations

•Joining Calls Across Clusters Fails

•Cisco Unified Communications Manager Fails to Notify Dropped Conference

•Incorrect Status for Participant Added into Sametime Conference via the Phone Conf Key

Joining Calls Across Clusters Fails

Problem

If you use version 7.5.1 of Sametime, you cannot join calls across clusters. Joining click-to-call and click-to-conference functionality in different clusters results in the participant involved in both calls being unable to leave the conference via the GUI.

Cause

A call is active in Sametime Connect. A user in the call creates a separate audio call with a user in another cluster. The "Join" softkey is used to join the calls.

Solution

No workaround exists. You must hang up the phone to end the call.

Cisco Unified Communications Manager Fails to Notify Dropped Conference

Problem

Cisco Unified Communications Manager will drop the entire conference call under these conditions:

•The Cisco Unified Communications Manager service parameter called "Drop Ad Hoc Conference" is set to "When Conference Controller Leaves."

•The moderator of the conference drops the call.

Cisco Unified Communications Manager fails to notify the Sametime server that the entire conference has dropped. As a result, all the participants except the controller still appear to be "Connected" on Sametime.

Cause

This condition occurs when the Cisco Unified Communications Manager service parameter "Drop Ad Hoc Conference" is set to "When Conference Controller Leaves"or "When No OnNet Parties Remain in the Conference".

Solution

No workaround exists. You must close your Sametime call windows.

Incorrect Status for Participant Added into Sametime Conference via the Phone Conf Key

Problem

If you add a user via the desk phone CONF key into a conference that has been established via the SameTime GUI, the GUI will diplay an incorrect status when that user hangs up the desk phone and exits the call. The SameTime GUI will display the status of the user as being connected to the other parties still involved in the call.

Cause

This condition occurs if you use the CONF key on a desk phone to add a user into a conference that was pre-established via the SameTime GUI.

Solution

Close the SameTime GUI to clear the incorrect status for the user. Add participants via the SameTime GUI if possible.

Enabling Detailed Logging

If you experience problems with your Cisco Click-to-Conference plug-in integration, navigate to the Trace folder under the Domino directory, and look for warning or error messages in the log files located on the Sametime Server.

Table 1 identifies the files that control logs and debugs, and your troubleshooting next steps.

Table 1 Cisco Plug-in Log Files

Filename
File Function
Problem Resolution

telephony_x.log

By default, this file stores the Click-to-Call plug-in service logs.

Increase the amount of information recorded in this log.

For instructions about how to configure increased log verbosity, see SametimeDiagnostics_Telephony.properties. This file controls the type of information that gets logged and the amount of information that gets recorded for the Click-to-Conference plug-in service and sessions.

c2c_sip_combined.log

By default, this file stores the SIP library debugs.

Increase the amount of information recorded in thislog.

For instructions about how to configure increased log verbosity, see log4j.properties. This file controls the type of information that gets logged and the amount of information that gets recorded for the SIP library debugs.

c2c_sip_wire.log

By default, this file stores the SIP wire debugs.

Increase the amount of information recorded in thislog.

For instructions about how to how to configure increased log verbosity, see log4j.properties. This file controls the type of information that gets logged and the amount of information that gets recorded for the SIP wire (signalling) debugs.


7 Getting More Information

Cisco Click-to-Conference Plug-In Release Notes

See the Release Notes for the Cisco Click-to-Conference Plug-In with IBM Lotus Sametime at this URL: http://www.cisco.com/en/US/products/ps9830/prod_release_notes_list.html

Cisco Click-to-Conference Plug-In Compatibility Matrix:

For documentation about the supported and recommended plug-in configurations, see the following URL: http://www.cisco.com/en/US/docs/voice_ip_comm/cups/7_0/english/integration_notes/SametimeClickToCallPluginCompatibilityMatrix-2.pdf

Cisco Unified Communications Manager

For Cisco Unified Communications Manager documentation, see the following URL:

http://www.cisco.com/en/US/products/sw/voicesw/ps556/tsd_products_support_series_home.html

IBM Lotus Domino Server

For information about installing or upgrading IBM Lotus Domino Server, see the following URL:

http://www-128.ibm.com/developerworks/lotus/documentation/domino/

IBM Lotus Sametime

•Forinformation about installing and configuring Lotus Sametime, see the following URL:

http://www-128.ibm.com/developerworks/lotus/documentation/sametime/

•For more user support information on Lotus Sametime, see the following URL:

http://www-1.ibm.com/support/docview.wss?rs=477&uid=swg21195515

Cisco Phone Control and Presence Plug-In

For information about installing and using the Cisco Phone Control and Presence plug-in for IBM Lotus Sametime, see the following URL:

http://www.cisco.com/en/US/products/ps9830/prod_installation_guides_list.html