Guest

Cisco Unified Communications with IBM Lotus

Integration Note for Deploying Cisco Phone Control and Presence 8.6 with IBM Lotus Sametime

  • Viewing Options

  • PDF (267.4 KB)
  • Feedback
Integration note

Table Of Contents

Deploying Cisco Phone Control and Presence 8.6 with
IBM Lotus Sametime

Deploying the Phone Control and Presence Plug-in

Installation Methods

Deployment Overview

How to Set Up the Plug-in Update Site

Setting Up Your Local Working Directory

Creating Dial Rule Files

Configuring LDAP Settings for Cisco Phone Control and Presence

Configuring Phone Control and Presence

Setting Up the JTAPI Plug-in

How to Set Up the IBM Status Extender Plug-in

Enabling Phone Status for Standalone Implementations of IBM Lotus Sametime 8.5.1 or later

Enabling Phone Status for Embedded Implementations of IBM Lotus Sametime 8.5.1 or later

Uploading the Files to the Update Site

Configuring Cisco Unified Communications Manager to Set Up a Secure CTI Connection for Users

How to Prepare Users to Set Up and Use the Plug-in

Configuration Information

Installation in a Citrix Environment

Synchronization of Plug-in Credentials

LDAP Phone Pre-loading

Enhanced LDAP Phone Search Options

Secure LDAP

Enabling Live Text Support

Troubleshooting

Using Logging to Troubleshoot Issues

Phone Control and Presence Not Showing Presence Information for the Contact List

An IBM Lotus Sametime Contact Does Not Display Contact Information Such As Icon/Title/Status During a Call

Secure CTI Connection to Cisco Unified Communications Manager Fails

Finding Documentation

Tips for Searching Cisco Documentation


Integration note

Deploying Cisco Phone Control and Presence 8.6 with
IBM Lotus Sametime


Published: 12/21/11

1 Deploying the Phone Control and Presence Plug-in

Installation Methods

Deployment Overview

Installation Methods

There are multiple methods for installing the Phone Control and Presence plug-in on user workstations:

You can set up IBM Lotus Sametime to automatically install the plug-in on user workstations. Refer to the IBM Lotus Sametime documentation for information on how to set up a push update. We recommend this method.

Users can manually install the plug-in on their workstations. With this method, you must provide users with the URL of the update site.

For complete installation details, refer to the Quick Start Guide for Installing and Using Cisco Phone Control and Presence 8.0 with IBM Lotus Sametime available at http://www.cisco.com/en/US/products/ps9830/products_user_guide_list.html.


Note IBM Lotus Notes does not support an automatic push update, but you can configure your installation to use a Notes widget to create similar behavior. You must first run the Configuration Tool and then follow the instructions available at the following URL: http://publib.boulder.ibm.com/infocenter/domhelp/v8r0/index.jsp?topic=/com.ibm.help.domino.admin85.doc/H_CLIENT_MGMNT_OVER.html


Deployment Overview

Table 1 Phone Control and Presence Deployment Tasks

Task
Notes
For details, see...

Gather the requirements.

Required. You must be familiar with the requirements and supported versions of software for the system, including user workstations.

Release Notes for Cisco Phone Control and Presence with IBM Lotus Sametime at: http://www.cisco.com/en/US/products/ps9830/prod_release_notes_list.html

Decide which features to enable for all users.

Recommended. Familiarize yourself with the available features. You will use the information when you set up the update site.

Release Notes for Cisco Phone Control and Presence with IBM Lotus Sametime at: http://www.cisco.com/en/US/products/ps9830/prod_release_notes_list.html

Provision users in Cisco Unified Communications Manager.

Required. Users must be set up correctly with the devices that they will use with the plug-in.

Cisco Unified Communications Manager Administration Guide

Cisco Unified Communications Manager System Guide

You can find documents here:

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

Associate users with the Standard
CTI- Enabled user group in Cisco Unified Communications Manager.

Required if users use the Control Desk Phone feature of the plug-in.

Cisco Unified Communications Manager System Guide, "Computer Telephony Integration" section

You can find documents here:

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

Refer to existing dialing rules in Cisco Unified Communications Manager.

Recommended if users use the plug-in in Control Desk Phone mode.

Cisco Unified Communications Manager Administration Guide.

You can find documents here:

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

Verify application dial rules are set up in Cisco Unified Communications Manager and they are provisioned to Cisco IP Communicator. If not, run the Cisco IP Communicator Directory Wizard.

Required if users use the Dial Using Cisco IP Communicator feature.

Cisco Unified Communications Manager Administration Guide.

You can find documents here:

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

Provision users in Cisco Unified Presence.

Required if users use the Enable Phone Status feature of the plug-in.

Cisco Unified Presence documentation. You can find documents here:

http://www.cisco.com/en/US/products/ps6837/tsd_products_support_general_information.html

Configure Cisco Unified Communications Manager Capability Assignments to enable licenses for Cisco Unified Presence.

Required if users use the Enable Phone Status feature of the plug-in.

For license requirements—Release Notes for Cisco Phone Control and Presence with IBM Lotus Sametime at: http://www.cisco.com/en/US/products/ps9830/prod_release_notes_list.html

For configuration instructions—Cisco Unified Communications Manager Administration Guide, "License Capabilities Assignment Configuration" section.

You can find documents here:

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

Configure Cisco Unified Communications Manager for secure CTI connections.

Optional. This enables a secure CTI connection between IBM Lotus Sametime and the Cisco Unified Communications Manager server for users.

Configuring Cisco Unified Communications Manager to Set Up a Secure CTI Connection for Users

Set up the plug-in for Cisco Unified Messaging with IBM Lotus Sametime.

Optional. This allows users to view and play Cisco Unity or Cisco Unity Connection voice messages directly from their Sametime Connect client application.

Release notes for Cisco Unified Messaging with IBM Lotus Sametime Release at:

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

Set up the plug-in on the Sametime server update site.

Required. Involves configuring and packaging the plug-in software, IBM Status Extender plug-in, and dialing rules files (if applicable), on the update site.

How to Set Up the Plug-in Update Site

Set up a push update.

Optional. If you do not set up a push update, users must manually install the plug-in on their client workstations.

Installation Methods

Prepare users to install and use the plug-in.

Recommended. Provide users with the information they need to install and configure, and use the plug-in for your deployment, including information about how to get support.

How to Prepare Users to Set Up and Use the Plug-in


2 How to Set Up the Plug-in Update Site

If you are enabling the Control Desk Phone option, you must set up separate update sites for users who are using different versions of Cisco Unified Communications Manager, and for users who have different dialing rules.

Setting Up Your Local Working Directory

Creating Dial Rule Files

Configuring LDAP Settings for Cisco Phone Control and Presence

Configuring Phone Control and Presence

Setting Up the JTAPI Plug-in

How to Set Up the IBM Status Extender Plug-in

Uploading the Files to the Update Site

Configuring Cisco Unified Communications Manager to Set Up a Secure CTI Connection for Users

Setting Up Your Local Working Directory

Procedure


Step 1 Create a local working directory to hold the plug-in files for processing.

Step 2 Go to the Cisco Unified Communications with IBM Lotus download page.

http://tools.cisco.com/support/downloads/go/Redirect.x?mdfid=282224966

Step 3 Sign in as a registered Cisco.com user.

Step 4 Select your release.

Step 5 Download the file Cisco_Plugins_8.6.1.zip.

Step 6 Extract the file CiscoPCAPWithLotusST_8.6.1.1185.zip from the downloaded zip file.

Step 7 Extract the files from the zip file to the directory that you created in Step 1.

Step 8 If you are adding the plug-in to an existing update site, replace the extracted site.xml file in the CiscoPCAPWithLotusST_8.6.1.1185/UpdateSite directory with a copy of the site.xml file from the existing update site.


Note If Cisco Unified Messaging with IBM Lotus Sametime is also being deployed, copy all the .jar files from the UpdateSite/plugins and UpdateSite/features directories of that package to the respective directories in this package. This creates a combined update site so that the plug-ins can be configured together. If using the IBM Lotus Notes Widget-based deployment, do not combine update sites. Use one feature per widget.



What to Do Next

If you are enabling the Control Desk Phone option, continue to the Creating Dial Rule Files. Otherwise, skip to the Configuring Phone Control and Presence.

Creating Dial Rule Files


Note If you are deploying the plug-in with only the Dial Using Cisco IP Communicator option, this section does not apply. Skip to the Configuring Phone Control and Presence.


Include dialing rules files with the plug-in files if you are deploying with the Control Desk Phone option. Dial rule files enable the plug-in to correctly process outgoing and incoming calls.

In XML format, replicate the dial and directory lookup rules configured in the Cisco Unified Communications Manager.

Procedure


Step 1 Open the applicationdialrules.xml file in the templates directory of the Configuration Tool, CiscoCfg-8.6.1.134.zip, using a text editor such as Notepad or Vim.

The file has the following structure:

<?xml version="1.0" encoding="UTF-8"?>
<DialRules>
  <DialRule NumDigits="" BeginsWith="" DigitsToRemove="" PrefixWith=""/>
  <DialRule NumDigits="" BeginsWith="" DigitsToRemove="" PrefixWith=""/>
</DialRules>
 
   

Step 2 Refer to the dialing rules created in Cisco Unified Communications Manager Administration to fill in the applicable attributes for a dial rule and to complete the set of rules.

Order DialRule elements from highest to lowest priority, as they are configured in Cisco Unified Communications Manager. Note that the smaller the priority number, the higher the priority.

Step 3 Save the file.

Step 4 If Cisco Unified Communications Manager is configured with directory lookup rules, repeat Step 1 through Step 3 with the directory lookup rules, using the directorylookuprules.xml template file.


Troubleshooting Tips

Refer to the applicable version of Cisco Unified Communications Manager documentation for information about where application and directory lookup dial rules are configured.

What to Do Next

Continue to the next section, Configuring LDAP Settings for Cisco Phone Control and Presence.

Configuring LDAP Settings for Cisco Phone Control and Presence


Note The default LDAP settings provided are representative of common configurations. Administrators should determine if these settings are appropriate for their specific configurations and change as necessary.


The use of LDAP with Cisco Phone Control and Presence is optional. However, if you do not use LDAP, some of the Phone Control and Presence functionality is diminished. Phone Control and Presence uses LDAP for the following reasons:

To resolve incoming callers as a Sametime contact. Sametime does not provide a way to look up a contact using a phone number. Without LDAP, incoming calls display the caller number without a contact name, since the number cannot be mapped to a Sametime contact without LDAP.

To retrieve additional phone numbers for Sametime contacts. Without LDAP, only the primary number from the Business Card is used.

To provide an additional way to map a Sametime contact to a Cisco Unified Presence user in order to retrieve the phone status for that user. If this mapping can be achieved using an attribute from the Business Card, then the phone status can be retrieved without using LDAP.

If you are using LDAP, Cisco Unified Communications Manager and the Lotus Sametime server should use the same LDAP directory server, or the directory servers must use the same unique user ID to represent the same user in each directory.


Note LDAP settings are connected to other tabs in the Configuration Tool. If you make changes to the LDAP settings and save the settings, you must also navigate to the Phone Control and Presence tab, and select Save from the File menu before exiting.


Procedure


Step 1 Go to the ciscocfg directory of the extracted files.

Step 2 Double-click ciscocfg.exe to start the Configuration Tool.

Step 3 Specify the location of the local working CiscoPCAPWithLotusST_8.6.1.1185/UpdateSite directory on the Update Site Selection window.

Step 4 Select OK.

Step 5 Select the LDAP tab and enter the values in the applicable fields.

Table 2 LDAP Tab Fields

Name
Description
Directory Server Settings

Used to define the directory and relevant attributes the plug-in can search to find user names based on incoming phone numbers.

Server

Enter the name or IP address of the LDAP server.

Port

Enter the number of the port used to communicate with the LDAP server.

Search Base

Enter the base (or root) of the directory service in which to search for names. The value must match the one configured on the Sametime server. If LDAP is used for the directory service, you can derive the setting directly from there. If Domino is used instead, find the equivalent search base on its LDAP interface.

Display Name Attribute

Enter the LDAP attribute that is used as the display name for the caller.

Attribute for Lookup in Sametime

Enter the LDAP attribute that is used to search for the caller in Sametime.

Authentication Required

Check this option if authentication is required by the server.

Authentication Credentials

Distinguished Name

(When authentication is enabled) Enter the distinguished name that is used to authenticate with the directory service.

Password

(When authentication is enabled) Enter the password that is used to authenticate with the directory service.

Directory Usage

Non-default Community Access

Enable non-default communities to use directory services to extend the functions to pilot communities, for example:

Retrieve phone numbers to populate their contacts

Show phone status for their contacts

Only one set of users data can be used. You can have two communities, but of the same global set of users. If the Sametime server for the non-default communities uses the same LDAP server as the default community, then identical functionality can be extended to contacts in those communities.

Select the applicable setting:

Disable—Select this option so that non-default communities are unable to use the directory service.

Enable for All Communities—Select this option so that all non-default communities are allowed to use the directory service.

Enable for Configured Communities—Select this option so that only communities listed in the Community List field are allowed to use the directory service.

Community List

(When Enable for Configured Communities is selected above) Enter the list of communities (Sametime host name or IP address), separated by commas, that you want to allow access to the directory service.

Directory Type for Sametime Server

Directory Type

Enter the applicable settings:

LDAP—Select this option if the IBM Lotus Sametime server uses an LDAP server for directory service.

If IBM Lotus Sametime uses an LDAP attribute for the internal user ID, check the Use Attribute as Internal ID of Sametime User option and enter the name of the LDAP attribute.

Domino—Select this option if the IBM Lotus Sametime server uses IBM Lotus Domino for the directory service.

Refer to the IBM Lotus Sametime documentation for additional information.

Dialing Rules Files

Application Dial Rules

If you will use Application Dial Rules, enter the location of the dial rules file. You can obtain Application Dial Rules from the Cisco Unified Communications Manager administrator web page by navigating to the Call Routing area.

Application Dial Rules automatically strip numbers from or add numbers to telephone numbers that Sametime Connect dials. For example, the dialing rules automatically add the digit 9 in front of a 7-digit telephone number to provide access to an outside line.

Note A file template is available in the templates directory where you extracted the Cisco Unified Messaging with Lotus Sametime Configuration Tool.

Directory Lookup Dial Rules

If you will use Directory Lookup Dial Rules, enter the location of the dial rules file. You can obtain Directory Lookup Dial Rules from the Cisco Unified Communications Manager administrator web page. Navigate to the Call Routing area.

Directory Lookup Dial Rule transform caller identification numbers into numbers that can be looked up in the directory. For example, the dialing rules can automatically add +140852 to 5-digit numbers beginning with 5, so that the number 56666 becomes +14085256666.

Note A file template is available in the templates directory where you extracted the Cisco Unified Messaging with Lotus Sametime Configuration Tool.


Step 6 Select Save from the File menu in the Configuration Tool window.


Note You must save the Phone Control and Presence tab when you make changes to the LDAP tab.



What to Do Next

Continue to the next section, Configuring Phone Control and Presence.

Configuring Phone Control and Presence


Note The default settings provided are representative of common configurations. Administrators should determine if these settings are appropriate for their specific configurations and change as necessary.


Use the Configuration Tool to specify the update site files and to configure settings that apply to users of the plug-in. You can use the tool for configuring new installations of the plug-in, and for updating user configuration information once the plug-in is installed.

For configuration changes to take effect, you must either set up IBM Lotus Sametime to automatically update users by using a push update, or instruct users to update the plug-in from their IBM Lotus Sametime Connect client.

Before You Begin

Understand that your saved field settings will overwrite corresponding user settings when the configuration feature installs on client workstations.

Several fields in the utility have a Read Only option. Select Read Only if you do not want users to change that setting in Sametime Connect.

Extract the plug-in configuration utility—CiscoCfg-8.6.1.134.zip — from the Cisco_Plugins_8.6.1.zip. Extract the files from this zip file to your local working directory.

Procedure


Step 1 Go to the ciscocfg directory of the extracted files.

Step 2 Double-click ciscocfg.exe to start the Configuration Tool.

Step 3 Specify the location of the local working CiscoPCAPWithLotusST_8.6.1.1185/UpdateSite directory on the Update Site Selection window.

Step 4 Select OK.

Step 5 Select the Phone Control and Presence tab and enter the values in the applicable fields.

Table 3 Phone Control and Presence Tab Fields

Name
Description
Feature Control

Enable Phone Status

Select this option to activate phone status for all users.

Enable Dial Using Cisco IP Communicator

Select to enable for all users. You can select both Cisco IP Communicator and Desk Phone. This allows your users to toggle between their softphone and controlled desk phone.

Enable Control Desk Phone

Select to enable for all users. You can select both Cisco IP Communicator and Desk Phone. This allows your users to toggle between their controlled desk phone and softphone.

Default Mode

Select a default mode for all users. This only applies if you choose to enable both phone modes.

Control Desk Phone

Dial Using Cisco IP Communicator

Control Desk Phone Settings

Voicemail Pilot Number

Specify a voicemail pilot number for all users.

You can set this field as Read Only. This prevents your end users from modifying the field.

Cisco Unified Communications Manager

Servers

Enter the name or IP address of the Cisco Unified Communications Manager server. You can enter up to three servers separated by commas for failover purposes. (Match the number of servers to your Cisco Unified Presence servers.) This field is mandatory. You can set this field as Read Only. This prevents your end users from modifying the field.

Select from the following parameters:

Use as Default Cisco Unified Communications Manager - Sets this server as the default for all users.

Use Sametime Credentials - Select this option if users have the same user ID and password for Cisco Unified Communications Manager and Sametime Connect, and you want to set these fields for all users. Users must enter their Cisco Unified Communications Manager credentials in Sametime Connect if this option is not selected.

Secure CTI Connection

Use Secure Connection

Select this option to enable a secure CTI connection to the Cisco Unified Communications Manager server.

If you select this option, you must configure Cisco Unified Communications Manager for secure CTI. For more information, please refer to Configuring Cisco Unified Communications Manager to Set Up a Secure CTI Connection for Users.

TFTP Server

Enter the name or IP address of the Trivial File Transfer Protocol (TFTP) server.

TFTP Port

Enter the port number on which the TFTP server is running. The default port number is 69.

CAPF Server

Enter the name or IP address of the Certificate Authority Proxy Function (CAPF) server.

CAPF Port

Enter the port number on which the CAPF server is running, as defined in Cisco Unified Communications Manager. The default port number is 3804.

LDAP Phone Attributes

Outgoing

Enter the LDAP phone attributes to populate for a Sametime contact. This allows a user to call phone numbers found in LDAP for the specified LDAP attributes. For example: telephonenumber(Work), mobile(Mobile), pager(Pager).

Besides the attribute, the text in () is the label displayed next to the phone number in the user interface (menu). In other words, the phone number retrieved from attribute "telephonenumber" will be displayed as Work (+1 408 902 3232).

Incoming

Enter the LDAP phone attributes to look up a contact. Typically, this is used to resolve an incoming phone number into a contact. For example: telephonenumber, mobile

Phone Status Settings

Cisco Unified Presence Servers

Enter the name or IP address of the Cisco Unified Presence server, if you choose to enable phone status. You can enter multiple servers separated by commas for failover purposes (match the Cisco Unified Presence server-side settings for failover).You can set this field as Read Only. This prevents your end users from modifying the field.

Select from the following parameters:

Use Sametime Credentials - Select this option if users have the same user ID and password for Cisco Unified Presence and Sametime Connect, and you want to set these fields for all users. If this is not selected, then users must enter their Cisco Unified Presence server credentials into Sametime Connect.

Note A minimum of Cisco Unified Presence 7.0 is required to support failover, with the exception of Cisco Unified Presence 8.0.x, which does not support failover. Cisco Unified Presence 8.6 supports failover.

Sametime User ID Mapping

For optimal performance, try to select a User ID attribute that is available from Sametime and that has values matching user IDs in Cisco Unified Presence.

Use LDAP Attribute

Choose this selection in either of the following cases:

User ID can be found in Sametime internal user ID.

For example, if internal user ID has the distinguished name format, uid=username,ou=employees,o=cisco and uid is the user ID to use in Cisco Unified Presence, then choose this selection and enter "uid" as the attribute, or if the user ID is an email address, for example, username@cisco.com, then choose this selection and enter the email attribute ("mail").

User ID cannot be found either in the Sametime internal user ID, or the Business card.

Sametime internal user ID is determined by the directory service settings for Sametime server. The Sametime business card attributes are also configured on the Sametime server. Refer to the Sametime server documentation for details.

Use Business Card Attribute

Select this setting to use the Business Card attribute as the user ID in the Cisco Unified Presence server. Choose this selection if the user ID used in Cisco Unified Presence server can be found in Business card attribute, and it cannot be found in Sametime internal User ID.

For example: valid attributes are "MailAddress" (this correspond to "E-Mail address" in the server's business cards settings) and "Telephone".

Remove Domain

Select this option to remove the domain name from the email address prior to using it as a user ID in the Cisco Unified Presence server. This applies to the LDAP and Business Card attributes if they are email addresses.

Display Off-Hook Status Only

Select this option to only display off-hook status. When it is not selected, users can distinguish between on-hook and no phone status available.

Preloading

Enable Preloading Phones from LDAP

This option is selected by default. Deselecting this check box will disable preloading phones from LDAP. This may cause a minor delay in LDAP search response when the user requests a listing of available phones.

Logging

Enable Detailed Logging

Select to have user log files to include more detailed information by default. Note, enabling detailed logging impacts performance. We recommend that you only enable detailed logging in lab environments or when debugging a specific issue.


Setting Up the JTAPI Plug-in

JTAPI plug-in installation is completely automated in Cisco Phone Control and Presence 8.6(1) with IBM Lotus Sametime. JTAPI installation no longer requires additional user intervention.


Note JTAPI should no longer be installed from IBM Lotus Notes Widget-based installs.


How to Set Up the IBM Status Extender Plug-in


Note The Status Extender plug-in is only relevant for end-users who check the Enable Phone Status option. If phone status is not used, remove the status extender entry from the site.xml file and applicable jars from the features and plugins directories.



Caution IBM Lotus Sametime with Integrated Notes client is distributed with a newer version of the IBM Status Extender than the Phone Control and Presence plug-in. Widget-based installation of the Phone Control and Presence plug-in will overwrite this newer version, causing errors. Either install the Phone Control and Presence plug-in before upgrading IBM Lotus Sametime with Integrated Notes or use the Eclipse update manager instead of widget-based installs in this instance. (CSCtu24978)

Cisco Phone Control and Presence 8.6(1) with IBM Lotus Sametime ships with the IBM Status Extender 8.5.0 feature. This feature has been modified to allow installation on all Sametime 8.0 clients and is no longer signed. The signed versions are available in the CiscoPCAPWithLotusST_8.6.1.1185/IBM/ directory should you wish to use them. Be careful to use the Status Extender version that matches the Sametime version. If you are using Sametime 7.5.1 you must use the 7.5.1 version of the Status Extender. If you are using Sametime 8.5.1 or later you should remove the Status Extender feature from the update site by removing the line from site.xml and the jars from the plugins and features directories.

Enabling Phone Status for Standalone Implementations of IBM Lotus Sametime 8.5.1 or later

Unlike previous releases of IBM Lotus Sametime, where third party vendors were required to include the Status Extender plug-in with their plug-ins, Sametime 8.5.1 or later includes the Status Extender plug-in. To use the Status Extender plug-in, it must be enabled. To enable the Status Extender plug-in for standalone implementations of Sametime 8.5.1 or later, you must:

1. Create a file called managed-settings.xml in the root directory of your update site, which is the same directory that contains your site.xml file.

2. Configure your Sametime server to auto-push the update site as follows:

a. Log into the Sametime server as administrator.

b. Select Administer the Server.

c. Select Policies > Sametime Default Policy.

d. In the Instant Messaging section, enter the location of the update site in the Sametime Update Site URL field. If this field is already completed, this is the required location for the managed-settings.xml file.

If you are not using auto-push to deploy your plug-ins, you only require the managed-settings.xml file in the root directory.

The following is an example of the managed-settings.xml file that you need to create, configured to enable phone status:

<?xml version="1.0" encoding="utf-8"?>
<ManagedSettings> 
    <settingGroup name="com.ibm.collaboration.realtime">   
        <setting name="enableSUT" value="false"/> 
        <setting name="enableTelephonyStatus" value="false"/> 
        <setting name="enableExtendedStatus" value="true"/> 
    </settingGroup> 
</ManagedSettings> 

Note The important setting to enable Phone Control and Presence to show phone status is to set the "enableExtendedStatus" value to "true".


For more information, refer to the following documentation from IBM:

http://publib.boulder.ibm.com/infocenter/sametime/v8r5/topic/com.ibm.help.sametime.v85.doc/config/config_client_mng_xml_pref.html

Enabling Phone Status for Embedded Implementations of IBM Lotus Sametime 8.5.1 or later

Unlike previous releases of IBM Lotus Sametime, where third party vendors were required to include the Status Extender plug-in with their plug-ins, Sametime 8.5.1 or later includes the Status Extender plug-in. To use the Status Extender plug-in, it must be enabled. To enable the Status Extender plug-in for embedded implementations of Sametime 8.5.1 or later you must perform the steps listed below using Managed Settings and the plugin_customization.ini file. These actions do not actually change the entry in the file. These changes are applied directly to the Lotus Notes Client which overrides the settings in the plugin_customization.ini file.

1. Open the Lotus Notes Administrator Client.

2. Select File > Open Server.

3. Select the applicable server.

4. Select the Person & Groups tab.

5. Select the applicable settings.

6. If you already have a Desktop Policy Setting document, select the applicable one to modify. If you don't have a Desktop Policy Setting document, click on the Add Setting button and select Desktop.

7. Use the provided scroll buttons to find and select the Custom Settings tab.

8. Select the Managed Settings tab.

9. Click Edit List.

10. In the dialog provided, set the following values:

a. Item: enableExtendedStatus

b. Value: true

c. Plug-in name: com.ibm.collaboration.realtime

d. Select the Enforce checkbox.

11. Click Add/Modify Value.

12. Click OK.

Provided that this Desktop Setting is part of an existing Policy, any user with that policy apply to them will have this setting applied to their Lotus Notes Client the next time they authenticate with the server.

Uploading the Files to the Update Site

The files and folders that you copy to the update site differ, depending on whether you are setting up a new site or modifying an existing one.

To...
Do This

Upload files to a new site.

Copy the entire UpdateSite directory from your local working CiscoPCAPWithLotusST_8.6.1.1185 directory to the web server that will host the update site.

Upload files to an existing site.

Replace the site.xml file on the update site with a copy of the site.xml file from your local working CiscoPCAPWithLotusST_8.6.1.1185/UpdateSite directory.

Copy all files in your local working CiscoPCAPWithLotusST_8.6.1.1185/UpdateSite/features directory to the features directory of the update site.

Copy all files in your local working CiscoPCAPWithLotusST_8.6.1.1185/UpdateSite/plugins directory to the plugins directory of the update site.


Configuring Cisco Unified Communications Manager to Set Up a Secure CTI Connection for Users

Before You Begin

Secure CTI connections are supported with:

Cisco Unified Communications Manager 8.5

IBM Lotus Notes 8.0.1 or later with embedded Sametime


Note You cannot configure standalone IBM Lotus Sametime for secure CTI.


If you want to enable a secure CTI connection between IBM Lotus Sametime and the Cisco Unified Communications Manager server, you must first configure your Cisco Unified Communications Manager server for secure CTI. For detailed information about how to do this, please refer to the appropriate version of the Cisco Unified Communications Manager Security Guide at the following URL:

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

Procedure

This procedure describes how to configure Cisco Unified Communications Manager to set up a secure CTI connection for the required users.


Step 1 Log in to Cisco Unified Communications Manager.

Step 2 Select User Management > End User CAPF Profile for one user.

Step 3 Select Bulk Administration > Import/Export > Export.

Step 4 Specify a tar file name.

Step 5 Check the End User CAPF Profile check box.

Step 6 Click on Submit to submit the export job.

Step 7 Select Bulk Administration > Job Scheduler to check the status of the job.

Step 8 Once the job is complete, select Bulk Administration > Upload/Download files to download the exported tar file to your local desktop.

Step 9 Untar the exported file and open the csv file in a text editor.

Step 10 Populate the csv file for the remaining users in the same format and save the file. Create a tar file of the csv file and the header file and upload the tar file for importing.

Step 11 Select Bulk Administration > Import/Export > Import, select the uploaded tar file, and click on Next.

Step 12 Select the End User CAPF Profile check box.

Step 13 Override the existing configuration and click on Submit to submit the job for import.

Step 14 Select Bulk Administration > Job Scheduler to check the status of the job.


Notes About the End User CAPF Profile

Please note the following rules for the CAPF profile files:

Each CAPF profile file can only be downloaded once.

You cannot share CAPF profiles across applications, for example, Notes and Sametime. You need one profile per user, per application, and per computer.

Each user is allowed a maximum of five CAPF files.

Where a user has multiple CAPF files, the CAPF instance ID must be constructed as follows:

userid<0-4> (where the userid is the Cisco Unified Communications Manager userid)

For example, for user johndoe, the CAPF instance IDs can be:

johndoe0

johndoe1

johndoe2

johndoe3

johndoe4

3 How to Prepare Users to Set Up and Use the Plug-in

When deciding which information and instructions to provide to users, you should take the following factors into account:

Which plug-in features you enable

Whether or not you set up the plug-in to install automatically

Which settings you pre-configure with the update site files

To install and configure the plug-in, ensure that your users have the following:

Access to a supported version of IBM Lotus Sametime or IBM Lotus Notes and instructions for installation, if needed.

Information about the plug-in features supported in your deployment.

Access to the Quick Start Guide for Installing and Using Cisco Phone Control and Presence 8.0 with IBM Lotus Sametime for the following:

The URL for the update site, if users must install the plug-in themselves, and installation instructions.

Applicable values to use for system settings such as servers and configuration instructions.

Information about how to get support.

4 Configuration Information

Installation in a Citrix Environment

The Phone Control and Presence and Voicemail plugins should be installed simultaneously in a Citrix environment while all users are logged out. Installation of plugins at different times may require users to manually enable a plugin. If a plugin is installed but is not visible to the user, it must be manually enabled by the user by selecting File > Application Management and selecting the affected plugin.

Synchronization of Plug-in Credentials

Cisco UC Integration with IBM Lotus Sametime 8.6(1) provides plug-in credential synchronization across Cisco Unified Communications services such as Cisco Unified Communications Manager, Cisco Unified Presence, and Cisco Unity Connection. Plug-in credential synchonization ensures that when credentials for one service are changed, those same credentials will be automatically synchronized to other configured services. This service is configured using the updated Configuration Tool with the updated Phone Control and Presence and Unified Messaging plug-ins.

Perform the following procedure to configure synchronization for the Phone Control and Presence plug-in.

Procedure


Step 1 Start the Configuration Tool.

Step 2 Select the Phone Control and Presence tab.

Step 3 Locate the area labelled Cisco Unified Communications Manager.

Step 4 Select the Synchronize Credentials checkbox.

Step 5 Select the Synchronize User Credentials Across Plug-ins option button.

Step 6 Locate the area labelled Phone Status Settings.

Step 7 Select the Synchronize Credentials checkbox.

Step 8 Select the Synchronize User Credentials Across Plug-ins option button.

Step 9 Save the new configuration.

Perform the following procedure to configure credential synchronization for Unified Messaging.

Procedure


Step 1 Start the Configuration Tool.

Step 2 Select the Voicemail tab.

Step 3 Locate the area labelled Mail Store Connection Settings.

Step 4 Select the Synchronize Credentials checkbox.

Step 5 Select the Synchronize User Credentials Across Plug-ins option button.

Step 6 Save the new configuration.


Note Synchronization will occur only for the credentials where the Synchronize user credentials across plug-ins option is selected


LDAP Phone Pre-loading

LDAP phone pre-loading is now configurable on the Phone Control and Presence tab of the Configuration Utility. It is configured using the Enable Preloading Phones from LDAP check box in the Preloading area. This check box is selected by default.

Deselecting this check box will disable preloading phones from LDAP. This may cause a minor delay in LDAP search response when the user requests a listing of available phones.

Enhanced LDAP Phone Search Options

Leaving the Incoming or Outgoing fields blank in the LDAP Phone Attributes area on the Phone Control and Presence tab of the Configuration Utility have a specific effect on LDAP phone searches. These effects are as follows:

If the Incoming field is left blank, no LDAP search is performed on incoming calls to resolve the phone to a Sametime contact.

If the Outgoing field is left blank, no LDAP search is performed to pre-load values or in real time when the context menu is used.

Secure LDAP

This section contains information on using and configuring using Secure LDAP connections. This section contains the following topics:

Secure LDAP Implementation

Secure LDAP and Domino Directory

Secure LDAP Configuration

Secure LDAP Certificate Acceptance

Secure LDAP Implementation

Secure LDAP connections are implemented using the LDAPv3 StartTLS approach. This is standard LDAPv3 mechanism for enabling SSL / TLS data confidentiality protection. This method uses an LDAPv3 extended operation to establish an encrypted SSL / TLS connection within an LDAP connection that has already been established.

Implementation of Secure LDAP requires an Active Directory LDAP server certificate. This certificate can come from either a certified Certificate Authority like VeriSign or by creating a Self-Signed Certificate. The ability to create Self-Signed Certificates in Windows Server must first be installed by selecting Start > Programs > Add/Remove Programs > Windows Components > Install Certificate Authority. If you have already installed the Certificate Authority component, it does not need to be installed again. Self-Signed Certificates can then be created for the network.

Secure LDAP and Domino Directory

Secure LDAP connections are implemented using the LDAPv3 StartTLS approach. IBM Lotus Domino Directory does not support this approach. Secure LDAP connections to IBM Lotus Domino Directory are not currently supported because IBM Lotus Domino Directory only supports SSL connections on port 636 and the StartTLS mechanism uses port 389.

Secure LDAP Configuration

Perform the following procedure to configure Secure LDAP usage.

Procedure


Step 1 Start the Configuration Tool.

Step 2 Select the LDAP tab.

Step 3 Locate the area labelled Directory Server Settings.

Step 4 Select the Use Secure Connection checkbox.

Step 5 Save the new configuration.

Secure LDAP Certificate Acceptance

Users must accept a certificate from the secure LDAP server to establish a connection. An acceptance dialog will be shown on the requesting computer. The following options are displayed:

Trust it for this session only

Trust it permanently

Not Trust

If the client chooses to accept the certificate permanently the dialog will not be shown again. If the client chooses to accept it only for the current session, the dialog will be shown again when a new session is established. If the client chooses to not trust the certificate, the connection will not be established.

Enabling Live Text Support

Click to Call from Live Text is supported from Cisco UC Integration with IBM Lotus Sametime. Live Text must be enabled using a policy to make it available to users. Perform the following procedure to enable Live Text:

Procedure


Step 1 Open the IBM Domino Administrator application.

Step 2 Add a new policy.

Step 3 Select the Basics tab.

Step 4 Enter a name for the policy in the Policy name field.

Step 5 Step 5Select Organizational in the Policy type field.

Step 6 Enter a description in the Description field.

Step 7 Select the New button associated with the Desktop settings area.

Step 8 Select Enable in the Enable Live Text field.

Step 9 Select Save & Close.

Step 10 Save the new policy.

Step 11 Apply the new policy.

5 Troubleshooting

Using Logging to Troubleshoot Issues

If any unexpected or unresolvable issues occur, users can generate reports with detailed configuration and logging information. These reports can assist Cisco TAC in troubleshooting. To obtain a report, enable detailed logging and reproduce the problem, click Create Problem Report on the Preferences > Cisco > Call Control > Troubleshooting tab in IBM Lotus Sametime.


Note We highly recommend restarting after you enable detailed logging because certain critical information such as the configuration settings are in logs at the startup.


When troubleshooting issues with the plug-in, you can inspect the following log files for errors and warnings:

IBM Lotus Sametime — trace-log-0.xml and error-log-0.xml in C:/Documents and Settings/Windows user ID/Application Data/Lotus/Sametime/logs

IBM Lotus Notes - trace-log-0.xml and error-log-0.xml in C:/Program Files/IBM/Lotus/Notes/Data/workspace/logs.

Phone Control and Presence Not Showing Presence Information for the Contact List

If Phone Control and Presence is not showing presence information for the contact list, you can check the following:

1. IBM Lotus Sametime 8.5.1 includes the Status Extender plug-in but the phone status is not displayed until the plug-in is enabled. For information about how to enable the Status Extender plug-in, see Enabling Phone Status for Standalone Implementations of IBM Lotus Sametime 8.5.1 or later. This is applicable to IBM Lotus Sametime 8.5.1 or later only.

2. Ensure that the settings in the Preferences dialog box are correct. To do this, perform the following steps:

a. Select File > Preferences.

b. Select Cisco > Phone > Troubleshooting.

c. Check to ensure that both the Cisco Unified Presence Server (Login) and Cisco Unified Presence Server (Presence) are connected successfully.

3. Ensure that the correct directory service is configured if you are using an LDAP/Domino server as the directory service. To do this, perform the following steps:

a. Select File > Preferences.

b. Select Cisco > Phone > Troubleshooting.

a. Check to ensure that the LDAP server is connected successfully. If not, check the log file to ensure that the LDAP configuration values are not empty and are correct. The log file name starts with trace.log.<num>. For example, a typical LDAP server configuration might be as follows:

Load properties from file : /etc/ldap.properties
Property key=sametime.directory.server.type, value=ldap
Property key=directory.server, value=xxxyyy123456
Property key=sametime.ldap.attr.for.lookup, value=cn
Property key=directory.port, value=xxx
Property key=directory.searchBase, value=ou=Test_00, ou=Test, dc=gwyclient, dc=net
 
   

If the presence information is still not working, you can try to verify those arguments above by using an LDAP tool without using the Phone Control and Presence plug-in.

4. If you are not using an LDAP/Domino server, you can use the IBM Lotus Sametime "Business Card" feature instead. Some directory attributes are available as an electronic Business Card for each Sametime directory contact. If any of the fields in the Business Card match the Cisco Unified Presence username, the relevant attribute can be entered into the appropriate Sametime User ID Mapping field. For example, you can configure the email address that matches a Cisco Unified Presence username.

5. Check if the User IDs setting matches that in Cisco Unified Presence. For example, the Contact IDs for Sun iPlanet and Domino directory have different syntax as follows:

cn=Firstname Lastname/ou=people/o=Cisco (Domino)

uid=username,ou=people,o=cisco.com (iPlanet)

So, when you are configuring the Use LDAP Attribute field in the Configuration Tool, you might use the "uid" for LDAP and "sAMAccountName" for Domino.

6. Check if firewall or security software, such as Cisco Security Agent, is blocking incoming SIP NOTIFY messages. This can happen unless Sametime Connect is in the trusted application list for the firewall or security software.

7. Check if the Display off-hook status only option is enabled in the Preferences dialog box, since this means that a user may be just off-hook at the moment. To do this, perform the following steps:

a. Select File > Preferences.

b. Select Cisco > Phone > Phone Status.

a. Ensure that the Display off-hook status only option is unchecked.

8. Check other client applications such as Cisco Unified Presence Communicator to determine if there is a common presence/server issue for all clients.

An IBM Lotus Sametime Contact Does Not Display Contact Information Such As Icon/Title/Status During a Call

If IBM Lotus Sametime contacts are not showing contact information during a call, you can check the following:

1. Check if a dial rule needs to be applied and if dial rules are applied, check if they are applied properly as follows:

Rules: search for com.cisco.sametime.dialingrules.DialingRulesManager

Rule application: search for com.cisco.sametime.dialingrules.DialRulesImpl.convert

2. Check if the LDAP search is successful, as follows:

a. Check the status of the LDAP server on the Phone Control and Presence Preferences dialog box. To do this, open the Preferences dialog box and select Cisco > Phone > Troubleshooting.

b. Check the LDAP (phone or user ID) attributes used to search in LDAP:

PCAP: "LDAP Phone Attributes" > "Incoming" settings

Voicemail: "LDAP Attributes" > "User ID" and "Phone Attributes" settings

c. Use sniffer software, such as Wireshark, to check LDAP traffic on the wire.

d. Check the LDAP entries in the Sametime trace log file:

Search for com.cisco.sametime.ldap

In particular, for LDAP settings, search for com.cisco.sametime.ldap.config.LdapConfigManager

e. Use the LDAP search tool (ldapsearch) to issue a request to the LDAP directory and display the results in LDAP Data Interchange Format. For example, the following command searches for all entries in the LDAP directory:

ldapsearch -h hostname -b "dc=example,dc=com" -s sub "objectclass=*"

Secure CTI Connection to Cisco Unified Communications Manager Fails

If the secure CTI connection to Cisco Unified Communications Manager fails, you can check the following:

1. Ensure that Cisco Unified Communications Manager is configured to use secure CTI as follows:

a. Check if the security token is installed on Cisco Unified Communications Manager. To do this, go to Cisco Unified Communications Manager > System > Enterprise Parameters > Security Parameters. If the value of the Cluster Security Mode is 0, this indicates that the CTI client is not configured or not installed. The value should be 1 if the security token is installed.

b. Check if the user has enabled the security features. To do this, go to Cisco Unified Communications Manager > User Management > End User > Permissions Information, and ensure that the Standard CTI Secure Connection is added to the group permissions.

c. Check if the client CAPF files are created and named properly. To do this, go to Cisco Unified Communications Manager > User Management > End User CAPF Profile, and ensure that the CAPF files for the user are created. The format for a CAPF file instance ID should be <userid><num>, where <num> is an integer from 0 to 4, since Phone Control and Presence only allows up to five CAPF files per user.

2. In the Phone Control and Presence Configuration Tool, ensure that the Use Secure Connection option is checked and that the TFTP Server, TFTP Port, CAPF Server, and CAPF Port settings are correctly configured. Next, open the IBM Lotus Sametime Preferences dialog box, select Cisco > Phone Control and ensure that the Servers field cannot be edited, since changing the security servers at runtime is not allowed.

3. Ensure that the server and client certificate files have been downloaded successfully. The files should be located in C:\Documents and Settings\<username>\Local Settings\Application Data\Cisco\SametimePhone\Certificates\. The directory for each user should start with <username><server>. Click on this directory and there should be at least one server file, one client file, and one CTL file. For example, if the username is "liz", the files are:

CTLFile.tlv.sgn

JtapiServerKeyStore-liz-liz0

JtapiClientKeyStore-liz-liz0

6 Finding Documentation

Provide your users with the following:

For information about how to install and use the plug-in, refer to the Quick Start Guide for Installing and Using Cisco Phone Control and Presence 8.0 with IBM Lotus Sametime available at: http://www.cisco.com/en/US/products/ps9830/products_user_guide_list.html

For information about how to use Cisco IP Communicator, see the applicable user guide at: http://cisco.com/en/US/products/sw/voicesw/ps5475/products_user_guide_list.html

For information about how to use the Cisco Unified Messaging with IBM Lotus Sametime, see the applicable user guide at: http://www.cisco.com/en/US/products/ps9830/products_user_guide_list.html

Tips for Searching Cisco Documentation

We recommend using the external Google Search (http://www.google.com) to find additional information.

Use the following formula in the search field:

<product name> <release number> <topic keywords> site:cisco.com

Examples of Google Search entries:

meetingplace 7.0 recording disk space site:cisco.com

mobility advantage 7.0 compatibility matrix site:cisco.com

presence 7.0 disaster recovery site:cisco.com