CMGT B Spark Hybrid Message Deployment Guide
CMGT B Spark Hybrid Message Deployment Guide
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
© 2023 Cisco Systems, Inc. All rights reserved.
CONTENTS
Note This deployment provides interoperability between your on-premises Jabber deployment and Webex App
users. This is different to the interoperability between cloud-based Jabber deployments and Webex App users
(see https://help.webex.com/article/nzx9su0 for more on that deployment).
On the left of the diagram is your on-premises deployment of Cisco Jabber and IM and Presence Service. On
the right is your organization in Webex, with your Webex App users. You manage this organization using
Control Hub.
The Hybrid Message enables interoperability between these two groups of users. The components that make
Hybrid Message possible are the message connector, hosted on Cisco Expressway infrastructure on your
premises, and the Message Service, running in the Webex cloud.
Licensing and Entitlement Factors Affecting Interoperability
• We assume that all users are previously licensed for Cisco Jabber, with Jabber registered to Cisco Unified
Communications Manager IM and Presence.
• You need any paid-for Webex app offer for your organization. You can order this through Cisco Commerce
Workspace.
You also need to have access to Cisco Webex Control Hub, with administrator privileges for your
organization (you get these as part of the ordering process).
• You should import all Jabber users into Control Hub and grant them all the "Message Free" entitlement.
This entitles all the Jabber users to the basic Webex App messaging functionality.
There are no additional paid license requirements for this basic messaging. Having this entitlement for
all users improves interoperability between those who are enabled for Hybrid Message and those who
are only licensed for Jabber.
• Hybrid Message can only work between users who are in the same organization in Control Hub. The
service does not enable Webex App users to communicate with Jabber users outside of their organization.
• Users who are enabled for Hybrid Message can use Jabber or Webex App to chat with all other users in
the organization, irrespective of whether the recipient is using Webex App or Jabber.
• Users who are not enabled for the Hybrid Message can use Jabber to chat with all other users in the
organization. They can use Webex App to chat with users who are enabled for Hybrid Message, but the
messages are not copied to the recipients' Jabber clients.
User Interactions
Figure 2: Interoperability Between Clients During Implementation
This diagram shows the progression of your user population as you implement Hybrid Message Service. At
the start, all users are on Cisco Jabber (point 1 on diagram). The diagram then shows the tasks that you perform
to get to the destination, where you have Hybrid Message Service enabled for some of your users (Point 3).
Now there are four ways to send chat messages:
• A user without Message Service uses Webex
• A user without Message Service uses Cisco Jabber
• A user with Message Service uses Webex
• A user with Message Service uses Cisco Jabber
The recipients can also use those four ways to receive chat messages, which means 16 possible interactions.
You can expect eight of them to work because they are interactions between the same clients (Jabber to Jabber
or Webex to Webex—point 2). Of the remaining eight interop scenarios, we expect three cases to fail:
Figure 4: Expected failure: Webex to Jabber, neither user has Hybrid Message Service
The sender is using Webex but is not enabled for Hybrid Message Service. The sender uses Webex to start a
direct space with the recipient. The recipient is using Jabber, so does not see the messages in Webex.
If the sender were enabled for Hybrid Message Service, the Webex chat messages would be copied to IM and
Presence and sent from the Jabber account. But, because the sender is not enabled for Hybrid Message Service,
the messages are not copied to IM and Presence, and so the recipient will not see them unless they use Webex.
Figure 5: Expected failure: Webex to Jabber client of a Hybrid Message Service user
The sender is using Webex but is not enabled for Hybrid Message Service. The sender uses Webex to start a
direct space with the recipient. The recipient is enabled for Hybrid Message Service but is using Jabber, so
does not see the messages.
This behavior is expected. We designed the service this way to reduce load, because we anticipate that you
will enable Hybrid Message Service for the "early adopters" in your organization, and that they will use Webex
as their primary chat client.
Figure 6: Expected failure: Jabber to Webex, neither user has Hybrid Message Service
The sender is using Jabber and starts a chat with the recipient’s Jabber contact. The recipient is using Webex
and does not see the Jabber conversation. The recipient is not enabled for Hybrid Message Service, so those
Jabber messages are not copied and sent to Webex.
The recipient remains unaware of the conversation unless they use Jabber. In that case, if offline storage is
disabled, the recipient may never see the conversation.
Deployment Models
Choosing a Deployment Model
Consider the following factors when choosing how you deploy Hybrid Message:
• Scale: How many IM and Presence Service users do you expect to serve? Will you need to add nodes /
clusters to improve the capacity of the service to meet that requirement?
We support 195,000 users per organization across multiple Expressway clusters.
We also support up to 5,000 Message Service users per Small Expressway, up to 6,500 users per Medium
Expressway, and up to 15,000 users per Large Expressway. This gives a maximum number of 75,000
on a cluster of 6 Expressways, because the capacity of one node is reserved for redundancy. See
https://help.webex.com/article/nv5p67g for an explanation of the Message Service capacity.
• Availability: How important is service availability to you? Do you need to deploy redundant nodes /
clusters to ensure continuous service in the event of a failure?
• Geography: Global distribution of users means that you may have data centres in multiple timezones.
Latency may be a factor to consider when choosing where to deploy your connector hosts.
• In each deployment scenario, remember that:
• Each Expressway cluster has up to six nodes, including the primary.
• You must register the primary node of each Expressway cluster with Webex.
• To connect an Expressway cluster to an IM and Presence Service cluster, enter the publisher's details
on the primary node of the relevant Expressway cluster. This action connects all nodes of the
Expressway cluster with all nodes of the IM and Presence Service cluster (diagrams show only the
primary to publisher connections, for clarity).
You must not connect all Expressway clusters to all IM and Presence Service clusters. We do not
support this scenario, because the potential benefit from redundancy is outweighed by the risk of
overloading the solution.
You must not associate multiple Expressway connector clusters with one IM and Presence Service
cluster (even though your IM and Presence Service cluster may be able to home more message and
presence users than your Expressway cluster can support). We do not support this scenario.
You may connect multiple IM and Presence Service clusters to each Expressway connector cluster.
We support up to 5 IM and Presence Service clusters per Expressway connector cluster.
• You can use Resource Groups in Control Hub to define your organization's geography, and then
assign Expressway resources to different resource groups that represent locations.
The set of users you assign to each resource group should correspond to the users in all IM and
Presence Service clusters served by the Expressways in those resource groups.
Figure 8: One Expressway Connector Cluster to Multiple IM and Presence Service Clusters
Figure 10: Not supported: Meshing Multiple Expressway Connector Clusters to Multiple IM and Presence Service Clusters
Instant Messaging Compliance Hybrid Message can work with IM and Presence Service that is
configured for compliance. Webex App does not support compliance
and Webex App to Webex App messaging is possible for blocked Jabber
users.
Feature Description
Message encryption Supported (mandated) between your premises and Webex.
• Messages from IM and Presence Service to Webex App are
encrypted by the message connector.
• Messages from Webex App to IM and Presence Service are
decrypted by the message connector.
• message connector makes TCP connections to IM and Presence
Service nodes. TLS is not supported on these connections.
Multiple on-premises domains message connector works with multiple XMPP domains.
Coresidency with other Hybrid The Message Connector supports coresidency with other
Services Expressway-based Hybrid Services (Hybrid Calling and Hybrid
Calendar ). Coresidency reduces the number of Hybrid Message users
carried by the connector host.
See https://help.webex.com/article/nv5p67g for details of coresidency
and capacity.
Data Security / Key Management The Hybrid Message is compatible with Hybrid Data Security.
System
We normally use the Webex Key Management System (KMS) for
securing Hybrid Message, but you have the option to use an on-premises
instance of KMS with Hybrid Message.
See https://www.cisco.com/go/hybrid-data-security for details of Hybrid
Data Security deployment.
Coresidency with Mobile and We do not recommend installing Message Connector on an Expressway
Remote Access (MRA) cluster that is used for MRA. However, if you do choose to do this, we
will only support up to 100 Message Service users per node, to a
maximum of 500 per cluster.
Deployment scale We currently support up to 195,000 users per organization enabled for
Hybrid Message, across multiple Expressway clusters.
This limit applies to the subset of users in your organization that use
Hybrid Message. It does not affect the number of users that you enable
for Webex App; you should import all your Jabber users to Webex.
See https://help.webex.com/article/nv5p67g for details of Hybrid
Message scale and coresidency.
You can deploy up to 5 IM and Presence Service clusters with one
Expressway connector cluster.
We do not recommend using multiple connector clusters with one IM
and Presence Service cluster.
Feature Description
XMPP or SIP messaging federation Hybrid Message service works when you have interdomain federation
between the Jabber deployment and between the IM and Presence Service and a third-party messaging
another domain provider.
This means that when a contact in a federated organization sends a
message to a Hybrid Message user, the message appears to that user in
both Jabber and the Webex App.
Note XMPP or SIP federation with Hybrid Message service is
not supported in the Webex for Government environment.
High availability and failover of IM The Message Connector is aware of the high availability setting on
and Presence Service nodes Presence Redundancy Groups. It responds automatically to failover /
fallback events.
Webex for Government: Hybrid Hybrid Message is a service that enables interoperability between Jabber
Message to enable interoperability users and Webex App users. This service provides an option for
between Webex App and Jabber migrating users from Jabber, connected to IM & Presence on your
premises, to Webex App.
Users who are enabled for this service can use the Webex App to read
and respond to messages from Jabber users.
Contacts
message connector supports Webex App contacts. message connector does nothing with Jabber contacts.
Note Existing contacts will not be transitioned across from Jabber to Webex.
• When the Webex App user deletes a message from the 1:1 space, the Jabber user is notified that "Username
used Webex App to delete a previously posted message". The corresponding Jabber message is not
deleted.
• Plain text only. Webex App markdown is not converted to Jabber rich text. Jabber rich text is not converted
to Webex App markdown.
• Editing messages in Webex App is supported. When a Message Service user edits a message in Webex
App, the original version of the message is deleted in Webex App. The Message Connector sends the
edited message to Unified CM IM and Presence.
The recipient on Jabber sees the edited message as a new message, they also receive a notification
"Username used Webex App to delete a previously posted message." However, they can disregard the
delete notification, as they still see the original version of the message in Jabber.
Webex App doesn't tell the user that the original message is still visible in Jabber - even though the
original message is no longer visible in Webex App.
Offline Storage
Offline storage affects one to one messaging interactions from Hybrid Message users.
The expected behavior, when a Hybrid Message-entitled Webex App user sends a message to another Webex
App user, is for the sender's Jabber to also send that message to the recipient's Jabber. If the recipient is not
using Jabber then, depending on the state of offline storage, one of the following will happen:
• Offline storage is enabled on IM and Presence Service: The message is stored and will be sent if the
recipient signs in to Jabber.
• Offline storage is not enabled on IM and Presence Service: The message is discarded and the sender will
see a "Message could not be delivered" error, if they are using versions before 12.5.
In this case, the sender and recipient may both have seen that this message has been delivered, because
they're using Webex App. This is expected behavior but it could confuse users.
Offline storage is governed by the Suppress offline instant messaging setting on IM and Presence Service.
Note There is a known issue with offline messaging. When a Message Service user comes back online in Webex,
stored messages are replayed in Webex but they may be out of sequence. The same messages are replayed in
sequence in the user's Jabber client.
Group Messaging
Not supported. Webex App spaces are not converted to Jabber group chats. Jabber group chats are not converted
to Webex App spaces.
The following is a list of known behaviors when users try group messaging interoperability. Note that there
is usually no indication of a problem, which could cause confusion for your users.
• When Jabber users are creating group chats, or inviting contacts to group chats, they will be able to
browse and select from Webex App users who are entitled for Hybrid Message. However, when they try
to add these contacts to the group chat, the Webex App users are not added. Jabber users are added to
the group chat as normal. There is no UI feedback to indicate a problem.
• If a Jabber user, who is entitled for Hybrid Message, switches to using Webex App, that user is immediately
removed from the active rosters in all group chats with other Jabber users.
• Webex App users can add any Webex App-only or Hybrid Message users to spaces. For Hybrid Message
users who are using Jabber, there is no indication that they have been added to the Webex App space.
The only indication of this problem is to the other users in the space; there will be no read receipts from
the affected Hybrid Message users.
• If a Hybrid Message user was once using Jabber to participate in a persistent group chat, and then switches
to use Webex for their messaging interactions, their Active status in Webex is translated to Available
presence in the persistent group chat. The other Jabber users may assume that the user is following the
conversation. However, if the apparently Available user doesn't open Jabber, they may never be aware
of later posts in that persistent conversation.
Presence Translation
We have taken a minimal approach to presence translation, based on the premise that the Hybrid Message
Service is a transitionary arrangement to facilitate migration from Jabber to Webex App. Our design does not
account for users indefinitely using both clients, because the way Unified CM IM and Presence calculates the
composed presence can result in Jabber users seeing unexpected presence status of their contacts.
Note This limitation has a consequence on the Do Not Disturb behavior: when a user manually resets their Jabber
presence from "Do Not Disturb" back to "Available", the corresponding Webex App status does not change.
This is confusing because typically this action would reset the presence on all of the user's logged in
clients/devices.
Whenever a user manually changes their Jabber status, IM and Presence Service gives priority to the manual
presence. In this case, the device presence - whether from Webex App or Jabber - is not shown to other Jabber
users.
The following table lists some of the presence states that Jabber users could see when you have Hybrid Message
Service users. This is a best effort at mapping the possible scenarios because we cannot exhaustively test all
possible interactions that occur in your environment:
Presence of a user, as How that presence was established by IM and Presence Service
seen by another
Jabber user
Available • The contact is only using Jabber, and Jabber has determined that the user is
Available.
The contact's presence
indicator is green. • The contact is using Jabber and Webex App, and Jabber has determined that
the user is Available. IM and Presence Service received that presence update
more recently than presence from the same user's Webex App app.
• Jabber users do not see this presence for a user who is only using Webex App.
Available @ Webex • The contact is only using Webex App, and was Active on Webex App within
the last 10 minutes.
The contact's presence
indicator is green, and • The contact is using Jabber and Webex App, and was Active on Webex App
displays text "@ within the last 10 minutes. IM and Presence Service received that presence
Webex". update more recently than device presence from the same user's Jabber client.
• Jabber users do not see this presence for a user who is only using Jabber.
Available with custom • The contact is only using Jabber, and has manually changed their presence
message status.
• The contact is using Jabber and Webex App, and has manually changed their
presence status in Jabber. IM and Presence Service prefers the manually edited
presence from Jabber over the device presence update from the same user's
Webex App app.
• Jabber users do not see this presence for a user who is only using Webex App.
Away • The contact is only using Jabber, and Jabber has determined that the user is
Away.
The contact's presence
indicator is amber. • The contact is using Jabber and Webex App, and Jabber has determined that
the user is Away. IM and Presence Service received that presence update more
recently than presence from the same user's Webex App app.
• Jabber users do not see this presence for a user who is only using Webex App.
Away @ Webex • The contact is only using Webex App, and was Active more than 10 minutes
ago, but within the last 72 hours. In Webex App this displays as, for example,
The contact's presence
"Active 2 hours ago" or "Active yesterday".
indicator is amber, and
Presence of a user, as How that presence was established by IM and Presence Service
seen by another
Jabber user
displays text "@ • The contact is using Jabber and Webex App, and was Active on Webex App
Webex". more recently than they were Available in Jabber. IM and Presence Service
received the Webex App device presence more than 10 minutes ago but within
the last 72 hours. Also, it received that presence update more recently than it
received device presence from the same user's Jabber client.
• Jabber users generally do not see this presence for other users who are only
using Jabber. Note that users who are enabled for Hybrid Message Service,
but are not actually using Webex App, still have their presence composed as
if they were using Webex App. In most cases their Jabber presence takes
precedence, but it is possible that they can show as Away "@ Webex"; for
example, if they are out of office and their calendars are integrated with Cisco
Webex.
• Away @ Webex can also mean that the user is Out of Office in Webex App.
Webex App shows an Airplane overlay on that user's profile picture.
Out of Office status in Webex App is provided by integration with user
calendars. If the user's Webex App app is not integrated with their calendar,
there is no Out of Office status in Webex App.
If a Webex App user is using Webex App while their calendar reports Out of
Office, their Webex App status could change back to Active. This would
correctly be translated to Available in that user's Jabber presence.
• Webex App user is not sharing status (the Show statuses box is unchecked in
Webex App settings).
Webex App users can choose to hide their status, which also prevents them
from seeing status of other Webex App users. A Jabber user always sees these
buddies as Away.
The Message Connector will never destroy the user's XMPP session while the
user is in an Away state. If the user is not showing their status, their session
will persist even if they have not used Webex App within the previous 72
hours.
Away with custom • The contact is only using Jabber, and has manually changed their presence
message status.
• The contact is using Jabber and Webex App, and has manually changed their
presence status in Jabber. IM and Presence Service prefers the manually edited
presence from Jabber over the device presence update from the same user's
Webex App app.
• Jabber users do not see this presence for a user who is only using Webex App.
Do Not Disturb This is a user level setting, which means that all the user's logged in clients/devices
- including phones where applicable - have the "Do Not Disturb" status.
The contact's presence
indicator is red. • The contact is using Jabber and has manually changed status to Do Not Disturb.
Presence of a user, as How that presence was established by IM and Presence Service
seen by another
Jabber user
If the user is also using Webex App, their Webex App presence is unaffected
because Message Connector does not translate presence from Jabber to Webex
App.
Also, IM and Presence Service always prefers the manual DND from Jabber
over the device presence from Webex App.
• The contact is using Webex App and has manually changed status to Do not
disturb: for a period between 30 minutes and 24 hours.
If a Webex App user has turned on "Do not disturb", then Webex App shows
other Webex App users a crescent Moon overlay on that user's profile picture.
• The contact is using both clients and has manually changed status to Do not
disturb: for a period between 30 minutes and 24 hours.
This status persists in both clients until the period expires in Webex App, or
until the user changes it in Webex App.
A user who is using both clients cannot reset their Do Not Disturb status by
changing their presence in Jabber (they can use Webex App, or wait for the
DND to expire in Webex App). This is because the Message Connector does
not translate presence from Jabber to Webex App.
Offline The other user has not used Webex App or Jabber within the last 72 hours. The
message connector destroys the XMPP session it was holding for the offline user's
The contact's presence
Webex App.
indicator is gray.
You can see the count of inactive Hybrid Message users, on a particular message
connector host, at Applications > Hybrid Services > Message Service > Message
Service Status.
File Transfer
• Webex App users can share files with Jabber users. When a file is attached to a 1:1 space in Webex App,
the Jabber user gets a link to that file.
• The Jabber user gets a message if the Webex App user deletes a file from the 1:1 space.
• A Jabber user cannot send files to Webex App users.
When a Jabber user is communicating with a Webex App user, Jabber's file transfer and screen capture
options are disabled.
However, if the IM and Presence Service has Managed File Transfer (MFT) enabled, the user's Jabber
options for these features appear to be usable. In this case, if the Jabber user tries to send a file, the Webex
app user receives a notification that a file has been sent in Jabber.
If the Webex user is not logged in to Jabber when the file is sent, they do not receive the file.
This behavior affects the recipient whether they are using Jabber on-premises (registered to IM and
Presence), or Jabber registered to Webex.
Migration Considerations
If you're using Hybrid Message Service to gradually migrate your user base from Cisco Jabber to Webex, the
following issues and mitigations may help your planning.
• Admin-generated invitations to join Webex: One requirement to make Hybrid Message Service work
is to have all your Jabber users in Cisco Webex, imported by CSV or by Hybrid Directory Service. When
you import users, they will all get invitations to start using Webex, which you may want to prevent. If
your organization is SSO-enabled in Control Hub, you can suppress the email invite behavior before you
import the users. See https://help.webex.com/article/g5ey83.
Unfortunately, you cannot suppress these initial email invitations unless your organization is SSO-enabled.
Suppressing the email invitations will help to mitigate unintended early access to Webex.
• User-generated invitations to join Webex: Cisco Webex normally invites users (by email) to start
using the Webex app, if they are already in Cisco Webex but not yet using the app. When you enable
Hybrid Message Service, this "self subscribe" behavior is automatically disabled for your organization.
The reason we designed it this way is because whenever a Message Service user messages another Jabber
user, Webex generates an email to invite the recipient to start using the Webex app. This amounts to
spam for any Jabber user who is not yet using Webex.
• Unintended early access to Webex: One requirement to make Hybrid Message Service work is to have
all your Jabber users in Cisco Webex, imported by CSV or by Hybrid Directory Service. You may not
want these users to start using Webex just yet but, if they are synchronized with Directory Service and
also have SSO enabled, there is no technical reason to prevent them from using the Webex app. This
could lead to interoperability problems for those users who are not enabled for Hybrid Message Service.
For example:
• A Hybrid Message user, talking to another user in Webex, can only see their own half of the
conversation when looking at it in Jabber. The other user will also appear to be Offline in Jabber
(even though they are Active in Webex).
• In the same scenario, if the Hybrid Message user tries to use Jabber to continue the conversation,
the messages go to the other user in Webex, but that user's responses do not come back to Jabber.
If you are following a migration plan that requires users to stay on Jabber, despite technically being able
to use Webex, you may want to prevent client installations or advise your users of potential interoperability
issues.
• A user's Jabber ID (JID) is not the same as a user's Webex UID: The Webex UID must be the user's
email address but the Jabber ID does not have to be the email address, even though it looks like one.
Do not search for a user's JID when you are in Webex. Use the JID (or name) to search for users in the
Jabber client. Use the email address (or name) to search for users in Webex.
• Offline message suppression: Users who start chatting to each other using Webex will still have access
to Cisco Jabber. If a user is online with both clients, the Hybrid Message Service tries to deliver messages
with both clients. If the recipient is offline in Jabber, the sender could receive misleading offline messages
from IM and Presence service.
To mitigate this issue:
1. Sign in to Cisco Unified CM IM and Presence Administration and go to Messaging > Settings.
2. Clear the box labeled Suppress offline instant messaging and click Save.
Note There is a known issue with offline messaging. When a Message Service user comes back online in Webex,
stored messages are replayed in Webex but they may be out of sequence. The same messages are replayed in
sequence in the user's Jabber client.
5. Webex securely sends the message to the recipient's Webex App client. Description of the mechanism is
beyond the scope of this document.
Basic messaging Webex App clients Ephemeral TCP Webex hosts 443
XMPP (IM and Connector host 30000-35999 TCP Unified CM IM and 7400
Presence) Expressway Presence publisher
Messaging and Presence Cisco Jabber clients Ephemeral TCP Unified CM IM and 5222
Presence publisher
You must be licensed to use Cisco Webex, so you can create your organization using Control Hub.
Product SKU
Cisco Webex Any cloud paid offer
You need to use the following systems to deploy and manage your Hybrid Message. These are more generally
required when you deploy Webex App and Hybrid Services, not only for Hybrid Message.
Directory Connector [Optional] Map user attributes from your on-premises directory into
Control Hub, so you can grant them ability to use Hybrid Services. See
https://www.cisco.com/go/hybrid-services-directory
Cisco Unified CM Administration Manually create users, or integrate with your on-premises directory to
provision users for IM and Presence Service.
Firewalls Open the required ports on firewalls between the component systems.
You must deploy Expressway to host the connectors. Organizations using Cisco Hosted Collaboration Solution
do not need Cisco Expressway on their premises. Instead, their Hosted Collaboration Solution partner will
deploy it in the cloud as part of their Hybrid Services offering.
Requirements Version
Cisco Expressway Connector Host You can download the software image from software.cisco.com at no
charge.
We recommend the latest released version of Expressway for connector
host purposes. See Expressway Connector Host Support for Cisco Webex
Hybrid Services (https://collaborationhelp.cisco.com/article/ruyceab)
for more information.
We recommend that you enable SSO for your organization (in Control Hub) before you import Jabber users
(see https://help.webex.com/lfu88u). With an SSO-enabled org, you have the option to suppress email invitations
to imported Jabber users, if you don't intend to give those users access to Webex (see https://help.webex.com/
nqj88gt).
You can manage your user population the following ways:
• Manually, by entering users individually in Control Hub.
• By importing a list of users from a file (comma separated values, based on a Cisco-supplied template)
using Control Hub.
You can also use Control Hub to do an export-edit-import round trip with CSV files, and thus to bulk
modify the users' service entitlements.
• [Preferred] By synchronizing your organization in Webex with your on-premises directory. This option
is called Hybrid Directory Service.
See Ways to Add and Manage Users in Cisco Webex Control Hub (https://help.webex.com/nj34yk2).
To summarize: your user details may exist in several places, but they must at least be in Webex and in Unified
CM Administration. The attribute that uniquely identifies the users in all places is their email address.
Irrespective of how you create the user populations on-premises and in the cloud, the users' email addresses
must match in all places.
Change a Users Email Address
Administrators have the functionality in Control Hub to make changes to a users' email address.
1. Sign in to https://admin.webex.com
2. Click Users and then click a username to open that users' configuration.
Note Ensure you update the users' mail id in Cisco Unified CM to match the new email address in Control Hub. It
can take up to 10 minutes for message connector to pick up the user mail id change in Unified CM.
Procedure
What to do next
Note As an administrator of hybrid services, you retain control over the software running on your on-premises
equipment. You are responsible for all necessary security measures to protect your servers from physical and
electronic attacks.
Procedure
Step 1 Obtain full organization administrator rights before you register any Expressways, and use these credentials
when you access the customer view in Control Hub (https://admin.webex.com).
Step 2 Deploy the Expressway-C connector host in a cluster to account for redundancy. Follow the supported
Expressway scalability recommendations:
• For Hybrid Message on a dedicated Expressway-C:
• message connector can be hosted on multiple Expressway-C clusters of up to 6 nodes each.
• message connector can be used with multiple Unified Communications Manager IM and Presence
Service clusters.
• You do not require a release key, or an Expressway series key, to use the virtual Expressway-C for Hybrid
Services. You may see an alarm about the release key. You can acknowledge it to remove it from the
interface.
• Use the Expressway web interface in a supported browser. (See the Cisco Expressway Administrator
Guide.) The interface may or may not work in unsupported browsers. You must enable JavaScript and
cookies to use the Expressway web interface.
Step 4 If this is your first time running Expressway, you get a first-time setup wizard to help you configure it for
Hybrid Services.
Select Webex Hybrid Services. This ensures that you will not require a release key.
Step 5 Check that the following requirements are met for the Expressway-C connector host. You would normally
do this during installation. See the Cisco Expressway Basic Configuration Deployment Guide, in the list of
Cisco Expressway Configuration Guides on cisco.com, for details.
• Basic IP configuration (System > Network interfaces > IP)
• System name (System > Administration settings)
• Here are the minimum clustering settings required, but the Cisco Expressway Cluster Creation and
Maintenance Deployment Guide has more detail:
• Enable H.323 protocol. On Configuration > Protocols > H.323 page, set H.323 Mode to On.
H.323 mode is required for clustering, even if the Expressway does not process H.323 calls.
Note You may not see the H.323 menu item if you used the Service Select wizard to configure
the Expressway for Hybrid Services. You can work around this problem by signing in
to the Expressway console and issuing the command xconfig H323 Mode: "On".
Caution To ensure a successful registration to the cloud, use only lowercase characters in the hostname
that you set for the Expressway-C. Capitalization is not supported at this time.
Step 7 If you have not already done so, open required ports on your firewall.
• All traffic between Expressway-C and the Webex cloud is HTTPS or secure web sockets.
• TCP port 443 must be open outbound from the Expressway-C. See https://collaborationhelp.cisco.com/
article/WBX000028782 for details of the cloud domains that are requested by the Expressway-C.
Step 8 Get the details of your HTTP proxy (address, port) if your organization uses one to access the internet. You'll
also need a username and password for the proxy if it requires basic authentication. The Expressway cannot
use other methods to authenticate with the proxy.
• We tested and verified Squid 3.1.19 on Ubuntu 12.04.5.
• We have not tested auth-based proxies.
Note If your organization uses a TLS proxy, the Expressway-C must trust the TLS proxy. The proxy's
CA root certificate must be in the trust store of the Expressway. You can check if you need to
add it at Maintenance > Security > Trusted CA certificate .
Note The details of the proxy, as configured on the primary Expressway in the connector host cluster,
are shared throughout the Expressway cluster. You cannot configure different proxies for different
nodes in the cluster.
Step 9 Review these points about certificate trust. You can choose the type of secure connection when you begin the
main setup steps.
• Hybrid Services requires a secure connection between Expressway-C and Webex.
You can let Webex manage the root CA certificates for you. However, if you choose to manage them
yourself, be aware of certificate authorities and trust chains; you must also be authorized to make changes
to the Expressway-C trust list.
Procedure
• If this is the first connector host you're registering, click Set up on the card for the hybrid service you're
deploying, and then click Next.
• If you've already registered one or more connector hosts, click View all on the card for the hybrid service
you're deploying, and then click Add Resource.
The Webex cloud rejects any attempt at registration from the Expressway web interface. You must first register
your Expressway through Control Hub, because the Control Hub needs to hand out a token to the Expressway
to establish trust between premises and cloud, and complete the secure registration.
• Existing Expressways—choose Select an existing Expressway cluster to add resources to this service,
and then choose the node or cluster from the drop-down that you previously registered. You can use it
to run more than one hybrid service.
Tip If you're registering a cluster, register the primary peer. You don't need to register any other peers,
because they register automatically when the primary registers. If you start with one node set up
as a primary, subsequent additions do not require a system reboot.
Step 4 Click Next, and for new registrations, click the link to open your Expressway-C. You can then sign in to load
the Connector Management window.
Step 5 Decide how you want to update the Expressway-C trust list:
A check box on the welcome page determines whether you will manually append the required CA certificates
to the Expressway-C trust list, or whether you allow Webex to add those certificates for you.
Choose one of the following options:
• Check the box if you want Webex to add the required CA certificates to the Expressway-C trust list.
When you register, the root certificates for the authorities that signed the Webex cloud certificates are
installed automatically on the Expressway-C. This means that the Expressway-C should automatically
trust the certificates and be able to set up the secure connection.
Note If you change your mind, you can use the Connector Management window to remove the
Webex cloud CA root certificates and manually install root certificates.
• Uncheck the box if you want to manually update the Expressway-C trust list. See the Expressway-C
online help for the procedure.
Caution When you register, you will get certificate trust errors if the trust list does not currently have
the correct CA certificates. See Certificate Authorities for Hybrid Services, on page 35.
Step 6 Click Register. After you're redirected to Control Hub, read the on-screen text to confirm that Webex identified
the correct Expressway-C.
Step 7 After you verify the information, click Allow to register the Expressway-C for Hybrid Services.
• Registration can take up to 5 minutes depending on the configuration of the Expressway and whether
it's a first-time registration.
• After the Expressway-C registers successfully, the Hybrid Services window on the Expressway-C shows
the connectors downloading and installing. The management connector automatically upgrades itself if
there is a newer version available, and then installs any other connectors that you selected for the
Expressway-C connector host.
• Each connector installs the interface pages that you need to configure and activate that connector.
This process can take a few minutes. When the connectors are installed, you can see new menu items on
the Applications > Hybrid Services menu on your Expressway-C connector host.
Troubleshooting Tips
If registration fails and your on-premises environment proxies the outbound traffic, review the Before You
Begin section of this procedure. If the registration process times out or fails (for example, you must fix
certificate errors or enter proxy details), you can restart registration in Control Hub.
Note The issuers used to sign the Webex host certificates may change in future, and the table below may then be
inaccurate. If you are manually managing the CA certificates, you must append the CA certificates of the
issuing authorities that signed the currently valid certificates for the hosts listed below (and remove
expired/revoked CA certificates).
Common identity O=VeriSign, Inc., Windows Server 2003 or To synchronize users from your
service OU=Class 3 Public Windows Server 2008 hosting Active Directory with Webex
Primary the Cisco directory connector and to authenticate Hybrid
Certification Services users
Expressway-C
Authority
Related Topics
Supported Certificate Authorities for Cisco Webex
Procedure
Step 1 From Cisco Unified CM Administration, go to User Management > Application User, and then choose one:
• Click Find and, from the list, choose the administrator account that the connector will use to communicate
with Unified Communications ManagerIM and Presence Service.
• Click Add New to create a new application user account.
Step 2 Configure the account with the Standard AXL API Access role.
Step 3 Click Save.
Procedure
Step 1 Go to Applications > Hybrid Services > Message Service > Message Service Configuration
Step 2 Click New.
Step 3 Enter the hostname or IP address of the IM and Presence Service publisher node that has Cisco AXL Web
Service enabled.
The connector uses AXL to query the publisher and discover the other nodes in the cluster.
Step 4 Enter the credentials of the message connector AXL account you created on the IM and Presence Service
publisher.
Note This must not be the main administrator account. You must create an account explicitly for the
Message Connector.
Step 5 (Optional) Change Certificate validation to Disabled if you want Expressway to waive the check on the
server certificate from the publisher node.
If certificate validation is enabled (which is the default), then the tomcat certificate from the IM and Presence
Service node must be valid and signed by a CA that the Expressway trusts. If you are using a self-signed
certificate, copy it into the Expressway's Trusted CA certificate list.
What to do next
Start the message connector, on page 37
Procedure
Step 1 From Expressway-C, go to Applications > Hybrid Services > Connector Management, and then click
Message Connector.
Step 2 Choose Enabled from the Active drop-down list.
Step 3 Click Save.
The connector starts and the status changes to Running on the Connector Management window.
Procedure
From Expressway-C, go to Applications > Hybrid Services > Message Service > Message Service Status.
Verify the configuration items in the Status column.
What to do next
Enable Hybrid Message for Users, on page 38
Note When you use bulk import or directory synchronization to import users, users must have email addresses in
the source system. Those must be the addresses they use for Webex App because you map them to the Webex
user ID.
If a user does not have an email address in IM and Presence Service, the message connector cannot discover
the user. Hybrid Message does not work for that user.
Using Cisco Directory Connector you can map a chosen attribute (eg. the mail attribute or the
userPrincipalName attribute) to the Webex UID, but the value of the attribute must be the user's email
address.
Procedure
Step 1 Sign in to https://admin.webex.com, go to Users, choose a specific user from the list, or use the search to
narrow the list, and then click the row to open an overview of the user.
Step 2 Click Edit, and then ensure that the user is assigned at least one paid service under Licensed Collaboration
Services. Make necessary changes, and then click Save.
Step 3 Open the Hybrid Services tab, and toggle on Message Service then save.
The user experiences a delay of up to one hour before reliably being able to send messages from Webex to
Jabber.
Procedure
Step 2 The other user opens Cisco Jabber client. Let's call this person user B or Bob for the sake
of this procedure.
The status page and this reference topic are ordered by the level of impact that the status item will have on
your service.
Connectivity to Webex
If this status is anything other than "Operational", then there is a problem between this Expressway and Webex.
It could be a problem with the Expressway (check Status > Alarms), the service (check status.webex.com),
or the network between them (check the proxy if you have one, check firewalls allow outbound HTTPS
connections, use network diagnostic tools to establish if routes exist).
Users from connected IM and Presence clusters is the count of users that the connector gathers from the
directly connected IM and Presence Service infrastructure. These users are "homed" on (or "local" to) the IM
and Presence clusters whose publishers' details you entered on this Expressway cluster's primary node.
We need to distinguish this number because, when the connector makes AXL queries to those publishers, the
publishers return all the users they know about. This includes 'intercluster' users, which the queried publishers
know about because ICSA (Intercluster Sync Agent) is working across multiple IM and Presence clusters.
This number is the theoretical maximum of users that you could have using the service through this connector
host cluster. In practice, you would probably enable a smaller subset of these, as part of a migration plan.
Users from all IM and Presence clusters (ICSA) is the count of users known to all IM and Presence clusters
that are synchronized (by ICSA) with the publishers you added to the connector configuration. The number
includes the count of local users (the previous number in this section). So, when you read the two numbers,
you can think of them as, for example, 300 of 1000, if 300 users are homed on the directly connected IM and
Presence clusters and 1000 are synchronized between multiple IM and Presence clusters.
You can use the relationship between these numbers to help validate or troubleshoot your Message Service
deployment. For example, if you know you should have 1000 synchronized users but the total is less, you
may have an intercluster sync agent problem. If you only have one cluster, or if all the IM and Presence
publishers are configured on this connector, then the two numbers should be the same. If both numbers are
0, it could indicate an AXL query problem or a message connector configuration problem.
Users Enabled for Hybrid Message Service is the number of Hybrid Message-enabled users that Webex
has assigned to this particular Expressway cluster. It is typically smaller than Users from connected IM and
Presence clusters.
When you grant the message service to your users in Control Hub, the cloud communicates with the connector
hosts to determine which connectors know about those users. The cloud then assigns those users to those
connectors in a balanced way.
Active Message Service Users is the count of enabled users that are currently using the Hybrid Message.
Users are considered Active if, within the 72 hours leading up to now, they have used Webex App to read or
write messages to or from Cisco Jabber. It is also shown as a percentage of Users Enabled for Hybrid Message
Service.
Users not Active for 72 Hours or more is the count of enabled users that are not currently using the Hybrid
Message. Within the rolling 72 hour period up to now, these users did not use Webex App to read or write
messages to or from Jabber. The connector uses this characteristic to improve performance, by deleting any
sessions that are held by inactive users. In typical usage across your deployment, you can expect there to be
some inactive users (holiday etc.) but the number should typically be lower than the Active users. It is also
shown as a percentage of Users Enabled for Hybrid Message Service.
• Certificate validation is either On or Off, depending on the choice you made when you connected to
this node's publisher. If it's On (default), then the Expressway must be able to validate the certificate
presented by this node, or the Hybrid Message will not work.
• Message Service Users from this Node is the count of Hybrid Message-enabled users who are assigned
to this connector and are homed on this IM and Presence Service node. Each IM and Presence Service
node that is listed on this status page contributes a portion to the total count of Users Enabled for Message
Service, shown near the top of the page.
• Active Message Service Users is the count of enabled users that are currently using the Hybrid Message,
and are homed on this IM and Presence Service node. Each IM and Presence Service node that is listed
on this status page contributes a portion to the total count of Active Message Service Users, shown near
the top of the page.
• Users not Active for 72 Hours or more is the count of enabled users that are not currently using the
Hybrid Message, and are homed on this IM and Presence Service node. Each IM and Presence Service
node that is listed on this status page contributes a portion to the total count of Users not Active for 72
Hours or more, shown near the top of the page.
progresses at a rate that does not overwhelm the target node. For example, with 5,000 user sessions failing
over, you can expect to wait approximately 30 minutes for the service to stabilize after the start of the controlled
outage.
Wait until the transition process is complete, then you can do your maintenance on the IM and Presence
Service node. Finally, you can manually fallback the sessions to the original node. You can expect a similar
wait for the fallback to complete.
Uncontrolled Outages
The Hybrid Message Service automatically responds to an unexpected failure of an IM and Presence Service
node.
As with the controlled outage, the Message Connector is rate limited when creating new sessions on the
remaining IM and Presence Service node. The connector could take up to 15 minutes to start transitioning
users to the other node, and then progresses at a rate that does not overwhelm the target node. For example,
with 5,000 user sessions failing over, you can expect to wait approximately 30 minutes for the service to
stabilize after an unexpected failure of one of the IM and Presence nodes.
The service is not robust to other uncontrolled outages, including but not limited to:
• Unexpected failure of an Expressway.
• Unexpected failure of Message Connector.
• Unexpected failure of the IM and Presence services that Hybrid Message Service depends on, including
XCP, AXL, and the Presence Engine.
Procedure
Step 1 Sign in to the primary peer of the Message Connector Expressway cluster, and go to Applications > Hybrid
Services > Connector Management.
Step 2 Click Message Connector.
Step 3 Choose Disabled from the Active drop-down list.
Step 4 Click Save.
The connector stops.
Service Activation
Sign in to https://admin.webex.com
• Does your organization have the Hybrid Message card?
User Activation
Check Control Hub for user activation problems:
1. Sign in to https://admin.webex.com
2. Click Users and find the users you're interested in.
You can sort the list by Status.
3. Click a username to open that user's configuration.
If there is no Message Service link, you need to onboard the user for Hybrid Message.
4. Click Message Service.
The slider should be on (to the right position). If it is not, slide it to on and save: the user status goes
Pending for a few seconds and then Active.
5. If the user status is Error, review the message. Also, click See history to get more information about what
is preventing this user's activation.
6. Correct the problem preventing activation, then come back to the user and click Reactivate User.
If the user status is still not Active, you should raise a case.
Connector Status
If Hybrid Message is not working for all users, or a large subset, you should check the message connector
status on Expressway:
1. Sign in to the primary peer of the cluster you registered and configured for Hybrid Message.
2. Go to Applications > Hybrid Services > Connector Management.
• Is Management Connector running?
• Is message connector running?
3. Go to Applications > Hybrid Services > Message Service > Message Service Status
4. Review the page for any errors between the Expressway and the configured IM and Presence Service
nodes.
Status should be Operational. There should be users assigned on-premises and subscribed to the cloud.
If people are using Hybrid Message, then there should be some percentage of users with active sessions.
Note There is a known issue where the software version of the IM and Presence node is not correctly synchronized
on the Expressway after the IM and Presence node is upgraded. This is a purely cosmetic issue as the Message
Connector does not use the version information for any purpose. You can synchronize the IM and Presence
version by restarting the Message Connector. We intend to resolve this issue in a future Message Connector
release.
You can read what the message connector is logging by reviewing the Hybrid Services Log on the Expressway:
1. Manually enter the URL for the /setaccess page, e.g. https://<IPAddressOrFQDN>/setaccess
2. Enter the value qwertsys in the Access password field then click Enable access.
The Experimental menu is visible now.
3. Click Experimental > Hybrid Services Log > Hybrid Services Log.
4. Investigate the log for error conditions.
If you are having a repeatable or persistent problem, you should raise a case. You may be advised to
change the log levels or take a diagnostic log to send to Cisco (Maintenance > Diagnostics).