More and more enterprises are choosing Cisco Unified CM IM and Presence as their IM and Availability platform. These enterprises already have Microsoft Lync, Microsoft Office Communications Server (OCS) or Microsoft Live Communications Server (LCS) deployed and want to move their users from Microsoft Lync or Microsoft Office Communicator to an IM and Presence supported client. During the transition, it is important that these users who migrate to an IM and Presence supported client can continue to share presence information and instant messages with those users who are still using Microsoft Lync or Microsoft Office Communicator. For more information about supported IM and Presence clients, see the "Software Requirements" section.
Partitioned Intradomain Federation enables IM and Presence client users and Microsoft Lync or Microsoft Office Communicator users within the same enterprise domain to exchange presence Availability and IM.
This integration supports users within an enterprise domain who are either configured on IM and Presence and use an IM and Presence supported client as their desktop client, or are enabled on OCS or LCS and use Microsoft Lync or Microsoft Office Communicator as their desktop client or are enabled on Lync, OCS or LCS and use Microsoft Lync or Microsoft Office Communicator as their desktop client.
Note
This integration does not support users with both an IM and Presence supported client and Microsoft Lync or Microsoft Office Communicator.
IM and Presence uses the standard Session Initiation Protocol (SIP RFC 3261) to provide Partitioned Intradomain Federation support for the following Lync/OCS/LCS platforms:
Microsoft Lync Server 2010, Standard Edition and Enterprise Edition
Microsoft Live Communications Server 2005 Standard Edition and Enterprise Edition
Microsoft Office Communications Server 2007 R2 Standard Edition and Enterprise Edition
The following figure shows a high-level sample deployment of IM and Presence and Lync/OCS/LCS within the same domain. This figure shows an example of an OCS deployment, but it also applies to Lync and LCS.
Figure 1. Integration Overview
Note
The term Lync/OCS/LCS is used in this document to refer to all supported Lync, OCS and LCS platform types. If any detail is specific to one platform type, that Lync, OCS or LCS platform is specifically identified.
You configure the following key components to enable Partitioned Intradomain Federation between IM and Presence Service and your Microsoft Lync, Microsoft Office Communications Server (OCS), or Microsoft Live Communications Server (LCS) server:
IM and Presence Service server
Lync\OCS\LCS server
User migration
Tip
See the detailed configuration workflows for the start-to-finish steps needed to enable Partitioned Intradomain Federation and for links to the procedures that are performed at each step of the process.
Cisco recommends that you back up the Lync/OCS/LCS user contact list information before proceeding to configure Partitioned Intradomain Federation between IM and Presence Service and your Lync\OCS\LCS server.
The following table lists the high-level Partitioned Intradomain Federation configuration tasks for the IM and Presence Service server.
Table 1 Partitioned Intradomain Federation high-level configuration tasks for the IM and Presence Service server
Task
O = Optional
M = Mandatory
Enable Partitioned Intradomain Federation
M
Set up static routes to the Lync\OCS\LCS server
M
Set up ACLs
M
Set up TLS for the Lync server (required if you are using a Lync server)
M
Set up TLS for OCS and LCS servers
O
Deactivate non-essential services on the dedicated routing server (if applicable)
M
The following table lists the high-level Partitioned Intradomain Federation configuration tasks for the Lync server.
Table 2 Partitioned Intradomain Federation high-level configuration tasks for the Lync server
Task
O = Optional
M = Mandatory
Set up static routes to the IM and Presence Service server
M
Set up host authorization
M
Publish the topology
M
Set up TLS
M
The following table lists the high-level Partitioned Intradomain Federation configuration tasks for the OCS and LCS servers.
Table 3 Partitioned Intradomain Federation high-level configuration tasks for the OCS and LCS servers
Task
O = Optional
M = Mandatory
Enable SIP port
M
Set up static routes to the IM and Presence Service server
M
Set up host authorization
M
Set up TLS
O
The following table lists the tasks to migrate users for Partitioned Intradomain Federation.
Table 4 Partitioned Intradomain Federation user migration tasks
Task
O = Optional
M = Mandatory
Download tools
M
Disable Lync subscriber notification popups
M
Set unlimited contact list sizes and watcher sizes
M
Enable auto authorization of subscriber requests
M
Provision Lync\OCS\LCS users on Cisco Unified Communications Manager
M
Back up user Lync\OCS\LCS contact list information
M
Export contact lists for users
M
Disable users on Lync\OCS\LCS
M
Verify that user accounts are disabled
M
Delete user data from database for migrating users
Note
Depending on your Microsoft server deployment, you may have to perform this procedure on multiple databases.
M
Import contact lists for migrating users in to IM and Presence Service
When a Microsoft Lync or
Microsoft Office Communicator user wishes to view presence of an
IM and Presence client user, a SIP SUBSCRIBE request is routed from Lync/OCS/LCS
to
IM and Presence.
IM and Presence accepts the incoming subscription and places it in a pending
state. Private policy is then applied to this incoming subscription request.
Note
Privacy policy applied to subscriptions from Microsoft Lync or Microsoft Office Communicator users in a Partitioned Intradomain Federation deployment
is identical to the privacy policy applied to subscriptions from
IM and Presence client users.
IM and Presence checks whether
auto-authorization is enabled or whether the
IM and Presence client user has previously blocked or allowed presence
subscriptions from the Microsoft Lync or Microsoft Office Communicator user. If either case is true,
IM and Presence auto-handles policy decision for the subscription request.
Otherwise, the
IM and Presence client user receives an alert regarding the new
subscription.
If the subscription is denied, polite blocking is
implemented. This means that the presence state of the user appears as offline
to the
Microsoft Lync or
Microsoft Office Communicator user. If the subscription is authorized,
IM and Presence sends presence updates to the
Microsoft Lync or
Microsoft Office Communicator user and the
IM and Presence client user also has the option to add the
Microsoft Lync or
Microsoft Office Communicator user to their roster.
Subscription to Microsoft Lync or Microsoft Office Communicator user
When an
IM and Presence client user wishes to view presence of a
Microsoft Lync or
Microsoft Office Communicator user, a SIP SUBSCRIBE request is routed from
IM and Presence to Lync/OCS/LCS. Lync/OCS/LCS accepts the incoming subscription.
Policy is then applied to this incoming subscription request.
If the
Microsoft Lync or
Microsoft Office Communicator user has previously accepted a subscription from this
user, the subscription is auto-accepted, and presence is returned to the
IM and Presence client user in line with the policy level applied by the
Microsoft Lync or
Microsoft Office Communicator user. If not, the
Microsoft Lync or
Microsoft Office Communicator user receives an alert regarding the new subscription.
The
Microsoft Lync or
Microsoft Office Communicator user can then accept or block the
IM and Presence client user.
Note
Microsoft Lync and
Microsoft Office Communicator perform a refresh subscribe approximately every 1 hour and 45
minutes. Therefore, if an
IM and Presence server restarts, the maximum duration a
Microsoft Lync or
Microsoft Office Communicator user is without the presence status of
IM and Presence contacts is approximately two hours.
If Lync/OCS/LCS restarts, the maximum duration an
IM and Presence client is without presence status of Microsoft Lync or Microsoft Office Communicator contacts is approximately 2 hours.
Availability mapping states
The following table shows the availability mapping states from Microsoft Lync or Microsoft Office Communicator to the following IM and Presence supported clients:
Cisco Jabber for Windows
Cisco Jabber for Mac
Cisco Jabber for iPad
Cisco Jabber IM for Mobile (iPhone, Android, Blackberry)
Cisco Unified Personal Communicator Release 8.x
Third-party XMPP Clients
Table 5 Availability Mapping States from Microsoft Lync or Microsoft Office Communicator
The following table shows the availability mapping states from third-party XMPP clients to Microsoft Lync or Microsoft Office Communicator.
Table 8 Availability Mapping States from Third-Party XMPP Clients to Microsoft Lync or Microsoft Office Communicator
Third-Party XMPP Setting
Microsoft Lync or Microsoft Office Communicator
Setting
Available
Available
Away
Away
Extended Away
Away
Do Not Disturb
Busy
Offline
Offline
Instant messaging
Partitioned Intradomain Federation supports point-to-point IM between IM and Presence client users and Microsoft Lync or Microsoft Office Communicator users. This includes support for the following IM features:
Plain text IM format
Typing indication
Basic emoticons
SIP Session Mode IM is used to transfer messages and typing indications between IM and Presence and Lync/OCS/LCS.
When an IM and Presence client user sends an IM to a Microsoft Lync or Microsoft Office Communicator user, if no existing IM session is established between these two users IM and Presence sends a SIP INVITE message to Lync/OCS/LCS to establish a new session. This session is used for any subsequent SIP MESSAGE or SIP INFO (typing indication) traffic from either of these two users.
Note
IM and Presence client users and third-party XMPP client users can begin an IM conversation with a Microsoft Lync or Microsoft Office Communicator user even if they do not have availability.
When a Microsoft Lync or Microsoft Office Communicator user sends an IM to an IM and Presence client user, if no existing IM session is established between these two users, Microsoft Lync or Microsoft Office Communicator sends a SIP INVITE message to IM and Presence. This session is used for any subsequent SIP MESSAGE or SIP INFO (typing indication) traffic from either of these two users.
Note
Due to the proprietary nature of Lync/OCS/LCS group chat functionality, Partitioned Intradomain Federation does not support group chat between IM and Presence client users and Microsoft Lync or Microsoft Office Communicator users.
Request routing
This section describes request routing for IM and Presence to Lync/OCS/LCS and for Lync/OCS/LCS to IM and Presence.
To enable basic connectivity from IM and Presence to Lync/OCS/LCS, you must configure SIP static routes on IM and Presence for the IM and Presence domain. These static routes point to an IP address of an Lync/OCS/LCS server or front-end load balancer (Enterprise Edition Lync/OCS/LCS only) and allow IM and Presence to route same-domain requests to Lync/OCS/LCS when the recipient is not an IM and Presence user. Transport Layer Security (TLS) encryption can be enabled on these static routes. To support basic connectivity from IM and Presence to Lync/OCS/LCS, you must also configure entries in the Incoming Access Control List (ACL) to ensure that Lync/OCS/LCS servers can access the IM and Presence server without authentication.
Overlaying this basic connectivity, Partitioned Intradomain Federation provides two modes of request routing from IM and Presence to Lync/OCS/LCS: Basic Routing and Advanced Routing.
Basic routing mode for Partitioned Intradomain Federation
Basic Routing is the default routing mode for Partitioned Intradomain Federation. When Basic Routing is enabled, IM and Presence routes a request to Lync/OCS/LCS if the request recipient is within the IM and Presence domain but is not a licensed IM and Presence user.
The following figure shows the sequence of the routing request from IM and Presence to Lync/OCS/LCS when Basic Routing is configured. This figure shows an example of an OCS deployment, but it also applies to Lync and LCS.
Figure 2. IM and Presence to Lync/OCS/LCS Request Routing
1
Ann, a Cisco Jabber 8.x user, sends a request to Bob, who is a Microsoft Office Communicator user.
2
Because Bob is within the local domain but is not a licensed IM and Presence client user, IM and Presence translates the request and routes it to OCS.
3
The OCS server forwards the request to Bob’s Microsoft Office Communicator client.
Note
For recipients who are not provisioned on either IM and Presence or Lync/OCS/LCS, any such request that is forwarded to Lync/OCS/LCS is in turn returned by Lync/OCS/LCS to IM and Presence.
IM and Presence has built-in loop detection to reject any requests that loop back from Lync/OCS/LCS in this manner.
Advanced routing mode for Partitioned Intradomain Federation
Configure Advanced Routing for Partitioned Intradomain Federation only if Cisco Unified Communications Manager synchronizes its users from the same Active Directory that Lync/OCS/LCS uses. The list of users synchronized from Active Directory must include all Microsoft Lync or Microsoft Office Communicator users. If Advanced Routing is enabled, IM and Presence routes a request to Lync/OCS/LCS if both of the following conditions are met:
The request recipient is within the IM and Presence domain but is not a licensed IM and Presence user
and
The request recipient has a valid Microsoft Lync or Microsoft Office Communicator SIP address stored in the IM and Presence database
Note
Advanced Routing is supported only in single-cluster IM and Presence deployments.
Advanced Routing ensures less traffic between IM and Presence and Lync/OCS/LCS in deployments in which there are a large number of unprovisioned or unknown contacts in the IM and Presence database.
However, Advanced Routing does add an additional storage overhead on each IM and Presence cluster because each cluster must store all Microsoft Lync or Microsoft Office Communicator users so that the Advance Routing logic can be applied.
Lync/OCS/LCS to IM and Presence request routing
To enable basic connectivity from Lync/OCS/LCS to IM and Presence, you must configure SIP static routes on Lync/OCS/LCS for the IM and Presence domain. These static routes point to the IP address and port of an IM and Presence server, which is designated as the routing IM and Presence server. They allow Lync/OCS/LCS to route same-domain requests to IM and Presence when the recipient is not an Lync/OCS/LCS user. TLS encryption can be enabled on these static routes.
To ensure that Lync/OCS/LCS is not prompted for authorization to accept SIP Requests from IM and Presence, you must also configure Host Authorization entries on Lync/OCS/LCS for each IM and Presence server.
As mentioned, overlaying the static route configuration, Lync/OCS/LCS has just a single routing mode in a Partitioned Intradomain Federation deployment. Lync/OCS/LCS routes requests to IM and Presence if the request recipient is within one of the Lync/OCS/LCS managed presence domains but is not a Microsoft Lync or Microsoft Office Communicator user.
The following figure shows the sequence of the routing request from Lync/OCS/LCS to IM and Presence. This figure shows an example of an OCS deployment, but it also applies to Lync and LCS.
Figure 3. Lync/OCS/LCS to IM and Presence Request Routing
1
Bob, a Microsoft Office Communicator user, sends a request to Ann, who is a Cisco Jabber user.
3
IM and Presence accepts the request and forwards it to Ann’s home IM and Presence server.
2
Because Ann is within the local domain but is not a Microsoft Office Communicator user, Lync/OCS/LCS routes the request to IM and Presence.
4
IM and Presence translates the request and forwards it to Ann’s Cisco Jabber client.
Note
For recipients who are not provisioned on either IM and Presence or Lync/OCS/LCS, any such requests that are forwarded by Lync/OCS/LCS to IM and Presence are rejected by IM and Presence.
Intercluster and multinode deployments
In an intercluster and multinode cluster IM and Presence deployment, when establishing an Availability subscription or IM conversation, Lync/OCS/LCS servers route all SIP messages to an IM and Presence server that is designated for routing purposes. If the IM and Presence routing server does not host the recipient user, it routes the message to the appropriate IM and Presence server within the deployment. The system routes all responses that are associated with this request back through the routing IM and Presence server.
Any IM and Presence server, when establishing an Availability subscription or IM conversation, can send a SIP message directly to an Lync/OCS/LCS server. When Lync/OCS/LCS replies to these messages, the replies are sent directly back to the IM and Presence server that began the message.
Interdomain Federation
IM and Presence supports Interdomain Federation. This feature is also available when IM and Presence is configured for Partitioned Intradomain Federation. However, any Interdomain Federation that is configured on IM and Presence is available only to IM and Presence client users.
If the Lync/OCS/LCS deployment is already configured for SIP Interdomain Federation through an Access Edge/Access Proxy server, Microsoft Lync or Microsoft Office Communicator users can continue to use this federation capability. It is also possible to configure IM and Presence and Lync/OCS/LCS so that IM and Presence client users can take advantage of such existing federation capability.
Note
It is not supported to configure both IM and Presence and Lync/OCS/LCS to federate directly with the same remote domain.
See the document Interdomain Federation for IM and Presence Service on Cisco Unified Communications Manager for more information about IM and Presence Interdomain Federation.
High Availability for IM and Presence to Lync/OCS/LCS request routing
As mentioned earlier, SIP static routes must be configured on IM and Presence to enable basic Intradomain Federation connectivity between IM and Presence and Lync/OCS/LCS.
To provide high availability for integration with Lync/OCS/LCS, you can configure multiple SIP static routes for each address pattern on IM and Presence.
You can assign priority values to these static routes as required to define primary and backup static routes. Highest Priority routes are attempted first. If those routes are not available, the request is re-sent using the backup route as shown in the following figure. This figure shows an example of an OCS deployment, but it also applies to Lync and LCS.
Figure 4. High Availability for IM and Presence to Lync/OCS/LCS Request Routing
1
When routing to Lync/OCS/LCS, IM and Presence finds the highest-priority static route and attempts to send the request to the next hop address that is configured for that route.
2
If that next hop is not available, IM and Presence falls back to the next-highest priority static route and attempts to send the request to the associated next hop address.
In the case of Enterprise Edition Lync/OCS/LCS, you can deploy a front-end load balancer. In such cases, you can configure SIP static routes on IM and Presence to point to the IP address of the Lync/OCS/LCS front-end load balancer. The front-end load balancer provides high availability within its associated Lync/OCS/LCS pool as shown in the following figure. This figure shows an example of an OCS deployment, but it also applies to Lync and LCS.
Figure 5. High Availability with Load Balancer for IM and Presence to Lync/OCS/LCS Request Routing
1
When routing to Lync/OCS/LCS, IM and Presence finds a static route that points to the OCS front-end load balancer.
2
The Lync/OCS/LCS front-end load balancer then routes onward to one of the active front-end servers within the pool.
IM and Presence has been tested with the Cisco Application Control Engine (ACE) as the Lync/OCS/LCS front-end load balancer. Other load balancers can be used in place of ACE; see the following URL for a list of approved load balancers: http://technet.microsoft.com/en-us/office/ocs/cc843611. However, it is your responsibility to ensure that those load balancers are deployed and managed correctly.
Note
Cisco does not support the configuration of static routes to point to load balancers other than ACE.
In deployments in which ACE is not the configured front-end load balancer, Cisco recommends that you configure static routes to bypass the front-end load balancer.
High Availability for Lync/OCS/LCS to IM and Presence request routing
SIP static routes must be configured on Lync/OCS/LCS to enable basic Intradomain Federation connectivity between Lync/OCS/LCS and IM and Presence.
However, Lync/OCS/LCS supports configuration of only a single SIP static route for each domain, which means that the static route can point to just a single IM and Presence server.
Therefore, to achieve high availability when IM and Presence is integrated with Lync/OCS/LCS, you must incorporate a load balancer between the IM and Presence server and Lync/OCS/LCS server as shown in the following figure. The Cisco CSS11506 Content Services Switch is the only load balancer that IM and Presence supports. This figure shows an example of an OCS deployment, but it also applies to Lync and LCS.
Figure 6. High Availability for Lync/OCS/LCS to IM and Presence Request Routing
1
The load balancer works in Active/Backup mode. It routes requests to the primary IM and Presence server while that server is running and uses heartbeat signaling to check if the IM and Presence server is alive.
2
If the IM and Presence server fails, the load balancer ensures that all subsequent requests are routed to the backup IM and Presence server.
Contact search
Partitioned Intradomain Federation allows for full search capabilities on both IM and Presence supported clients and Microsoft Lync or Microsoft Office Communicator.
Active Directory (AD) searches by IM and Presence supported clients return users regardless of where they are provisioned. Microsoft Lync or Microsoft Office Communicator Address Book searches continue to return all Microsoft Lync or Microsoft Office Communicator users and also any IM and Presence client users who have migrated to IM and Presence.
Contact Card information is available on both clients for all contacts.
Note
If an IM and Presence client user was never provisioned on Lync/OCS/LCS, you must perform an Active Directory update to the msRTCSIP-PrimaryUserAddress field for such users to ensure that the user is available to Microsoft Lync or Microsoft Office Communicator searches.
User migration
One of the primary advantages of a Partitioned Intradomain Federation deployment is that it allows a seamless transition from Lync/OCS/LCS to IM and Presence within an enterprise. Partitioned Intradomain Federation offers the following benefits:
IM and Presence client users and Microsoft Lync or Microsoft Office Communicator users share the same presence domain.
Users can exchange Availability and Instant Messaging within that shared domain.
Users can search for and add contacts regardless of where the user or contact is provisioned.
To further aid the migration process for administrators, a number of tools are available with this feature.
At a high level, the administrative flow for user migration is as follows:
License and assign migrating Lync/OCS/LCS users to IM and Presence.
Back up Lync/OCS/LCS data for migrating Lync/OCS/LCS users.
Export Lync/OCS/LCS contact lists for each of the migrating Lync/OCS/LCS users.
Disable Lync/OCS/LCS user accounts for migrating Lync/OCS/LCS users.
Delete Lync/OCS/LCS user data for migrating Lync/OCS/LCS users.
Import Lync/OCS/LCS contact lists into the IM and Presence database for the migrated users.
Deploy IM and Presence supported client on migrated users’ desktops.
IM and Presence provides tools for the following user migration steps:
Export Lync/OCS/LCS contact lists for each of the migrating Lync/OCS/LCS users.
Disable Lync/OCS/LCS user accounts for migrating Lync/OCS/LCS users.
Delete Lync/OCS/LCS user data for migrating Lync/OCS/LCS users.
Import Lync/OCS/LCS contact lists into the IM and Presence database for the migrated users.
Note
These user migration tools require that you install at least version 1.1 of the .NET Framework on the server from which you run the user migration tools.
The Export, Disable and Delete tools are provided in a zip file on cisco.com. The Import tool is accessible through the Cisco Unified CM IM and Presence Administration GUI.
Export Lync/OCS/LCS Contact Lists for Each of the Migrating Lync/OCS/LCS Users
This IM and Presence tool allows for bulk export of contact lists from Lync/OCS/LCS. The exported contact lists are written to a comma-separated values (CSV) file that is acceptable to the IM and Presence Contact List Import Bulk Administration Tool (BAT). The combination of these tools allows for end-to-end administrative bulk contact list migration.
Disable Lync/OCS/LCS User Accounts for Migrating Lync/OCS/LCS Users
IM and Presence contains a tool to disable the Lync/OCS/LCS user accounts in bulk. This tool disables Lync/OCS/LCS accounts by connecting to Active Directory and modifying the user’s Lync/OCS/LCS-specific attributes as required.
Delete Lync/OCS/LCS User Data for Migrating OCS Users
Lync/OCS/LCS users must be deleted from Lync/OCS/LCS to allow Partitioned Intradomain Federation routing from Lync/OCS/LCS to IM and Presence. However, when users are deleted from Lync/OCS/LCS, they are removed from the contact list of any Microsoft Lync or Microsoft Office Communicator users also. This IM and Presence tool deletes Lync/OCS/LCS user data in bulk, while ensuring that the users are not removed from the contact list of Microsoft Lync or Microsoft Office Communicator users.
Import Lync/OCS/LCS Contact Lists into IM and Presence Database for the Migrated Users
The IM and Presence BAT has been extended to support bulk contact list import. IM and Presence BAT takes a CSV file as input for this bulk import. When used in conjunction with the Lync/OCS/LCS Export Contact List tool, it allows for contact list migration from Lync/OCS/LCS to IM and Presence.
Note
Running the user migration tools has no affect on the capabilities of other Lync/OCS/LCS users who are signed into Microsoft Lync or Microsoft Office Communicator. However, Cisco recommends that you run the user migration tools during a scheduled maintenance window to reduce the load on the Lync/OCS/LCS and Active Directory system.