Deployment Guide for IM and Presence Service on Cisco Unified Communications Manager, Release 9.1(1)
Overview of a basic integration

Overview of a basic integration

IM and Presence interfaces

Main components

The following figure provides an overview of an IM and Presence deployment, including the main components and interfaces between Cisco Unified Communications Manager and IM and Presence and between IM and Presence and third-party products.

Figure 1. IM and Presence Basic Deployment

SIP interface

A SIP connection handles the presence information exchange between Cisco Unified Communications Manager and the IM and Presence service. To enable the SIP connection on Cisco Unified Communications Manager, you must configure a SIP trunk pointing to the IM and Presence server.

On IM and Presence, configuring Cisco Unified Communications Manager as a Presence Gateway will allow IM and Presence to send SIP subscribe messages to Cisco Unified Communications Manager over the SIP trunk.


Note


IM and Presence does not support clients (Cisco clients or third party) connecting to IM and Presence using SIP/SIMPLE interface over TLS. Only a SIP connection over TCP is supported.


CTI interface

The CTI (Computer Telephony Integration) interface handles all the CTI communication for users on the IM and Presence server to control phones on Cisco Unified Communications Manager. The CTI functionality allows users of the Cisco Unified Personal Communicator client to run the application in desk phone control mode.

The CTI functionality is also used for the IM and Presence remote call control feature on the Microsoft Office Communicator client. For information about configuring the remote call control feature, see the Microsoft Office Communicator Call Control with Microsoft OCS for IM and Presence Service on Cisco Unified Communications Manager.

To configure CTI functionality for IM and Presence users on Cisco Unified Communications Manager, users must be associated with a CTI-enabled group, and the primary extension assigned to that user must be enabled for CTI.

To configure Cisco Unified Personal Communicator desk phone control, you must configure a CTI server and profile on IM and Presence, and assign any users that wish to use the application in desk phone mode to that profile. However, note that all CTI communication occurs directly between Cisco Unified Communications Manager and Cisco Unified Personal Communicator, and not through the IM and Presence server.

AXL/SOAP interface

The AXL/SOAP interface handles the database synchronization from Cisco Unified Communications Manager and populates the IM and Presence Service database. To activate the database synchronization, the Sync Agent service must be running on IM and Presence.

By default the Sync Agent load balances all users equally across all nodes within the IM and Presence cluster. You also have the option to manually assign users to a particular node in the IM and Presence cluster.

For guidelines on the recommended synchronization intervals when executing a database synchronization with Cisco Unified Communications Manager, for single and dual-node IM and Presence, see the IM and Presence SRND document.

LDAP interface

Cisco Unified Communications Manager obtains all user information via manual configuration or synchronization directly over LDAP. The IM and Presence Service then synchronizes all this user information from Cisco Unified Communications Manager (using the AXL/SOAP interface).

IM and Presence provides LDAP authentication for users of the Cisco Unified Personal Communicator client and IM and Presence user interface. If a Cisco Unified Personal Communicator user logs into IM and Presence, and LDAP authentication is enabled on Cisco Unified Communications Manager, IM and Presence goes directly to the LDAP directory for Cisco Unified Personal Communicator user authentication. Once Cisco Unified Personal Communicator is authenticated, IM and Presence forwards this information to Cisco Unified Personal Communicator to continue the user login.

Cisco Unified Personal Communicator and third party XMPP clients use the LDAP directory to allow users to search and add contacts.

XMPP interface

An XMPP connection handles the presence information exchange and instant messaging operations for XMPP-based clients. The IM and Presence Service supports temporary (ad-hoc) and persistent chat rooms for XMPP-based clients. An IM Gateway supports the IM interoperability between SIP-based and XMPP-based clients in a IM and Presence deployment.

XMPP standards

The IM and Presence Service is compliant with the following XMPP standards:

  • RFC 3920 Extensible Messaging and Presence Protocol (XMPP): Core RFC 3921 Extensible Messaging and Presence Protocol (XMPP): Instant Messaging and Presence
    • XEP-0004 Data Forms
    • XEP-0012 Last Activity
    • XEP-0013 Flexible Offline Message Retrieval
    • XEP-0016 Privacy Lists
    • XEP-0030 Service Discovery
    • XEP-0045 Multi-User Chat
    • XEP-0054 Vcard-temp
    • XEP-0055 Jabber Search
    • XEP-0060 Publish-Subscribe
    • XEP-0065 SOCKS5 Bystreams
    • XEP-0066 Out of Band Data Archive OOB requests
    • XEP-0068 Field Standardization for Data Forms
    • XEP-0071 XHTML-IM
    • XEP-0082 XMPP Date and Time Profiles
    • XEP-0092 Software Version
    • XEP-0106 JID Escaping
    • XEP-0114 Jabber Component Protocol
    • XEP-0115 Entity Capabilities
    • XEP-0124 Bidirectional Streams over Synchronous HTTP (BOSH)
    • XEP-0126 Invisibility
    • XEP-0128 Service Discovery Extensions
    • XEP-0160 Best Practices for Handling Offline Messages
    • XEP-0163 Personal Eventing Via PubSub
    • XEP-0170 Recommended Order of Stream Feature Negotiation
    • XEP-0178 Best Practices for Use of SASL EXTERNAL
    • XEP-0220 Server Dialback
    • XEP-0273 SIFT (Stanza Interception and Filtering Technology)

Module overview

Module

This Module Describes...

Notes

Configuring Cisco Unified Communications Manager for Integration with IM and Presence

  • Instructions to configure the presence parameters and the SIP trunk, on Cisco Unified Communications Manager.
  • This is required configuration.
  • Make sure that you complete the prerequisite user and device configuration on Cisco Unified Communications Manager as described in this module.

Planning an IM and Presence Multi-node Deployment

  • Multi-node scalability feature introduction.
  • Different multi-node deployment models.
  • DNS configuration options for a multi-node deployment.

  • This module is only applicable if you are configuring a multi-node deployment.

Performing an IM and Presence Multi-node Deployment

  • A high-level overview of how to perform a multi-node installation and deployment.
  • Describes the high-level sequence of tasks when performing a fresh multi-node deployment, and updating an existing multi-node deployment.
  • This module is only applicable if you are configuring a multi-node deployment.

Configuring an IM and Presence Server for Deployment in the Network

  • System topology configuration (multi-node)
  • High availability configuration (multi-node)
  • Cluster-wide SRV address (multi-node)
  • Routing parameters (multi-node)
  • Presence gateway and service parameters (single node and multi-node)
  • Authorization policy configuration (single node and multi-node)
  • Turning on IM and Presence services (single node and multi-node)
  • Some topics in this module are only applicable to the multi-node deployment, and some are applicable to both single node and multi-node deployments.
  • You perform certain tasks in this module on the IM and Presence publisher node, and certain tasks on all nodes in the cluster.

Configuring Security between Cisco Unified Communications Manager and IM and Presence

  • The exchange of self-signed certificates between Cisco Unified Communications Manager and IM and Presence.
  • Configuring IM and Presence secure modes
  • This module is only required if you want a secure connection between these servers.

Integrating Third-Party XMPP Client Applications on IM and Presence

  • Instructions to configure third-party XMPP clients on IM and Presence.
  • This module is only required if you are deploying third-party XMPP clients.

Configuring Chat on IM and Presence

  • Instructions to configure the chat, and group chat settings on IM and Presence.
  • This module is only applicable if you are deploying XMPP clients.

Configuring Cisco Unified Personal Communicator

  • This module describes how to configure Cisco Unified Personal Communicator Release 8.x.
  • Instructions to configure Cisco Unified Personal Communicator on Cisco Unified Communications Manager
  • Instructions to configure Cisco Unified Personal Communicator on IM and Presence
  • Configuring firewalls to pass Cisco Unified Personal Communicator traffic
  • Configuring users for point-to-point video calls and for multipoint video conferencing
  • This module is only required if you are deploying Cisco Unified Personal Communicator.

Additional Deployment Information for Cisco Unified Personal Communicator

  • Instructions to configure the voicemail servers for Cisco Unified Personal Communicator
  • Instructions to configure the conferencing servers for Cisco Unified Personal Communicator
  • Instructions to configure the video conferencing resources on Cisco Unified Communications Manager
  • Updating user configuration after deploying Cisco Unified Personal Communicator
  • This module describes optional configuration if you are deploying Cisco Unified Personal Communicator

Deploying and Updating Cisco Unified Personal Communicator

  • Instructions on deploying and upgrading Cisco Unified Personal Communicator
  • Information on installation and use of headsets and other audio devices.
  • This module is only required if you are deploying Cisco Unified Personal Communicator.

Integrating the LDAP Directory

  • Integrating the LDAP directory with Cisco Unified Communications Manager
  • Integrating the LDAP directory with Cisco Unified Personal Communicator
  • Integrating the LDAP directory for XMPP client contact search
  • This is recommended configuration.

Configuring a IM and Presence Intercluster Deployment

  • Information about intercluster deployments, and how to configure intercluster peers.
  • This module is only required if you are configuring a multi-cluster deployment.

Configuring IM and Presence for an IM-Only Deployment

  • Outline of the configuration steps required for an IM-only deployment
  • This module is only required if you are configuring an IM-only deployment.
Configuring Active Directory for Cisco Unified Personal Communicator
  • Information about Active Directory and its related mechanisms.
  • This module is only required if you are deploying Cisco Unified Personal Communicator.
Configuring Additional Registry Keys for Cisco Unified Personal Communicator
  • Customizations available through registry key settings.
  • This module is only required if you are deploying Cisco Unified Personal Communicator.

How to Configure Multilingual Support for IM and Presence

  • Information on installing the locale installer on Cisco Unified Communications Manager and IM and Presence
  • This module is only required if you wish to expand your IM and Presence deployment to support multiple languages.

IM compliancy

For information about configuring Instant Message (IM) compliancy on the IM and Presence Service, refer to the following documents:

Third-party integrations

This guide only details how to configure a basic IM and Presence deployment. For third-party integrations, see the document references below.

Third Party Integration

This Guide Describes...

Microsoft Exchange for IM and Presence Service on Cisco Unified Communications Manager

  • Integrating with Microsoft Exchange 2003, 2007 and 2010
  • Configuring Microsoft Active Directory for this integration

Microsoft Office Communicator Call Control with Microsoft OCS for IM and Presence Service on Cisco Unified Communications Manager

  • Configuring IM and Presence as a CSTA gateway for remote call control from the Microsoft Office Communicator client
  • Configuring Microsoft Active Directory for this integration
  • Load-balancing MOC requests in a dual node IM and Presence deployment over TCP
  • Load-balancing MOC requests in a dual node IM and Presence deployment over TLS

Interdomain Federation for IM and Presence Service on Cisco Unified Communications Manager

  • Configuring IM and Presence for interdomain federation over the SIP protocol with Microsoft OCS and AOL, and over the XMPP protocol with IBM Sametime, Googletalk, Webex Connect, and another IM and Presence Release 9.x enterprise.

Partitioned Intradomain Federation for IM and Presence Service on Cisco Unified Communications Manager

  • Configuring IM and Presence for Partitioned Intradomain Federation
  • Configuring Microsoft OCS for Partitioned Intradomain Federation
  • Configuring Microsoft LCS for Partitioned Intradomain Federation
  • User Migration

Remote Call Control with Microsoft Lync Server 2010 for IM and Presence Service on Cisco Unified Communications Manager

  • Configuring Cisco Unified Communications Manager and IM and Presence for integration with Microsoft Lync
  • Configuring Microsoft Active Directory
  • Configuring normalization rules
  • Configuring security between IM and Presence and Microsoft Lync

Related Topic

IM and Presence third-party integration documentation:

http:/​/​www.cisco.com/​en/​US/​products/​sw/​voicesw/​ps556/​products_​installation_​and_​configuration_​guides_​list.html

Web interface timeout

Using the Command Line Interface (CLI), you can configure time, in minutes, after which the web interface times out and logs off the user. The default timeout value is 30 minutes. For more information, see the Command Line Interface Reference Guide for Cisco Unified Communications Solutions, Release 9.0(1).