BlackBerry Integration With IBM WebSphere Everyplace Access 4.3 Integration Note Research In Motion 2003 Research In Motion Limited. All Rights Reserved.
Contents Integration overview... 3 Related resources... 4 Business case... 4 Validation summary... 5 Integration architecture... 6 BlackBerry Wireless Handheld... 6 BlackBerry Enterprise Server... 6 WebSphere Everyplace Access... 7 BlackBerry components for WEA... 7 Installation and deployment... 7 System requirements... 7 Installation... 8 Customization and configuration... 8 Administration... 9 Developing portlets for BlackBerry... 9 Product availability... 10 Integrated product versions... 10 How to obtain integration software and services... 10 Technical support... 10
Integration overview This document describes the integration between IBM WebSphere Everyplace Access (WEA) version 4.3 and the BlackBerry Enterprise Server. The reader is assumed to be familiar with both products. This integration extends the WebSphere portal infrastructure to support portlet applications for BlackBerry handhelds. This integration enables the development of web portlet applications and push-based notification services for BlackBerry handhelds. A portlet is a type of servlet that runs on the WEA server and provides access to applications and static or dynamic content. Users view portlets as part of a portal page. Add-on BlackBerry components for WEA enable portlets to use the Mobile Data Service feature of the BlackBerry Enterprise Server to connect into corporate networks with the same security offered by the BlackBerry solution. Users view portlets in the BlackBerry Browser on the handheld. BlackBerry integration with WEA 2003 Research In Motion Limited www.blackberry.com Page 3 of 11
BlackBerry components for WEA provide integration in two main areas: Integration area Portlets Notification alerts Description WEA can provide access to both online and offline portlets for BlackBerry handhelds. An online portlet enables users to browse content and services when online. An offline portlet stores content in the BlackBerry Browser cache. Users can retrieve the content and save it on the handheld for later viewing, even when they are outside an area of wireless coverage. Periodically, users can update (refresh) content from the server. A custom BlackBerry adapter for Everyplace Intelligent Notification Services (INS) uses the push capabilities of the Mobile Data Service feature of the BlackBerry Enterprise Server. Alerts notify users when new content is available, based on a filter, without the user requesting it. An alert can appear either as an icon on the handheld Home screen or as a message on the handheld Messages screen. The user clicks the icon or opens the alert message to view the new content in the browser. Related resources For more information on BlackBerry solution architecture and functionality, refer to the following documents, which are available from the BlackBerry Technical Knowledge Centre at http://www.blackberry.com/knowledgecenter. Document BlackBerry Enterprise Server for Microsoft Exchange Technical White Paper BlackBerry Enterprise Server for Lotus Domino Technical White Paper BlackBerry Browser Developer Guide BlackBerry Enterprise Server Installation Guide BlackBerry Enterprise Server Administration Guide Description provides an overview of the BlackBerry solution, including integration with Microsoft Exchange provides an overview of the BlackBerry solution, including integration with Lotus Domino explains how to create browser-based applications and how to use the Mobile Data Service to create push services explains how to install and configure the BlackBerry Enterprise Server explains how to operate and maintain the BlackBerry Enterprise Server For more information on WEA, refer to the IBM WEA Info Center: http://publib.boulder.ibm.com/pvc/wea/430/en/infocenter/index.html For more information on developing portlets, refer to the Portlet Development Guide and the Portlet API documentation, available at: http://www7b.software.ibm.com/wsdd/zones/portal/. For more information on installing, configuring, and customizing the BlackBerry components for WEA, refer to the IBM WEA BlackBerry Enhancement Readme, which is installed with the BlackBerry components package. Business case BlackBerry integration with WEA enables the creation of portlet applications and push-based notifications that provide BlackBerry users with access to content and services. Communication between the BlackBerry handheld and the corporate network using WEA is subject to the same security as the BlackBerry solution. The BlackBerry Demonstration Portlets show how the BlackBerry-enabled WEA solution can enable a mobile sales force to interact productively with a customer relationship management (CRM) system. A typical example of this type of usage is as follows: In the morning, the salesperson synchronizes an offline portlet page, which contains her sales contacts and a list of the day s activities related to the opportunities that she manages. 2003 Research In Motion Limited www.blackberry.com Page 4 of 11
Throughout the day, she updates her progress on accounts through an online portlet. When these updates trigger a change in the status of an opportunity, her sales manager receives an automatic alert with an update on her progress. The BlackBerry Demonstration Portlets consists of the following components:! The online portlets enable mobile salespeople to access a customer relationship management (CRM) system. Salespeople can view and manage their contacts, keep track of sales opportunities, and view the tasks that they need to complete for each sales account.! The offline portlets enable salespeople to download their latest list of contacts and sales opportunities to their handheld. For example, each morning users can synchronize (update) information so that they have it at their fingertips throughout the day. The offline portlets also show how a server-side push application can synchronize information automatically for users, at a scheduled interval.! The alert channel uses the push notification capabilities of the integrated BlackBerry and WEA solution to notify sales managers when anyone on their sales team makes progress on a sales opportunity. An icon on the handheld Home screen provides a permanent content channel. The icon changes when new information is available. Portlets organize applications and information for mobile users in one place. Portlet content can be customized for different user groups, and users can tailor portlet pages to meet their needs. Offline portlets improve the user experience because critical information can be synchronized and stored on users handhelds. Users have quick access to the information, even if they are not in an area of wireless coverage. Notification alerts send information out to specific users, without users having to request it. Alerts increase productivity because users do not need to check for new information; they are automatically notified when information changes. Alerts also use the network more efficiently, because information is sent only when it has changed. Validation summary Validation was performed using the BlackBerry 6710 Wireless Handheld, running on the AT&T Wireless GPRS network. BlackBerry Enterprise Server version 3.6 Service Pack 1 Hotfix 1 for Microsoft Exchange and BlackBerry Enterprise Server version 2.2 Service Pack 1 Hotfix 1 for Lotus Domino were used with WEA 4.3. BlackBerry components for WEA provide integration with the Mobile Data Service feature of the BlackBerry Enterprise Server. Integration is supported on BlackBerry handhelds with software version 3.6 or later, on any network on which BlackBerry handhelds operate. 2003 Research In Motion Limited www.blackberry.com Page 5 of 11
Integration architecture The following diagram shows the key integration components. Network architecture of integrated solution The BlackBerry solution provides secure, mobile access to corporate data and applications. The BlackBerry solution combines an advanced handheld, wireless network, and back-end server software to provide seamless mobile wireless access to the enterprise. The WEA Server provides a portal infrastructure for deploying portlets that can deliver static or dynamic content from corporate databases and provide access to corporate applications, such as customer relationship management (CRM) and enterprise resource planning (ERP) systems. The following sections describe each component in more detail. BlackBerry Wireless Handheld The BlackBerry Wireless Handheld combines advanced wireless technology with integrated phone, data, and browser applications. BlackBerry handhelds run on GPRS, CDMA (1xRTT), and Nextel networks. With the BlackBerry network infrastructure, users handhelds remain continuously connected to the wireless network. The BlackBerry Browser supports standard wireless markup, including WML and HTML, with built-in support for push services and content caching to enable alert notifications and content channels. Note: The BlackBerry Browser, with the Mobile Data Service configuration, must be used for portlet integration. The WAP browser configuration cannot be used with WEA integration because the Mobile Data Service (MDS) is required to access the corporate intranet. BlackBerry Enterprise Server The BlackBerry Enterprise Server is installed behind the corporate firewall to provide secure, end-to-end connections between BlackBerry handhelds and the corporate network. All communication is Triple DES-encrypted, using an encryption key that is unique to each handheld. The Mobile Data Service feature of the BlackBerry Enterprise Server provides standard HTTP and HTTPS connectivity to corporate servers, including the WEA server. The Mobile Data Service also provides push services, so that server-side applications can initiate connections to send out new content or alerts to specific users when new data is available. 2003 Research In Motion Limited www.blackberry.com Page 6 of 11
WebSphere Everyplace Access WebSphere Everyplace Access (WEA) delivers synchronization services to extend enterprise database and Web applications to mobile employees who are working both online and offline. With these synchronization services, mobile workers can access database applications and content, even when they are not connected to the network. As part of the portal infrastructure, WEA provides the use of portlets and the portlet-programming model to extend corporate applications and content to browser-enabled mobile devices either online or offline. Portlets, the application building blocks of a portal, are the visible active component that users see on a portal page. Each portlet owns a portion of the browser or PDA screen where it displays results. Portlets can be as simple as your email or as complex as a sales forecast from a CRM application. BlackBerry components for WEA The following additional WEA components are required to enable portal technology for BlackBerry handhelds.! INS Gateway Adapter: This custom gateway adapter for Everyplace Intelligent Notification Services (INS) processes messages from the INS and forwards them to BlackBerry handhelds using the Mobile Data Service. The gateway adapter supports notification alerts using the Mobile Data Service push channel. The gateway adapter supports the INS Notification Markup Language (NML). Refer to the IBM INS documentation for more information.! BlackBerry Delivery Channel Portlet: This custom delivery channel portlet for INS enables users to configure their portlet delivery channel. End users can enter their handheld personal identification number (PIN) for receiving messages and specify filters for forwarding messages to their handheld.! Conversion Servlet: The conversion servlet converts content from the WebCache format used by WEA to the format that is required by the BlackBerry Browser. The conversion servlet processes each portlet on the user s offline page and recursively processes any referenced pages down to the user s configured depth. When this processing is complete, the pages and the graphics are pushed to the user s handheld using the Mobile Data Service.! Offline Download Portlet: This portlet prompts users to start a download of their offline pages and content. Installation and deployment This section provides a high-level overview of steps for installing and configuring the BlackBerry-enabled WEA solution. For detailed information, refer to the appropriate documentation. System requirements This section summarizes the hardware and software requirements for products that are related to this integration. The BlackBerry Enterprise Server and WEA software should be installed on separate computers. BlackBerry Enterprise Server The BlackBerry Enterprise Server requires the following hardware and software:! computer with an Intel Pentium processor or compatible (minimum 500 MHz)! 256-MB RAM! 1-GB free disk space! 10 Mbps LAN connection 2003 Research In Motion Limited www.blackberry.com Page 7 of 11
! Windows 2000 Server, Service Pack 1 or later Refer to the BlackBerry Enterprise Server Installation and Getting Started Guide for more information. WEA WEA 4.3 requires the following hardware and software:! Intel platform: Intel Pentium III processor (minimum 1 GHz) with Windows 2000 Server Service Pack 3! non-intel platform: AIX RS/6000 (minimum 450 MHz) with AIX Version 5.1 ML 3 or later! 2 GB of memory (in addition to operating system requirements)! 9 GB of free space (to install Everyplace Access components on a single machine)! additional supporting software and fix packs provided on the WEA product CDs Refer to the WEA Info Center for more information: http://www-3.ibm.com/software/pervasive/products/library/ws_everyplace_access.shtml Installation The following is an overview of the main steps that are required to set up the integrated solution as described in this document. Refer to the documentation listed under Related resources for more information. This process assumes that the BlackBerry Enterprise Server and WebSphere Everyplace Access are already installed and configured correctly. On the WEA server 1. Install additional WEA components for BlackBerry integration:! Unzip the WEABlackBerry.zip file into a new directory.! Run the installblackberry installation script.! Use the WebSphere Application Server Admin Console to perform additional setup. 2. Complete the configuration steps for Offline Portal Browsing, as explained in the WEA 4.3 documentation. 3. Configure the BlackBerry INS Gateway Adapter. Set the BES_host and BES_host_port parameters for the BlackBerry Enterprise Server in your environment. Refer to the IBM WEA BlackBerry Enhancement Readme for more information. On the BlackBerry Enterprise Server 1. Enable the Mobile Data Service. 2. Verify that IT policies are set to enable the BlackBerry Browser on users handhelds. Refer to the BlackBerry Enterprise Server Installation and Getting Started Guide and the BlackBerry Enterprise Server Administration Guide for more information. Customization and configuration 1. Configure the Conversion Servlet by editing the ConversionServlet.properties file to customize the download process for users offline portlets. 2. Configure delivery channels for WEA users by running the createblackberrypushdeliverychannel batch file. 2003 Research In Motion Limited www.blackberry.com Page 8 of 11
3. Create message rules for users. 4. Optionally implement secure HTTP (HTTPS) to provide additional data security. Administration Install the latest software updates for the BlackBerry handhelds and the BlackBerry Enterprise Server. Software updates will be made available by your service provider. For information on ongoing administration of the BlackBerry Enterprise Server, refer to the BlackBerry Enterprise Server Administration Guide. For information on ongoing administration of the WEA server, refer to the WEA Info Center documentation: http://www-3.ibm.com/software/pervasive/products/library/ws_everyplace_access.shtml. Developing portlets for BlackBerry This section provides an overview of how to start developing portlets using the BlackBerry components for WEA. 1. Learn how to create browser-based applications using the BlackBerry Browser. Refer to the BlackBerry Browser Developer Guide. This guide is available from the BlackBerry Technical Knowledge Center at http://www.blackberry.com/knowledgecenter. The BlackBerry Browser Developer Guide explains the markup languages and images that the browser supports, security, and specific design considerations for optimizing content. In addition, this guide provides information on using the Mobile Data Service feature of the BlackBerry Enterprise Server to write server-side push applications. 2. Learn how to create portlets.! Refer to the Portlet Development Guide, which you can download from: ftp://ftp.software.ibm.com/software/webserver/portal/v41portletdevelopmentguide.pdf. The Portlet Development Guide introduces portlet concepts and shows how to develop a portlet using the Portlet API. Elements of the Portlet API are described, using an example that progresses from a simple portlet with no output to a complex portlet application with more advanced features. Portlet development for the WebSphere Portal environment is also described.! Refer to this two-part article on portlet programming: http://www-106.ibm.com/developerworks/library/i-portalv4/?n-dd-8222 http://www.ibm.com/developerworks/library/i-portal2v4/?n-dd-8222 This article introduces the concept of portlet programming, shows how to construct a portlet application with the required classes and support files, and explains how to build and deploy a portlet to a working WebSphere Portal Server. You can use the example portlets presented here as building blocks for larger portlet applications. Part 2 introduces the concept of portlet-to-portlet collaboration using portlet messaging, and explains how to use messaging in your portlets.! Review the Portlet API documentation, which is available at: http://www7b.software.ibm.com/wsdd/zones/portal/portlet/4.1api/. The Portlet API documentation provides detailed reference information on the Portlet API that you use to build a portlet. 3. Learn how to create offline portlets. Refer to this article on offline portlet programming: 2003 Research In Motion Limited www.blackberry.com Page 9 of 11
http://www7b.software.ibm.com/wsdd/techjournal/0303_wanderski/wanderski.html This article introduces the concept of offline portlet programming, and shows how an online portlet that is used in a connected environment can be changed to make it suitable for offline use. The article then shows how to design and deploy offline portlet applications. 4. Review the sample code documentation for the BlackBerry Demonstration Portlets for IBM WEA v4.3. The demonstration portlets provide a reference implementation of portlets on BlackBerry. The code for the demonstration portlets is well documented to explain how the code is written. 5. Learn about using Intelligent Notification Services (INS) to create notification alerts. Refer to the Everyplace Intelligent Notification Services section of the WEA Info Center: http://publib.boulder.ibm.com/pvc/wea/430/en/infocenter/index.html This section provides an overview of the basic concepts behind INS and explains how to install, administer, develop, and use INS. 6. Learn about the specific features of the BlackBerry components for WEA. Refer to the IBM WEA RIM BlackBerry Enhancement Readme, which is installed with the BlackBerry components package for WEA 4.3. This readme explains design considerations and customization options for creating offline portlets for BlackBerry using the BlackBerry Conversion Servlet, and the extensions to the Notification Markup Language (NML) that the BlackBerry INS Gateway Adapter supports. Product availability Integrated product versions The following system configuration is supported:! WebSphere Everyplace Access version 4.3! BlackBerry Enterprise Server:! Version 3.6 Service Pack 1 Hotfix 1 for Microsoft Exchange -OR-! Version 2.2 Service Pack 1 Hotfix 1 for Lotus Domino The Mobile Data Service is a feature of the BlackBerry Enterprise Server.! BlackBerry handheld software version 3.6 How to obtain integration software and services To obtain BlackBerry handhelds and BlackBerry Enterprise Server software, contact your service provider. To obtain WEA software and BlackBerry components, contact your IBM reseller. Technical support For information on technical support for BlackBerry products, contact your service provider. For information on technical support for IBM products, contact your IBM reseller. 2003 Research In Motion Limited www.blackberry.com Page 10 of 11
Part number: WPE-00038-001 2003 Research In Motion Limited. All rights reserved. The BlackBerry and RIM families of related marks, images and symbols are the exclusive properties of Research In Motion Limited. RIM, Research In Motion, 'Always On, Always Connected', the envelope in motion symbol and the BlackBerry logo are registered with the U.S. Patent and Trademark Office and may be pending or registered in other countries. All other brands, product names, company names, trademarks and service marks are the properties of their respective owners. The handheld and/or associated software are protected by copyright, international treaties and various patents, including one or more of the following U.S. patents: 6,278,442; 6,271,605; 6,219,694; 6,075,470; 6,073,318; D,445,428; D,433,460; D,416,256. IBM, WebSphere, and Everyplace are trademarks of IBM Corporation in the United States, other countries, or both. Microsoft, Internet Explorer, Windows, Windows 2000, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. Other patents are registered or pending in various countries around the world. Please visit www.rim.com/patents.shtml for a current listing of applicable patents. RESEARCH IN MOTION LIMITED (RIM) ON BEHALF OF ITSELF AND ITS AFFILIATES MAKES NO REPRESENTATIONS ABOUT THE SUITABILITY OF THE INFORMATION OR GRAPHICS CONTAINED IN THIS ADVISORY FOR ANY PURPOSE. THE CONTENT CONTAINED IN THIS DOCUMENT, INCLUDING RELATED GRAPHICS, ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. RIM HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS WITH REGARD TO THIS INFORMATION, INCLUDING ALL IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL RIM BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF INFORMATION CONTAINED HEREIN. THIS DOCUMENT, INCLUDING ANY GRAPHICS CONTAINED WITHIN THE DOCUMENT, MAY CONTAIN TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. UPDATES ARE PERIODICALLY MADE TO THE INFORMATION HEREIN AND RIM MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED HEREIN AT ANY TIME. 2003 Research In Motion Limited www.blackberry.com Page 11 of 11