Attachment Service. Installation and Getting Started Guide

Size: px

Start display at page:

Download "Attachment Service. Installation and Getting Started Guide"

Amie Townsend
5 years ago
Views:

1 Attachment Service Installation and Getting Started Guide

2 Attachment Service Installation and Getting Started Guide Last revised: 23 October 2002 Part number: PDF At the time of publication, this documentation complies with Attachment Service 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; D445,428; D433,460; D416,256. Other patents are registered or pending in various countries around the world. Visit for a current listing of applicable patents. While every effort has been made to ensure technical accuracy, information in this document is subject to change without notice and does not represent a commitment on the part of Research In Motion Limited, or any of its subsidiaries, affiliates, agents, licensors, or resellers. There are no warranties, express or implied, with respect to the content of this document. Research In Motion Limited 295 Phillip Street Waterloo, ON N2L 3W8 Canada Research In Motion UK Limited Centrum House, 36 Station Road Egham, Surrey TW20 9LF United Kingdom Published in Canada

3 About this guide This Attachment Service Installation and Getting Started Guide explains how to install, update, modify, and remove the Attachment Service, and describes error messages that you might encounter when you use the Attachment Service. Audience This guide is intended for system administrators who are responsible for installing and upgrading a BlackBerry Enterprise Server. Related resources After you install the software, all additional documentation is located in the Docs directory, with the installed software. Refer to the BlackBerry Enterprise Server for Microsoft Exchange 2000 Installation and Getting Started Guide or the Microsoft Exchange 3.5 Installation and Getting Started Guide for more information about installing the BlackBerry Enterprise Server Software. You can also refer to the documentation for procedures, tips, and troubleshooting that is available at Installation documentation Title Attachment Service Installation and Getting Started Guide Location on installation CD Root_directory:\AttachService\Docs\Attachment Service for Microsoft Exchange.pdf

4 About this guide In your software package Your Attachment Service Software package should contain the following items: Component BBAttachEngine.dll BBAttachServer.exe BBConvert.exe BBDocSubmit.dll BBAttachBESExtension.dll BBDM_Excel.dll BBDM_pdf.dll BBDM_PowerPoint.dll BBDM_Text.dll BBDM_Word2000.dll BBDM_Wordperfect.dll BBSM_UCS.dll Description This utility parses the files and constructs binary XML structure. This program runs as a Windows Service and monitors conversion processes. This process calls BBAttachEngine.dll to convert the attachments to the required format. This utility submits attachments and communicates with BBAttachServer.dll. This utility processes messages with attachments and calls BBDocSubmit.dll. This utility supports Microsoft Excel format. This utility supports Adobe.pdf format. This utility supports Microsoft PowerPoint format. This utility supports ASCII text format. This utility supports Microsoft Word format. This utility supports Corel WordPerfect format. This utility supports Universal Content Stream format. 4 Attachment Service

5 Contents About this guide... 3 Audience...3 Related resources...3 In your software package...4 CHAPTER 1 About the software... 7 About the Attachment Service...8 About the BlackBerry Enterprise Server Software...8 Handheld compatibility...9 CHAPTER 2 Installing the Attachment Service Installation Requirements...12 System requirements...12 Firewall configuration...13 To install the Attachment Service...14 CHAPTER 3 Managing the Attachment Service...17 To update or repair the Attachment Service...18 To modify the Attachment Service...20 CHAPTER 4 Removing the Attachment Service...27 To remove the Attachment Service...28 CHAPTER 5 Troubleshooting...31 Error messages...32 Index Installation and Getting Started Guide 5

6 6 Attachment Service

7 Chapter 1 About the software This section provides information on the following topics: About the Attachment Service About the BlackBerry Enterprise Server Software Handheld compatibility

8 About the software About the Attachment Service When you install the Attachment Service, the BlackBerry Enterprise Server can deliver attachment content to any BlackBerry handheld. The Triple-DES encryption of the BlackBerry Enterprise Server applies to the attachment content. Using the Attachment Service application, you can open attachments with the following file name extensions:.doc,.xls,.ppt,.pdf,.wpd, and.txt. The file formats are converted to the Universal Content Stream (UCS), a Research In Motion Limited (RIM ) proprietary format, by the Attachment Service and are delivered as attachments to the handheld. Content is generated by the Attachment Service and received by the handheld based on requests by the handheld user for a Table of Contents or Full Content. About the BlackBerry Enterprise Server Software BlackBerry is a wireless solution that includes desktop tools, server software, affordable airtime and a choice of advanced wireless handhelds. The BlackBerry Enterprise Server provides administrators with centralized management and control of the BlackBerry solution in an organization. The server software performs the following functions for each user: monitors the user s mailbox for new mail applies filters (defined by the user or the administrator) to new messages, to determine whether and how messages are sent to the user s handheld compresses and encrypts new messages and delivers them to the handheld over the Internet receives, over the Internet, messages that are composed on the handheld, and then decrypts and decompresses the messages and places them in the user s Outbox for the corporate Microsoft Exchange Server to deliver The BlackBerry Enterprise Server runs as a Windows NT /2000 service that can monitor many users at once over a single administrative connection to the Microsoft Exchange Server. The BlackBerry Enterprise Server maintains a direct TCP/IP connection (Server Relay Protocol or SRP) to the wireless network. This mode of connection requires that you configure your corporate firewall to enable the BlackBerry Enterprise Server to connect through port This is not a hole in the firewall; only an outbound connection is required. 8 Attachment Service

9 About the software Handheld compatibility To support the Attachment Service feature, you must use the BlackBerry Desktop Software version 2.1 or later and BlackBerry Handheld Software version 2.1 or later in conjunction with BlackBerry Enterprise Server version 3.5 or later. The Attachment Service can be installed after the installation of version 2.1 or 2.5 of the handheld software for the RIM 850 Wireless Handheld, RIM 857 Wireless Handheld, RIM 950 Wireless Handheld, and RIM 957 Wireless Handheld. Installation and Getting Started Guide 9

10 About the software 10 Attachment Service

11 Chapter 2 Installing the Attachment Service This section provides information on the following topics: Installation Requirements To install the Attachment Service

12 Chapter 2: Installing the Attachment Service Installation Requirements Warning: The Attachment Service must be installed on the same computer as the BlackBerry Enterprise Server. System requirements The Attachment Service Software requires the following hardware and software components: Hardware Computer with an Intel Pentium 3 or compatible processor (500 MHz or higher, 256-MB RAM, 1-GB hard disk drive) Software Windows 2000 Server Service Pack 1 or later or Windows NT 4.0 Service Pack 6 or later Microsoft Exchange 2000 Service Pack 2 or later mail server environment (recommended installation on a separate computer from the BlackBerry Enterprise Server service) or Microsoft Exchange 5.5 Service Pack 4 mail server environment BlackBerry Enterprise Server (version 3.5 or later) for Microsoft Exchange Note: Using the Attachment Service with the BlackBerry Enterprise Server version 3.5 causes the contents of the Sent Items folder to increase in size when the user initiates attachment requests. The error has been corrected in the BlackBerry Enterprise Server version 3.5 Service Pack 1. Therefore, the minimum system requirement for the Attachment Service is the BlackBerry Enterprise Server version 3.5; however, it is recommended that you use the BlackBerry Enterprise Server version 3.5 Service Pack Attachment Service

13 Installation Requirements Firewall configuration The BlackBerry Enterprise Server initiates outbound, two-way connections to the wireless network. To support BlackBerry in a firewall environment, you must configure the firewall to enable the computers that are running the BlackBerry Enterprise Server within the company to initiate TCP/IP connections to an outside server that is listening on port If you use a proxying firewall, the proxy must be transparent. Note: A transparent proxy does NOT modify requests or responses through the proxy during proxy authentication and identification. A non-transparent proxy (for which the client specifies the host name and port number of the proxy) does modify requests or responses through the proxy. If you have a non-transparent proxy, the BlackBerry Enterprise Server can be configured to access an internal proxy address which is then translated externally to the SRP Host on port Verify that your firewall is configured to accommodate the BlackBerry Enterprise Server outboundinitiated, two-way connections. Note: Your corporate firewall must be able to resolve Internet addresses using the Domain Name System (DNS). The Attachment Service directly communicates with the BlackBerry Enterprise Server over TCP/IP. No inbound or outbound connections are required through the firewall. Port 1900 and 1999 must be available for the Attachment Service to communicate with the BlackBerry Enterprise Server, or any valid TCP/IP ports can be used for this purpose. Port 1900 is used for submitting the documents and receiving the converted content. Port 1999 is used for administrating and monitoring purposes. Installation and Getting Started Guide 13

14 Chapter 2: Installing the Attachment Service To install the Attachment Service 1. Run the setup program to start the Attachment Service Setup. The setup program runs a new installation. The Welcome screen appears. Welcome screen 2. Click Next. The Select BlackBerry Enterprise Servers screen appears. Select BlackBerry Enterprise Servers screen Warning: The Attachment Service must be installed for each BlackBerry Enterprise Server individually. The BlackBerry Enterprise Servers that are not selected during this step will not support the Attachment Service. 3. Select the BlackBerry Enterprise Servers to which you want to add the Attachment Service. To select or deselect a sever, highlight its name. 14 Attachment Service

15 To install the Attachment Service 4. Click Select/Deselect. Select BlackBerry Enterprise Servers screen 5. Click Next. The Begin Installation screen appears. Begin Installation screen Installation and Getting Started Guide 15

16 Chapter 2: Installing the Attachment Service 6. Click Install. The Installing the Attachment Service screen appears. Installing the Attachment Service screen When the installation is complete, the Setup Completed screen appears. Setup Completed screen 7. Select the check boxes if you want to view the Readme file and start the Attachment Service. 8. Click Finish. The setup program closes. Warning: You must restart the BlackBerry Enterprise Server to enable the Attachment Service. 16 Attachment Service

17 Chapter 3 Managing the Attachment Service This section provides information on the following topics: To update or repair the Attachment Service To modify the Attachment Service

Chapter 3: Managing the Attachment Service To update or repair the Attachment Service 1. Run the setup program to start the Attachment Service Setup.

18 Chapter 3: Managing the Attachment Service To update or repair the Attachment Service 1. Run the setup program to start the Attachment Service Setup. The Welcome screen appears. Welcome screen 2. Click Next. The Program Maintenance screen appears. 3. Select Update or Repair. Program Maintenance screen 18 Attachment Service

19 To update or repair the Attachment Service 4. Click Next. The Begin Repair screen appears. Begin Repair screen 5. Click Install. The Installing the Attachment Service screen appears. Installing the Attachment Service screen Installation and Getting Started Guide 19

20 Chapter 3: Managing the Attachment Service When the installation is complete, the Setup Completed screen appears. 6. Click Finish. The setup program closes. Setup Completed screen Warning: You must restart the BlackBerry Enterprise Server to enable the changes to the Attachment Service. To modify the Attachment Service 1. Run the setup program to start the Attachment Service Setup. The Welcome screen appears. Welcome screen 20 Attachment Service

To modify the Attachment Service 2. Click Next. The Program Maintenance screen appears. 3. Select Modify. Program Maintenance screen 4. Click Next. The Select BlackBerry Enterprise Servers screen appears.

21 To modify the Attachment Service 2. Click Next. The Program Maintenance screen appears. 3. Select Modify. Program Maintenance screen 4. Click Next. The Select BlackBerry Enterprise Servers screen appears. Select BlackBerry Enterprise Servers screen 5. To add the Attachment Service, select the BlackBerry Enterprise Servers for which you want to enable the Attachment Service. To select a server, highlight its name. Installation and Getting Started Guide 21

Chapter 3: Managing the Attachment Service 6. Click Select/Deselect. A green check mark appears beside the name of the BlackBerry Enterprise Server.

22 Chapter 3: Managing the Attachment Service 6. Click Select/Deselect. A green check mark appears beside the name of the BlackBerry Enterprise Server. To remove the Attachment Service, proceed to step 10. Select BlackBerry Enterprise Servers screen 7. Click Next. The Begin Installation screen appears. Begin Installation screen 22 Attachment Service

23 To modify the Attachment Service 8. Click Install. The Installing the Attachment Service screen appears. Installing the Attachment Service screen When the installation is complete, the Setup Completed screen appears. 9. Click Finish. The setup program closes. Setup Completed Warning: You must restart the BlackBerry Enterprise Server to enable the changes to the Attachment Service. 10. To remove the Attachment Service, deselect the BlackBerry Enterprise Servers for which you want to disable the Attachment Service. To deselect a server, highlight its name. Installation and Getting Started Guide 23

24 Chapter 3: Managing the Attachment Service 11. Click Select/Deselect. A red cross appears beside the name of the BlackBerry Enterprise Server. Select BlackBerry Enterprise Servers screen 12. Click Next. The Begin Uninstall screen appears. Begin Uninstall screen 24 Attachment Service

25 To modify the Attachment Service 13. Click Remove. The Uninstalling the Attachment Service screen appears. Uninstalling the Attachment Service screen When the removal is complete, the Setup Completed screen appears. 14. Click Finish. The setup program closes. Setup Completed screen Warning: You must restart the BlackBerry Enterprise Server to enable the changes to the Attachment Service. Installation and Getting Started Guide 25

26 Chapter 3: Managing the Attachment Service 26 Attachment Service

27 Chapter 4 Removing the Attachment Service This section provides information on the following topic: To remove the Attachment Service

28 Chapter 4: Removing the Attachment Service To remove the Attachment Service 1. Run the setup program to start the Attachment Service Setup. The Welcome screen appears. Welcome screen 2. Click Next. The Program Maintenance screen appears. 3. Select Remove. Program Maintenance Screen 28 Attachment Service

29 To remove the Attachment Service 4. Click Next. The Begin Uninstall screen appears. Begin Uninstall screen 5. Click Remove. The Uninstalling the Attachment Service screen appears. Uninstalling the Attachment Service screen Installation and Getting Started Guide 29

30 Chapter 4: Removing the Attachment Service When the removal is complete, the Setup Completed screen appears. 6. Click Finish. The setup program closes. Setup Completed screen Warning: You must restart the BlackBerry Enterprise Server to enable the changes to the Attachment Service. 30 Attachment Service

31 Chapter 5 Troubleshooting This section provides information on the following topic: Error messages

32 Chapter 5: Troubleshooting Error messages The following error messages appear in the BlackBerry Enterprise Server log when the Attachment Service fails to retrieve attachments. Error message Problem Solution An unknown error was encountered. Could not find the file with the specified name. Unrecognized document format. Password not supported for this format. Password protected document. Password for this document is incorrect. The Attachment Service is not working properly. The Attachment Service could not retrieve the attachment from Microsoft Exchange. The attachment type or document version is currently not supported by the Attachment Service. The attachment is protected by a password and decryption is presently not supported for the format. A password is required to parse the attachment. The password that was typed is incorrect. Verify that the Attachment Service is properly installed and started. Use the Password feature to enter a password for successful conversion. Retype the password and resubmit the file to view it. The file is a recognized file format, but its data is corrupted or invalid. Document conversion fail. The file format is supported by the Attachment Service, but the file is corrupt. The Attachment Service encountered a problem during the conversion of the file that might be due to invalid data. Open the document in the original application to verify that the file is valid. 32 Attachment Service

33 Chapter 5: Troubleshooting Error message Problem Solution The submitted file has an invalid filename including either '`' or '&' that will not be accepted by the Microsoft XML parser. The attachment has an invalid file name and will not be parsed. Rename the attachment to exclude the ` or & characters to obtain a successful conversion. Table of Contents not available. Attachment Service not running or invalid configuration. The Attachment Service is unable to create a Table of Contents from the attachment. The document might be small or does not contain any information upon which to create a summary. The Attachment Service is not running or has an invalid configuration. View the full content of the attachment. Verify that the Attachment Service is started and properly installed. 33 Attachment Service

34 Chapter 5: Troubleshooting 34 Attachment Service

35 Index Index A about the Attachment Service, 8 the BlackBerry Enterprise Server Software, 8 the software, 7 this guide, 3 attachment formats, 8 audience, 3 B BlackBerry Enterprise Server Attachment Service about, 8 installing, 11 removing, 27 updating or repairing, 18 E error messages, 32 H handheld compatibility, 9 hardware, 12 I in your software package, 4 installation documentation, 3 installation requirements firewall configuration, 13 system requirements, 12 installing the BlackBerry Enterprise Server Attachment Service, 11 R related resources, 3 removing the BlackBerry Enterprise Server Attachment Service, 27 S software, 12 system requirements hardware, 12 software, 12 T the BlackBerry Enterprise Server functions, 8 troubleshooting error messages, 32 U updating the BlackBerry Enterprise Server Attachment Service, 18 Installation and Getting Started Guide 35

36 Index 36 Attachment Service

37 2002 Research In Motion Limited Published in Canada

Attachment Service. Installation and Getting Started Guide

Attachment Service. Installation and Getting Started Guide Attachment Service Installation and Getting Started Guide Attachment Service Installation and Getting Started Guide Last revised: 23 October 2002 Part number: PDF-05356-001 At the time of publication,