Deployment Guide for Cisco Unified Presence Release 8.6
Integrating Third-Party XMPP Client Applications on Cisco Unified Presence
Downloads: This chapterpdf (PDF - 192.0KB) The complete bookPDF (PDF - 3.54MB) | Feedback

Integrating Third-Party XMPP Client Applications on Cisco Unified Presence

Table Of Contents

Integrating Third-Party XMPP Client Applications on Cisco Unified Presence

About Third-Party Client Integration

Supported Third-Party XMPP Clients

License Requirements for Third-Party Clients

XMPP Client Integration on Cisco Unified Communications Manager

LDAP Integration for XMPP Contact Search

Domain Name for XMPP Clients

DNS Configuration for XMPP Clients

Configuring a Secure Connection between Cisco Unified Presence and XMPP Clients

Turning On Cisco Unified Presence Services to Support XMPP Clients


Integrating Third-Party XMPP Client Applications on Cisco Unified Presence


July 5, 2013

About Third-Party Client Integration

Configuring a Secure Connection between Cisco Unified Presence and XMPP Clients

Turning On Cisco Unified Presence Services to Support XMPP Clients

About Third-Party Client Integration

Supported Third-Party XMPP Clients

License Requirements for Third-Party Clients

XMPP Client Integration on Cisco Unified Communications Manager

LDAP Integration for XMPP Contact Search

Domain Name for XMPP Clients

DNS Configuration for XMPP Clients

Supported Third-Party XMPP Clients

Cisco Unified Presence supports standards-based XMPP to enable third-party XMPP client applications to integrate with Cisco Unified Presence for availability and instant messaging (IM) services. Third-party XMPP clients must comply with the XMPP standard as outlined in the Cisco Software Development Kit (SDK).

This module describes the configuration requirements for integrating XMPP clients with Cisco Unified Presence. If you are integrating XMPP-based API (web) client applications with Cisco Unified Presence, also see developer documentation for Cisco Unified Presence APIs on the Cisco Developer Portal.

Related Topic

Cisco Developer portal:

http://developer.cisco.com/

License Requirements for Third-Party Clients

For each user of an XMPP client application, you require a Cisco Unified Presence user feature license. The Cisco Unified Presence user feature license consumes one Cisco Unified Communications Manager Device License Unit (DLU). On Cisco Unified Communications Manager, you will need to upload the user DLU, and assign Cisco Unified Presence capabilities to the user.

Related Topics

Uploading a License File on Cisco Unified Communications Manager in the Installation Guide for Cisco Unified Presence Release 8.6.

Assigning the Licensing Capabilities on Cisco Unified Communications Manager in the Installation Guide for Cisco Unified Presence 8.6.

XMPP Client Integration on Cisco Unified Communications Manager

Before you integrate an XMPP client, perform the following tasks on Cisco Unified Communications Manager:

Configure the licensing requirements. Upload the user DLU, and then assign Cisco Unified Presence capabilities for the user.

Configure the users and devices. Associate a device with each user, and associate each user with a line appearance.

Related Topics

Installation Guide for Cisco Unified Presence Release 8.6

User and Device Configuration on Cisco Unified Communications Manager.

LDAP Integration for XMPP Contact Search

To allow users of the XMPP client applications to search and add contacts from an LDAP directory, configure the LDAP settings for XMPP clients on Cisco Unified Presence.

Related Topic

How to Integrate the LDAP Directory for Contact Searches on XMPP Clients

Domain Name for XMPP Clients

The domain name on the XMPP client, specifically the XMPP connection attempt domain name, must match the domain on Cisco Unified Presence. To verify the domain value on Cisco Unified Presence, select Cisco Unified Presence Administration > System > Cluster Topology, select Settings in the right pane, and verify the Domain Name value.

DNS Configuration for XMPP Clients

You must enable DNS SRV in your deployment when you integrate XMPP clients with Cisco Unified Presence. The XMPP client performs a DNS SRV query to find an XMPP server (Cisco Unified Presence) to communicate with, and then performs a record lookup of the XMPP server to get the IP address.

Configuring a Secure Connection between Cisco Unified Presence and XMPP Clients

Procedure


Step 1 Cisco Unified Presence Administration > System > Security > Settings

Step 2 Perform these configuration steps:

If You Want To...
Do This

Establish a secure TLS connection between Cisco Unified Presence and XMPP client applications in a cluster.

Select Enable XMPP Client To CUP Service Secure Mode.

We recommend that you do not turn off this secure mode unless the XMPP client application can protect the client login credentials in non-secure mode. If you do turn off the secure mode, verify that you can secure the XMPP client-to-server communication in some other way.

Establish a secure TLS connection between Cisco Unified Presence and XMPP-based API client applications in a cluster.

Select Enable Web Client To CUP Service Secure Mode.

If you turn on this setting, upload the certificates or signing certificates for the web client in the cup-xmpp-trust repository on Cisco Unified Presence.


Step 3 Select Save.


Troubleshooting Tips

If you update the XMPP security settings, perform one of these actions:

Restart the following services:

Restart the Cisco UP XCP Connection Manager if you edit Enable XMPP Client To CUP Service Secure Mode. Select Cisco Unified Serviceability > Tools > Control Center - Feature Services to restart this service

Restart the Cisco UP XCP Web Connection Manager if you edit Enable Web Client To CUP Service Secure Mode. Select Cisco Unified Serviceability > Tools > Control Center - Feature Services to restart this service

What To Do Next

Turning On Cisco Unified Presence Services to Support XMPP Clients

Related Topic

About Third-Party Client Integration

Turning On Cisco Unified Presence Services to Support XMPP Clients


Note Perform this procedure on each node in your Cisco Unified Presence cluster.


Procedure


Step 1 Select Cisco Unified Serviceability > Tools > Service Activation.

Step 2 Select the Cisco Unified Presence server from the Server menu.

Step 3 Turn on the following services:

Cisco UP XCP Connection Manager - Turn on this service if you are integrating XMPP clients (such as Cisco Unified Personal Communicator), or XMPP-based API clients, on Cisco Unified Presence

Cisco UP XCP Authentication Service - Turn on this service if you are integrating XMPP clients (such as Cisco Unified Personal Communicator), or XMPP-based API clients, or XMPP-based API clients, on Cisco Unified Presence.

Cisco UP XCP Web Connection Manager - Optionally, turn on this service if you are integrating XMPP clients (such as Cisco Unified Personal Communicator), or XMPP-based API clients, on Cisco Unified Presence.

Step 4 Select Save.


Troubleshooting Tip

For XMPP clients to function correctly, make sure you turn on the Cisco UP XCP Router on all nodes in your cluster.

Related Topics

About Third-Party Client Integration

Configuring a Secure Connection between Cisco Unified Presence and XMPP Clients