Introducing the Collaboration Service 10.2 for the Enterprise IM app 3.1 introducing The Collaboration Service Sender Instant Messaging Server Collaboration Service 10 device Recipient V. 1.0 June 2013 Copyright 2013. All rights reserved. 1 of 13
Introducing the Collaboration Service 10.2 for the Enterprise IM app 3.1 About the Collaboration Service The Collaboration Service provides an encrypted connection between your organization's instant messaging server and the Enterprise IM app on 10 devices so that users can use enterprise instant messaging. You can install the Collaboration Service on the computer that hosts Enterprise Service 10 version 10.1 or later or on a separate computer. The following components are required for instant messaging: Collaboration Service Enterprise IM app on the device V. 1.0 June 2013 Copyright 2013. All rights reserved. 2 of 13
Introducing the Collaboration Service 10.2 for the Enterprise IM app 3.1 Collaboration Service features and benefits Collaboration Service Manage the Collaboration Service using the Administration Service Install and update the Collaboration Service independently from Enterprise Service 10 version 10.1 Manually or automatically provision the Collaboration Service as a trusted application in Microsoft Active Directory when using Microsoft Office Communications Server or Microsoft Lync Server Enterprise IM app Users can start and manage chats on their 10 devices Users can perform remote searches for and add contacts to a contacts list Users can manage their contacts and group contacts Users can search for and filter contacts in their contacts list Users can send email messages to Enterprise IM contacts or conversation participants Users can view the presence of their contacts and their conversation history in the Enterprise IM app Users can email their conversations to themselves and their contacts Users can add contacts from other organizations to their contact list Users can call another user in a chat Users can view contacts that are mobile Users can view a user's avatar, photo, or default work picture as the user s contact image High Availability The Collaboration Service supports high availability when you have multiple instances installed in your environment. 10 devices communicate with an available instance of the Collaboration Service, if the original Collaboration Service in the environment is not available. The graphic shows an environment with a Enterprise Service 10 instance and two instances of the Collaboration Service. Instant messaging servers Collaboration Service (Instance 1, active) Collaboration Service (Instance 2, active) Enterprise Service 10 version 10.1 or later Main route Alternate route 10 device (running 10 OS version 10.1) V. 1.0 June 2013 Copyright 2013. All rights reserved. 3 of 13
Introducing the Collaboration Service 10.2 for the Enterprise IM app 3.1 Supported instant messaging servers The Collaboration Service supports the following instant messaging servers: IBM Sametime 8.5 IBM Sametime 8.5.2 Microsoft Office Communications Server 2007 R2 Microsoft Lync Server 2010 Microsoft Lync Server 2013 V. 1.0 June 2013 Copyright 2013. All rights reserved. 4 of 13
Introducing the Collaboration Service 10.2 for the Enterprise IM app 3.1 Architecture: Collaboration Service Enterprise Service 10 databases Third party Installations, including Microsoft Active Directory or IBM Domino Directory, certificate authority, messaging server, and either web servers or content servers Administrator s or user s computer Enterprise Service 10 version 10.1 or later Device Service Console Controller MDS Connection Service Dispatcher Firewall Infastructure Wireless network 10 device (running 10 OS version 10.1) Collaboration Service 10.2 Components that can be installed on a seperate computer Instant messaging server Work Wi-fi network 10 device (running 10 OS version 10.1) Components that must be installed on distributed computers that have the Collaboration Service installed on it Note: The architictecture displays the components used by the Collaboration Service in a Enterprise Service 10 environment. For more information on the Enterprise Service 10 architecture, visit www.blackberry.com/go/serverdocs to read the Enterprise Service 10 Product Overview. Component Description Collaboration Service The Collaboration Service provides a connection between your organization's instant messaging server and the Enterprise IM app on 10 devices running 10 OS version 10.1. Device Service console The Device Service console, also known as the Administration Service is used to manage the Collaboration Service and the user accounts and devices that are associated with Enterprise Service 10. The Device Service console connects to the Configuration Database and to Microsoft Active Directory. V. 1.0 June 2013 Copyright 2013. All rights reserved. 5 of 13
Introducing the Collaboration Service 10.2 for the Enterprise IM app 3.1 Architecture: Collaboration Service Component Description MDS Connection Service The MDS Connection Service provides a secure connection between the 10 device and the organization's network, including connections to the organization s intranet and the Collaboration Service. The connection is used when the device is not connected to your organization's Wi-Fi network. The MDS Connection Service is also responsible for providing enterprise push functionality. Dispatcher The Dispatcher maintains an SRP connection with the Infrastructure over the Internet. The Dispatcher is responsible for compressing and encrypting and for decrypting and decompressing data that travels over the Internet to and from the devices. Controller The Controller monitors the Dispatcher, MDS Connection Service, and the Collaboration Service and restarts them if they stop responding. Configuration Database Infrastructure The Configuration Database is a relational database that contains user account information and configuration information (such as connection details) that the Collaboration Service and the Enterprise Service 10 components use. The Infrastructure validates SRP information and controls the IPPP traffic that travels outside your organization's firewall to and from your organization's devices. Microsoft Active Directory If your organization uses Microsoft Active Directory, user account information is obtained from the Microsoft Active Directory. This information is required to create user accounts. If your organization s instant messaging server is Microsoft Office Communications Server 2007 R2 or Microsoft Lync Server 2010 or 2013, the Collaboration Service validates the user's login information with Microsoft Active Directory. IBM Domino Directory If your organization uses IBM Sametime with the IBM Domino Directory, user account information is obtained from the IBM Domino Directory. The Collaboration Service validates the user's login information with the IBM Domino Directory. Work Wi-Fi Network After a 10 device is activated on the Enterprise Service 10, communication between the Collaboration Service and the 10 device can occur over your organization s Wi-Fi network when the 10 device is within a wireless coverage area and enabled for access as may be required by your organization s network security policies. V. 1.0 June 2013 Copyright 2013. All rights reserved. 6 of 13
Introducing the Collaboration Service 10.2 for the Enterprise IM app 3.1 Data flow The Collaboration Service controls the data flow between the Enterprise IM app on the 10 device and the Collaboration Service. When a user starts an instant message session using the Enterprise IM app with a supported instant messaging server, there are two communication paths that can be used. The first path uses a connection to the Infrastructure to protect the messages that are sent from 10 devices that are not connected to the organization s internal network. The second is a direct connection to the Collaboration Service using the work Wi-Fi network. V. 1.0 June 2013 Copyright 2013. All rights reserved. 7 of 13
Introducing the Collaboration Service 10.2 for the Enterprise IM app 3.1 Data flow: Starting an instant messaging session using the Enterprise IM app with IBM Sametime IBM Sametime server Enterprise Service 10 version 10.1 or later Work Wi-Fi Network Collaboration Service MDS Connection Service Dispatcher Controller Firewall Internet/ Infastructure Wireless Network 10 device (running 10 OS version 10.1) Configuration Database Components that can be installed on a seperate computer 1. A user logs in to the Enterprise IM app on a 10 device it that is running 10 OS version 10.1. 2. The 10 device compresses and encrypts the smartphone user ID and password. 3. If the 10 device connects using the wireless network, the Enterprise IM app opens an SSL connection and sends the encrypted message through a secure channel from the 10 device through the Infrastructure to the Dispatcher over port 3101, through the MDS Connection Service, and to the Collaboration Service over port number 8181. 4. The Collaboration Service checks the Configuration Database to find out if the maximum number of available sessions has been reached. 5. The Collaboration Service signs the user in to the IBM Sametime server. The Collaboration Service starts an encrypted connection over TCP/IP using the IBM Sametime APIs, reformats the request from the proprietary protocol format into one that the IBM Sametime API supports, and sends the request. Components that must be installed on distributed computers that have the Collaboration Service installed on it By default, the Collaboration Service starts the connection over port number 1516 unless you specify a custom port number. 6. The IBM Sametime server sends the acceptance back to the Collaboration Service. 7. If the 10 device connects using the wireless network, the Collaboration Service sends the acceptance response to the 10 device through the MDS Connection Service, Dispatcher, and Infrastructure. If the 10 device connects using the work Wi-Fi network, the 10 device and the Collaboration Service use a direct connection over port number 8181. The session is created between the 10 device and the Collaboration Service and between the Collaboration Service and the IBM Sametime server. The user can start a conversation, set an availability status, and so on. V. 1.0 June 2013 Copyright 2013. All rights reserved. 8 of 13
Introducing the Collaboration Service 10.2 for the Enterprise IM app 3.1 Data flow: Starting an instant messaging session using the Enterprise IM app with Microsoft Office Communications Server or Microsoft Lync Server Enterprise Service 10 version 10.1 or later Work Wi-Fi Network Instant messaging server Microsoft Active Directory Collaboration Service MDS Connection Service Dispatcher Controller Firewall Internet/ Infastructure Wireless Network 10 device (running 10 OS version 10.1) Configuration Database 1. A user logs in to the Enterprise IM app on a 10 device that is running 10 OS version 10.1. Components that can be installed on a seperate computer 2. The 10 device compresses and encrypts the smartphone user ID and password. 3. If the 10 device connects using the wireless network, the Enterprise IM app opens an SSL connection and sends the encrypted message through a secure channel from the 10 device through the Infrastructure to the Dispatcher over port 3101, through the MDS Connection Service, and to the Collaboration Service over port number 8181. If the 10 device connects using the work Wi-Fi network, the Enterprise IM app opens an SSL connection and sends the encrypted message from the 10 device to the Collaboration Service over port number 8181. 4. The Collaboration Service checks the Configuration Database to find out if the maximum number of available sessions has been reached. 5. The Collaboration Service connects to Microsoft Active Directory to validate the user's login information. it Components that must be installed on distributed computers that have the Collaboration Service installed on it 6. The Collaboration Service connects to the instant messaging server and registers an active endpoint for the user using UCMA, over an MTLS connection over port number 5061. 7. The instant messaging server sends the registration information back to the Collaboration Service. 8. If the 10 device connects using the wireless network, the Collaboration Service sends the registration response to the 10 device using the SSL connection through the MDS Connection Service, Dispatcher, Router, and Infrastructure. If the 10 device connects using the work Wi-Fi network, the 10 device and the Collaboration Service use a direct connection over port number 8181. The session is created between the 10 device and the Collaboration Service and between the Collaboration Service and Microsoft Office Communications Server. The user can start a conversation, set an availability status, and so on. V. 1.0 June 2013 Copyright 2013. All rights reserved. 9 of 13
Introducing the Collaboration Service 10.2 for the Enterprise IM app 3.1 Getting started with the Collaboration Service There are two steps to get started with the Collaboration Service. A Enterprise Service 10 version 10.1 or later instance must be installed in your organization's environment. For information on installing and configuring Enterprise Service 10.1, visit www.blackberry.com/go/ serverdocs to read the Enterprise Service 10 - Installation Guide. Install the Collaboration Service. For information on installing and configuring the Collaboration Service, visit www.blackberry.com/go/serverdocs to read the Collaboration Service 10.2 for the Enterprise IM App 3.1 Installation and Administration Guide. V. 1.0 June 2013 Copyright 2013. All rights reserved. 10 of 13
Introducing the Collaboration Service 10.2 for the Enterprise IM app 3.1 Finding more information about the Collaboration Service You can consult the product documentation for more information. All of these materials are available at: www.blackberry.com/go/serverdocs Getting started with the Collaboration Service Collaboration Service 10.2 for the Enterprise IM app 3.1 Installation and Administration Guide Collaboration Service 10.2 for the Enterprise IM app 3.1 Release Notes Collaboration Service preinstallation tasks job aid Collaboration Service 10.2 for the Enterprise IM app 3.1 preinstallation checklist job aid Introducing the Collaboration Service 10.2 for the Enterprise IM app 3.1 job aid For more information about troubleshooting and support, visit the Knowledge Base at www.blackberry.com/go/kbhelp. V. 1.0 June 2013 Copyright 2013. All rights reserved. 11 of 13
Introducing the Collaboration Service 10.2 for the Enterprise IM app 3.1 Glossary Acronym MTLS SSL UMCA VPN Expanded Form Mutual Transport Layer Security Secure Sockets Layer Microsoft Unified Communications Managed API virtual private network V. 1.0 June 2013 Copyright 2013. All rights reserved. 12 of 13
Introducing the Collaboration Service 10.2 for the Enterprise IM app 3.1 Legal Statement 2013 Research In Motion Limited. All rights reserved., RIM, Research In Motion, and related trademarks, names and logos are the property of Research In Motion Limited and are registered and/or used in the U.S. and countries around the world. IBM, Domino, and Sametime are trademarks of International Business Machines Corporation. Microsoft and Lync are trademarks of Microsoft Corporation. All other trademarks are the property of their respective owners. This documentation is provided "as is" and without condition, endorsement, guarantee, representation or warranty, or liability of any kind by Research In Motion Limited and its affiliated companies, all of which are expressly disclaimed to the maximum extent permitted by applicable law in your jurisdiction. V. 1.0 June 2013 Copyright 2013. All rights reserved. 13 of 13