blackberry enterprise server for lotus · pdf fileblackberry enterprise server software for...

Installation & GettingStarted Guide

BlackBerry EnterpriseServer for LotusDomino

Version 2.0

BlackBerryTM Enterprise Server Software Installation & User’s Guide.Last revised 01/02/01Part Number: MAT-03196-001

At time of printing, documentation complies with software version: 2.0.© 1997-2001, Research In Motion Limited. All rights reserved.

RIM, Research In Motion, the RIM logo, BlackBerry, RIM 950 WirelessHandheld, RIM 957 Wireless Handheld, the BlackBerry logo, the“envelope in motion” symbol and “Always On, Always Connected” aretrademarks of Research In Motion Limited. RIM and Research InMotion are registered with the U.S. Patent and Trademark Office.

Notes and Domino are trademarks of Lotus Development Corporation.All other brands, product names, company names, trademarks andservice marks are the property of their respective owners.

While every effort has been made to ensure technical accuracy,information in this document is subject to change without notice anddoes not represent a commitment of the part of Research In MotionLimited.

Warning: This document is for the use of licensed users only. Anyunauthorized copying, distribution or disclosure of information is aviolation of copyright laws.For more information on BlackBerry, contact: 1-877-BLK-BERRYResearch In Motion Limited295 Phillip StreetWaterloo, OntarioCanada N2L 3W8Tel. (519) 888-7465Fax (519) 888-6906Web site: www.rim.netEmail: [email protected] In Canadaswdocs_bes_notes_guide_v2_0

ContentsOverview ...........................................................................................5

About BlackBerry and the BlackBerry Enterprise Server....5About this guide........................................................................7In your package.........................................................................7

Setup and installation .....................................................................9Pre-Installation checklist ..........................................................9Firewall configuration............................................................11Important setup overview .....................................................12Logging in to the Administrator account ............................12Installing the server ................................................................13Creating the BlackBerryAdmins group ...............................24Adding administrators to the BlackBerryAdmins group .27Starting the server add-in task ..............................................28Resolving Connection Errors ................................................28Uninstalling the software.......................................................30

Administration tasks .....................................................................33Opening the BESAdmin window .........................................33Connecting a handheld to the cradle ...................................35Adding users ...........................................................................37Enabling and disabling a handheld .....................................40Purging pending messages....................................................42Generating encryption keys ..................................................43Monitoring email statistics ....................................................44Reading the status fields ........................................................45Sending a message to one user .............................................46Changing a user’s handheld..................................................47Viewing global statistics ........................................................48

Server-level administration .........................................................53Adding handheld licenses .....................................................53Sending an All Points Bulletin ..............................................54

BESMonitor and BESAlert ...........................................................57

Checking server status ...........................................................57Configuring BESAlert.............................................................59

Frequently asked questions .........................................................63

BlackBerry Enterprise Server Software License Agreement .67

Index .................................................................................................71

1OverviewBlackBerry™ is a mobile email solution that consists of theBlackBerry handheld, docking cradle, BlackBerry Desktop Software,and flat-rate airtime on a nationwide wireless network.

About BlackBerry and theBlackBerry Enterprise ServerThe BlackBerry Enterprise Server performs email redirection for allBlackBerry users in an organization. It performs the followingfunctions for each user:

• Monitors the user’s inbox for new mail

• Applies filters (defined by the user) to new messages, todetermine if and how the BlackBerry service will relay themessage to the user’s BlackBerry handheld

• Compresses and encrypts new messages and delivers them tothe BlackBerry handheld over the Internet

• Receives, over the Internet, messages composed on theBlackBerry handheld, then decrypts and decompresses themessages for the corporate Domino server to deliver

BlackBerry Enterprise Server Software for Lotus Domino

Overview — About BlackBerry and the BlackBerry Enterprise Server6

The BlackBerry Enterprise Server runs as a Domino Server task thatcan monitor many users at once over a single administrativeconnection to the Domino server. The BlackBerry Enterprise Servermaintains a direct TCP/IP connection (Server Routing Protocol orSRP) to the wireless network. This mode of connection requires thatyou configure your corporate firewall to allow the BlackBerryEnterprise Server to connect through port 3101. This is not a “hole”in the firewall, since only an outbound-initiated connection isrequired.

Figure 1 shows an example of events that occur when an externalemail message is sent to a user on the BlackBerry Enterprise Server.

Figure 1: Sample email path with BlackBerry Enterprise Server

Overview — About this guide

Installation and Getting Started Guide

7

About this guideThis BlackBerry Enterprise Server Software Installation and GettingStarted Guide will help you set up your system for installation, installthe server software, and get started with the server administrationtools.

Please consult the BlackBerry Enterprise Server Online Help (installedwith your software) for procedures, tips, and troubleshooting. Toopen the online guide, click the Help button in any of the BlackBerryEnterprise Server windows.

In your packageYour BlackBerry Enterprise Server package should contain thefollowing:

• BlackBerry Enterprise Server Software CD

• This BlackBerry Enterprise Server Software Installation & GettingStarted Guide

• SRP Authentication label (located on the CD jewel case)

If any of these components are missing, please contact technicalsupport at 1-887-255-2377 (U.S./Canada).

2Setup and installationThe BlackBerry Enterprise Server for Lotus Domino requires thehardware and software components listed on the next few pages.

Pre-Installation checklistUse this checklist to track the specific information required whenyou install the BlackBerry Enterprise Server. Keep this informationfor future reference. The information you enter will be required ifyou need to contact our support department.

Hardware - minimum requirements

PC with an Intel Pentium II processor or compatible (233 MHzor higher).

128 MB RAM.

1 GB free disk space

10 Mbps LAN connection


Setup and installation — Pre-Installation checklist10

BlackBerry Enterprise Server SoftwareThis document assumes that your BlackBerry Enterprise Server forLotus Domino will be in the same Notes domain as the mail server.

Windows NT® 4.0 server, Service Pack 3 or higherversion and SP installed _________________________________

Domino Server® and Client 4.6 or higherversion installed ________________________________________

Ensure the Domino server is in the LocalDomainServers group

InformationYou will be asked for the SRP ID and Authentication Key. You canfind this information on the installation label on your BlackBerryEnterprise Server for Lotus Domino CD.___________________________________________________________

TCP/IP Hostname name of BlackBerry Enterprise Server:___________________________________________________________

Platform your mail servers run on:___________________________________________________________

Lotus Notes Organization Name:___________________________________________________________

System Attendant (Administrator name used for sending emailalerts in a valid SMTP address format):___________________________________________________________

Setup and installation — Firewall configuration


11

Firewall configurationThe BlackBerry Enterprise Server initiates connections to thewireless network in an outbound direction. To support BlackBerryin an environment with a firewall in place, the firewall must beconfigured to allow the computers running BlackBerry EnterpriseServer within the company to initiate TCP/IP connections to anoutside server listening on port 3101. If the firewall is a proxyingfirewall, the proxy must be transparent. Please ensure that yourfirewall is configured to accommodate these types of connections.

BlackBerry Enterprise Server Installation Folder Location:

default or __________________________________

SRP Host:

srp.blackberry.net or _____________________________

SRP Identifier: S _______________________________________

SRP Authentication Key: ________________________________

Domino Data Directory location:(for example, C:\Lotus\Domino\Data)

______________________________________________________

Name of the Name and Address Book (Domino Directory):_______________________________________________________

Note Your corporate firewall must be able to resolve Internetaddresses using DNS.


Setup and installation — Important setup overview12

Important setup overviewTo ensure successful installation and setup of the BlackBerryEnterprise Server, please follow this setup order. (Detailedprocedures follow for each step in the overview.)

• Log in to an Administrator account on the Domino Serverwhere the BlackBerry Enterprise Server will run.

• Install the Blackberry Enterprise Server software on theDomino Server that acts as the gateway to the wirelessnetwork.

• Create the BlackBerryAdmins account and add administratorsto it.

• Start the BlackBerry Enterprise Server add-in task.

Logging in to the Administratoraccount1. On the server where the BlackBerry Enterprise Server will run,

log in to the account you usually use for Administrator-leveltasks. This account will be used throughout the installation. Forsimplicity, we will refer to this account as your “Administratoraccount”.

The BlackBerryAdmins group will not be created when youinstall the BlackBerry Enterprise Server; you will need to createa BlackBerryAdmins group in the Name and Address Book(Domino Directory) and configure this group withadministrator privileges before adding administrators to thegroup. See page 24 for instructions.

Note You must have NT Administrator privileges as well asDomino Administrator privileges to log in.

Setup and installation — Installing the server


13

Installing the serverFollow these steps to install the BlackBerry Enterprise Server.

1. Insert the BlackBerry Enterprise Server CD into the CD drive ofthe computer that will run the BlackBerry Enterprise Server.

2. Double-click the Installer folder to open it. Double-clickBlackBerry Enterprise Server for Lotus Domino to startinstallation. A Welcome screen appears.

Note For instructions on uninstalling, see “Uninstalling thesoftware” on page 30.


Setup and installation — Installing the server14

3. Click Next. The License Agreement window appears.



15

4. Please read the license agreement carefully; proceeding withthe installation indicates that you accept its conditions. ClickYes to continue. The Setup Type window appears.



5. To install the BlackBerry Enterprise Server, select BlackBerryServer and Utilities. If you are installing a BlackBerryEnterprise Server Administration Console, select BlackBerryUtilities Only. Click Next to continue. The first BlackBerryServer screen appears.

Note If you want to manage the BlackBerry Enterprise Serverfrom another machine, install the Utilities on that machineas well as on this machine.



17

6. In the BlackBerry Server screen, enter the following values:

• In the System Attendant field, type the email address ofthe System Administrator. Use a valid email address thatcan send and receive Alert or Warning messages. ClickNext to continue. A second BlackBerry Server windowappears.

7. A second BlackBerry Server window contains polling and SRPinformation. Default values are shown in the fields.

• In the Polling Interval field, type the number of seconds towait between mailbox lookups. This value determines howoften the BlackBerry Enterprise Server will scan each user’smailbox for new mail. The lower the value, the more oftenscanning will occur. A very low value will place an addedload on system resources. The default value is 20 seconds.



• The SRP Port, configured during the Firewallconfiguration process, is set to 3101, and is typically notchanged. This is an outbound-initiated connection.

• The SRP Host connects to the wireless network. In the SRPHost field, type srp.blackberry.net. In typical systemsetups, this value should not change. The BlackBerryEnterprise Server can sit anywhere on the LAN and routeits TCP/IP traffic through the firewall or through atransparent proxy server. Click Next to continue.

Note If you have a non-transparent proxy, the BlackBerryEnterprise Server can be configured to access an internalproxy address which is then translated externally tosrp.blackberry.net on port 3101.



19

8. During your initial installation, ensure that the Check SRPconnection box is checked. The setup program will perform atest to ensure that the server can connect to srp.blackberry.net.

If the test is successful, messages will confirm your connection.From the DOS prompt, press Enter to continue. Click OK toclose the message and continue the installation.

If the test is not successful, you will see an error message. Notethe error code, and press Enter. Click OK in the dialog box toclose the error message.

Note If the SRP test is not successful, you will have to stop theinstallation and correct the reason for the failure before youcan restart the installation. See page 28 for a list of commonerrors and suggestions for their resolution.



9. In this window, enter the SRP ID and Authentication Keyobtained from the installation label on the CD. This key isunique to each host license. Each BlackBerry Enterprise Serverrequires its own unique SRP ID and Authentication Key. ClickNext. The Choose Destination Location window appears.

Tip The authentication key is very long. To simplify installations,upgrades, and reinstalls, create a .txt file containing yourauthentication key. You can use this .txt file to copy the keyand paste it into the Authentication Key field. Keep this filein a secure directory.



21

10. In the Choose Destination Location window, ensure that thedestination path is correct and click Next.

Note The default path for the BlackBerry Enterprise Server isC:\Program Files\Research In Motion\BlackBerry EnterpriseServer\



11. In the Select Program Folder window, ensure the correct folderis selected and click Next to complete the installation.



23

12. When the installation is complete, you will see a confirmationwindow. Click Finish to close the window.


Setup and installation — Creating the BlackBerryAdmins group24

Creating the BlackBerryAdminsgroup1. From the Domino Administrator, click the appropriate server

icon.

2. Select the People & Groups tab, then Domino Directories.Select the appropriate Address Book, then select the Groupsview.

3. In the Groups menu list, click Create to add the group.

Setup and installation — Creating the BlackBerryAdmins group


25

4. Select the Basics tab.

• In the Group name field, type:BlackBerryAdmins

• In the Group type field, type or select Multi-purpose.

• In the Description field, type a description that will appearin the view. For instance, you could type the description:Users who can add, remove and modify BlackBerry usersettings.

• In the Members field, type the name of the users who willbe administering the BlackBerry Enterprise Server. Forexample, select or type Admin, or SQA.

Note This field is case-sensitive; type the name exactly as shownabove.


Setup and installation — Creating the BlackBerryAdmins group26

5. Select the Administration tab.

• In the Owners field, type the names of the users who areallowed to change the group membership.

• In the Administrators field, type the users who areallowed to edit the Group document.

• In the Foreign directory sync allowed field, select Yes toenable the group to be copied to foreign directories duringsynchronization.

6. Select Save and Close. The BlackBerryAdmins Group willappear in the Name and Address Book (Domino Directory) onthe local Domino Server.

Setup and installation — Adding administrators to the BlackBerryAdmins


27

Adding administrators to theBlackBerryAdmins groupAfter you installed the BlackBerry Enterprise Server, you created aspecial Group called the BlackBerryAdmins Group and added it tothe Name and Address Book (Domino Directory) on the localDomino Server. This Group is used to control access to theBlackBerry user accounts and inbound and outbound queuedatabases. The BlackBerryAdmins Group administrators can accessonly those databases needed to run and administer the BlackBerryEnterprise Server software.

To add more administrators1. From the Notes Client on the BlackBerry Enterprise Server,

open the Name and Address Book (Domino Directory).

2. Select the Groups view, then select BlackBerryAdmins.

3. Click Edit Group, and then add the users that will beAdministrators for the BlackBerry Enterprise Server.

4. Add the LocalDomainServer group. Ensure that the Dominoserver that has the BES add-in task is already in theLocalDomainServer’s group.


Setup and installation — Starting the server add-in task28

Starting the server add-in taskOnce the server has been created, and the BlackBerryAdmins groupadded, start the BlackBerry Enterprise Server.

In the Lotus Server Console on the BlackBerry Enterprise Servermachine, type load BES or restart the Domino server.Since the BlackBerry Enterprise Server is an add-in task to theDomino Server, the Notes.ini file has been modified to include astartup task called BES. This service supplies email redirection.

Resolving Connection ErrorsUse the suggestions below to resolve connection errors if the srptestportion of your installation fails.

Error code 10060Error code 10060 generates these messages:

“C:\>bbsrptest srp.blackberry.net”“Attempting to connect to srp.blackberry.net (206.51.26.33), port3101”“connect() failed: error code = 10060”

Error code 10060 indicates that the connect request is not beinganswered, or that the firewall has lost the connection request. Error10060 is a timeout error.

If your firewall has been configured to proxy connections on port3101 to srp.blackberry.net, try using the proxy to connect. To do thisyou must know the internal IP address of the firewall or the proxyserver through which you are trying to send the request. Forexample, if the IP address of the firewall/proxy server is 192.168.0.1,you would type:bbsrptest 192.168.0.1

Setup and installation — Resolving Connection Errors


29

The program will try to connect to srp.blackberry.net. You shouldsee the following response:“Attempting to connect to 192.168.0.1 (192.168.0.1), port 3101”“Sending test packet”“Waiting for response”“Receiving response”“Checking response”“Successful”

Once you receive the “Successful” message, you are ready to beginyour installation.

Error code 10061Error code 10061 generates this message: “connect() failed: errorcode = 10061”

Error code 10061 indicates that the connection was refused. Eitherthe SRP server is not running, or more likely, the firewall preventedthe connection from being completed.

To resolve this error, check with your firewall administrator toensure that an outbound connection from the machine you areusing to srp.blackberry.net on port 3101 is allowed.

Connection lostThe “connection lost” error generates this message: “recv():connection lost.”

This message indicates that the connection was broken by thefirewall or proxy before the test program could connect with theSRP server.

To resolve this error, check with your firewall administrator toensure that an outbound connection from the machine you areusing to srp.blackberry.net on port 3101 is allowed.


Setup and installation — Uninstalling the software30

Error code 11001Error code 11001 generates this message: “Connect () failed: errorcode = 11001.”

Error code 11001 indicates that the DNS cannot locate thesrp.blackberry.net address.

To resolve this error, ensure that your DNS settings are correct onthe machine you are using, then open the Command prompt andtype:ping srp.blackberry.net.

You should receive an IP resolution on the name. If you do not, yourDNS settings must be corrected. (The ping will not be returned. Thisis normal.)

Uninstalling the softwareTo uninstall the BlackBerry Enterprise Server, follow these steps.

1. From the Lotus Domino Server console screen, type:tell BES Quit

2. Uninstall the Blackberry Enterprise Server by selecting Start>Settings> Control Panel> Add/Remove Programs. An Add/Remove window appears.

Setup and installation — Uninstalling the software


31

3. In the Add/Remove Programs Properties window, selectBlackBerry Enterprise Server for Lotus Domino and clickAdd/Remove. A Confirm File Deletion dialog appears.

4. Click OK to remove the BlackBerry Enterprise Server software.


Setup and installation — Uninstalling the software32

5. A confirmation window will appear when all programs havebeen successfully removed.

Note Uninstalling the application does not remove the userconfiguration and message queue databases. If you wish toremove these as well, these items can be found in the BESfolder in the Domino Server’s data directory.

3Administration tasksYou can perform user- and handheld-oriented administrativefunctions through the BESAdmin utility. This tool was installed ifyou selected Utilities during installation.

Opening the BESAdmin windowThe install process placed a file named BESAdmin.exe in the folder\Program Files\Research In Motion\BlackBerry Enterprise Server.There are several ways to start this file: by creating and launching ashortcut, by using a quicklaunch, by using Windows explorer, or byclicking Start> Program Files> BlackBerry Enterprise Server forLotus Domino> BlackBerry Server Management. Starting this filewill establish your connection to the BlackBerry Enterprise Server(or servers, if you are using more than one).

To open the BESAdmin window1. In the BlackBerry Enterprise Server main menu, click File>

Connect. The Adding BES for Domino Server dialog boxappears.

Note If the Utilities were not selected during installation, you cango back to the installation procedure and install the utilitieswithout having to re-install the service.


Administration tasks — Opening the BESAdmin window34

2. In the dialog box, type the name of the server to which youwant to connect. Type the Hostname of the machine (forexample, SERVER1). Click OK. You will be prompted for apassword.

The BESAdmin window appears. You are now able to administerusers.

Administration tasks — Connecting a handheld to the cradle


35

Connecting a handheld to thecradleSystem administrators can use the cradle to add users, assign PINnumbers, and generate encryption keys.

Note Please ensure that you use only the cradle provided byResearch In Motion.


Administration tasks — Connecting a handheld to the cradle36

To connect the handheld1. Connect the cradle cable to the COM port on the machine

running BESAdmin.

2. In the BESAdmin window, click Tools. Click Settings to openthe Settings window.

3. The Settings window will show you the COM port being usedto connect the cradle. Click Detect. You will receive thefollowing message: “Please ensure your handheld is securelyconnected.” Click OK.

4. When the handheld is detected, you will see a message similarto “Located a handheld device attached to your computer onCOM1.” Click OK to close the message and OK again to closethe Settings window.

Secure the pager-sized handheld in the cradle byinserting the connector port on the bottom edge of thehandheld into the connector prongs of the cradle.Then click the top of the handheld into the cradle.

Secure the palm-sized handheld in the cradle byinserting the connector port on the bottom edge of thehandheld into the connector prongs of the cradle andpress firmly in place.

Note If the machine cannot detect the handheld on a COM(serial) port, the message “Unable to locate a handhelddevice attached to your computer” will appear. Check thatthe handheld and cradle cable both appear to be connectedsecurely. If the error message still appears, ensure that noother devices are sharing the serial port.

Administration tasks — Adding users


37

Removing a handheld from the cradle

Adding usersOne of the BESAdmin tool’s primary functions is to add a handheldto a BlackBerry Enterprise Server. You can add a user with orwithout a personal identification number (PIN). To add a user and aPIN at the same time, see “Adding a user and a PIN” on page 38.

To add a user1. In the BESAdmin window for the appropriate BlackBerry

Enterprise Server, click Add to Server. A list of all users in thedefault Name and Address Book (Domino Directory) willappear. (This directory contains the names of registered LotusNotes users.)

To remove the pager-sized handheld from the cradle,brace the bottom of the cradle with one hand andgently pull the top of the handheld towards you.

To remove the palm-sized handheld from thecharging cradle, brace the bottom of the cradle withone hand and gently pull the handheld up out of thecradle.

Note Users must be registered on the Lotus Domino Serverbefore they can be added to the BlackBerry EnterpriseServer. Refer to your Lotus Domino documentation fordetails on user registration.

Note For email redirection to function properly, the DominoServer that has the BES add-in task must have the Server-Manager- and Delete-permissions in the Access ControlList (ACL) of the users’ mail file.


Administration tasks — Adding users38

2. Select the name of the user to be added and click OK. You willsee a “successfully added” message. Click OK to close themessage.

Adding a user and a PINYou can attribute the handheld’s PIN to a specific user when youadd the user to the BlackBerry Enterprise Server. If you haven’talready done so, connect the cradle to a COM port at the PC,ensuring that it has been detected by the server. (For details, see“Connecting a handheld to the cradle” on page 35.)

1. In the BESAdmin window for the appropriate BlackBerryEnterprise Server, click Add to Server. A list of registered LotusNotes users appears.

Note Users must be registered on the Lotus Domino Serverbefore they can be added to the BlackBerry EnterpriseServer. Refer to your Lotus Domino documentation fordetails on user registration.

Administration tasks — Adding users


39

2. Place the user’s handheld in the cradle. The server will detectthe handheld and automatically add the PIN to the HandheldPIN field.

3. Select the name of the user to be added and click OK. A dialogbox appears asking if you would like to generate an encryptionkey for the handheld. Click Yes.

4. You will be prompted to generate an encryption key. Move themouse as requested. You will receive a “successfully added”message. Click OK to close the message. The handheld is nowready to use.

Note While the BESAdmin is running, ensure that the BlackBerryDesktop Manager is not running on the same machine.

Note If the user’s name is identified as a previous BlackBerryuser, you will not need to update the encryption key.


Administration tasks — Enabling and disabling a handheld40

Enabling and disabling a handheldThe BlackBerry Enterprise Server lets you disable or enable ahandheld without actually removing that user from the server. Youmay want to use this function if, for example, a user is traveling outof coverage for an extended period and does not want any messagesforwarded to the handheld during that time. Instead of removingthe user from the server, you can disable that particular handheldwhile the user is out of coverage and enable the handheld when theuser returns to an area with coverage.

To enable a handheld1. In the BESAdmin window, select the BlackBerry Enterprise

Server where the user is enabled.

2. Select the user. Click Enable User to activate the user’shandheld for email redirection.

3. You will be asked for confirmation. Click Yes. The Enabledcolumn for the user changes from No to Yes.

Administration tasks — Enabling and disabling a handheld


41

To disable a handheld1. In the BESAdmin window, select the BlackBerry Enterprise

Server where the user is enabled.

2. Select the user. Click Disable User to prevent email from beingforwarded to the user’s handheld.

3. You will be asked for confirmation. Click Yes. The Enabledcolumn for the user changes from Yes to No and the icon in theUser Name column changes.


Administration tasks — Purging pending messages42

To remove a userYou can remove a user from a BlackBerry Enterprise Server usingthe BESAdmin tool.

1. In the BESAdmin window, select the BlackBerry EnterpriseServer where the user is registered.

2. Select the user. Click Remove from Server to remove all of theuser’s BlackBerry information.

3. You will be asked for confirmation. Click Yes. The user isremoved from the BESAdmin window and you receive a“successfully removed” message. Click OK to close themessage.

Purging pending messagesSome situations may arise where it is necessary for you to purge anymessages that are pending to a particular handheld.

To purge all messages1. In the BESAdmin window, select the BlackBerry Enterprise

Server where the user is registered. Select the user, and clickPurge Pending.

2. You will be asked for confirmation. Click Yes. The messageswaiting to be sent to that handheld are removed from the localqueue, although they will still appear in the user’s Inbox.(Messages already waiting on the wireless network will be notbe purged.) You will receive a “cleared pending messages”notification. Click OK to close the message.

WARNING Once a user is removed, the user’s encryption key, filtersand statistics are permanently deleted.

Administration tasks — Generating encryption keys


43

Clearing in-cradle statusBy default, email will not be redirected to the handheld as long as itis in the cradle. Occasionally, an interruption in networkcommunications may prevent the BlackBerry Desktop Managerfrom clearing the in-cradle status after the handheld has beenremoved from the cradle. If this happens, messages will not beforwarded to your handheld until you clear the in-cradle status.

1. In the BESAdmin window, select the BlackBerry EnterpriseServer on which the user is registered.

2. Select the user. Click Clear In-Cradle. You will be asked toconfirm your request. Click Yes. The status in the In-Cradlecolumn changes to No for the user and email redirectionresumes.

Generating encryption keysIn the BlackBerry encryption model, only the handheld and thedesktop know the encryption key. If the user does not have theBlackBerry Desktop Software installed, you can generate a key atthe server level.

1. Insert the user’s handheld into the cradle that is connected tothe server. The status should change to Connected and thehandheld’s Personal Identification Number (PIN) will appear.

2. In the BESAdmin window, select the BlackBerry EnterpriseServer on which the user is registered. Select the user, then clickEdit/Generate.

3. The application will ask if you want to generate a newencryption key. Click Yes. The application will prompt you tomove your mouse around to generate a new encryption key forthe handheld. Move your mouse as requested.


Administration tasks — Monitoring email statistics44

Monitoring email statisticsThe BESAdmin tool reports on each user’s email flow from server tohandheld. The information in the Statistics fields lets you verify thatthe server is redirecting email properly.

To monitor statistics1. In the BESAdmin window, select the BlackBerry Enterprise

Server on which the user is registered.2. Select the user. The user’s statistics are shown at the bottom of

the window.

Administration tasks — Reading the status fields


45

Reading the status fieldsIn the BESAdmin window, each user will have a set of properties(found in the Properties window). The BlackBerry tab in thiswindow displays numbers, dates and times to indicate the stage andstatus of email for that user.

The following table explains the type of information displayed ineach field.

Field Description

MessagesForwarded

The number of messages that have beenforwarded to the handheld. This field isupdated automatically as new messages areforwarded. The messages that areforwarded depend on the filters set by eachuser at the desktop.

MessagesFiltered

The number of messages that were not sentto the handheld because of the filtersenabled in the BlackBerry DesktopManager.

MessagesReceived

The number of messages that have beenreceived by the handheld.

MessagesPending

The number of messages being held untilthe handheld is turned on or returns tocoverage. When the handheld is activeagain, the messages are sent.

Messages SentfromHandheld

The number of messages sent from thehandheld. This field is updatedautomatically as new messages are sent


Administration tasks — Sending a message to one user46

Sending a message to one userIf you wish to send an email message to any handheld user on aBlackBerry Enterprise Server, you can do so from the BESAdmintool.

1. Ensure that you are connected to the server. In the BESAdminwindow, select the BlackBerry Enterprise Server on which theuser is registered. Select the user.

2. Click Send Message to open the Send Message window.

MessagesExpired

Number of messages that have timed out onthe wireless network. This usually occursafter 7 days.

Errors Number of messages that failed to bedelivered.

Last Time inCradle

Last time the handheld was placed in thecradle.

Last MailboxScan

Date and time of the last new message in theInbox that was forwarded to the wirelessnetwork.

Last HandheldContact

The length of time that has passed since thelast message was forwarded to thehandheld.

LastForwarded

Date and time that the last message wasforwarded to the handheld

Last Expired Date and time of last expired message

Last Key Date Date and time last encryption key wasgenerated.

Administration tasks — Changing a user’s handheld


47

3. Type information into the Subject and Message fields of thewindow, and click OK. The message will be sent to therecipient’s Inbox, and proceed to that person’s handheld. Youwill receive a “successful” message. Click OK to close themessage.

Changing a user’s handheldIf the user receives a different handheld, you must register the newhandheld’s PIN for proper email redirection. If the user does nothave access to the BlackBerry Desktop Manager, you must registerthe new handheld through the BESAdmin tool.

1. From the BESAdmin window, select the BlackBerry EnterpriseServer on which the user is registered. Select the user.

2. Place the new handheld in the cradle, connected to the server.When the application detects the handheld, it will prompt youto confirm that you want to assign the new PIN to this user.Click Yes. The application will prompt you to generate a newencryption key by moving your mouse around the screen.Move your mouse as requested. You will receive a “successful”message when the new key has been generated. Click OK toclose the message.

Tip You can send an All Points Bulletin from the BlackBerryEnterprise Server’s Tools window. See page 54 for moreinformation.


Administration tasks — Viewing global statistics48

Viewing global statisticsYou can view the combined statistics of all handhelds on aparticular BlackBerry Enterprise Server.

To view global statisticsIn the BESAdmin window, select Tools > Global Statistics. TheGlobal Statistics window appears.

Viewing statistics by queueYou can view the combined statistics of all handhelds on aparticular BlackBerry Enterprise Server organized by queue.

To view statistics by queueIn the Start menu, select Programs > BlackBerry EnterpriseServer for Lotus Domino > BlackBerry Server Monitor. TheBESMonitor window appears. If necessary, select theBlackBerry Enterprise Server to be monitored from the drop-down list in the Server Name field.

Note If the name of your server does not appear in the list, clickAdd. The Adding BES Server dialog box appears. Type thename of the server into the box and click OK.

Administration tasks — Viewing global statistics


49

Note If the name of your server does not appear in the drop-down list in the Server Name field, click Add. The AddingBES Server dialog box appears. Type the name of theserver into the box and click OK.



To view Global Stats in Performance MonitorPerformance Monitor allows you to view dynamic global statistics.The statistics available in Performance Monitor are the same asthose listed under “Viewing Global Statistics”, but they also showthe SRP connection state.

1. From the Start menu, select Run. In the Open field, typeperfmon and click OK. The Performance window opens.

2. In the Perfmon tool bar, click the Add icon (a + sign). The AddCounters window opens.

Administration tasks — Viewing global statistics


51

3. In the Performance Object field, select BlackBerry Server fromthe drop-down list.

4. Either click All Counters or click Select counters from list toselect individual counters from the drop-down list.

Note To see a description of each counter, click Explain. Toremove a counter from those you are using, select thecounter from the list at the bottom of the Performancewindow and press Delete on your keyboard.



To view Global Stats in SNMPSNMP also allows you to view dynamic global statistics. Thestatistics that you can view in SNMP are the same as the ones listedunder “Viewing Global Stats”.

Viewing Global Stats in SNMP has the following requirements:

• an SNMP service running

• a third-party SNMP Browser that is capable of compiling the.mib file that is included in the installation package.

4Server-level administrationYou can administer tasks that affect all users from the BESAdminwindow.

Adding handheld licensesThe License Manager tracks BlackBerry client licenses. Each timeyou open and exit the Add Users window, the License Manager willtell you if you require more licenses. Once you’ve purchased morelicenses, you should use the License Manager to record the numberof additional licences you have purchased.

1. In the BESAdmin window, connect to the appropriate server.

2. Click Tools and then click License Manager to open theLicense Manager window. Type the updated number oflicenses in the User Licenses field and click OK.

3. You will receive a message: “You have changed theconfiguration of this server. Would you like to apply thechanges to the server?” Click Yes to update your licenseinformation.


Server-level administration — Sending an All Points Bulletin54

Sending an All Points BulletinUse the All Points Bulletin (APB) feature to send an email messageto multiple handheld users. You can choose to send your message toall users on a specific server, or to all users on all your BlackBerryEnterprise Servers.

1. In the BESAdmin tool, select the BlackBerry Enterprise Serverassociated with the message recipients.

2. Click Tools and then click APB. The Send Message windowappears.

WARNING Some of the information in the Server Information window(such as the SRP information) is unique to your installation.Changing any of the information in the SRP Identifier orSRP Authentication fields changes the routing informationfor all users on the server and requires each user togenerate a new encryption key.

Note You can send a message to an individual handheld userfrom the BESAdmin window, by selecting the user and thenselecting Message.

Server-level administration — Sending an All Points Bulletin


55

3. Type information into the Subject and Message fields of thewindow and click OK. The message will be sent to the usersassociated with the server that you’ve specified.

5BESMonitor and BESAlertThe BESMonitor program is installed automatically when you selectUtilities during installation. This program can be installed on theBlackBerry Enterprise Server or on another computer, and can beused to monitor multiple BlackBerry Enterprise Servers.

By default, the BlackBerry Enterprise Server records significantevents in the Notes Event Log under Miscellaneous Events. Theseevents include errors, warnings, and various types of informationlevels.

The BESAlert tool watches the NT Event Log, and can be configuredto send you a copy of events whenever an error, warning orinformation event is recorded. Since registry settings can be used todetermine the level of event to be recorded, these settings may alsoaffect the operation of the BESAlert tool.

Checking server statusWhen BESMonitor is running, an icon appears in the Systray (lower-right of screen.) Holding your mouse over the icon displays theBlackBerry Enterprise Server status as a tooltip.

Icon Tooltip appearing withmouseover

Description

BES Monitor [name ofserver]: connected

Server is running


BESMonitor and BESAlert — Checking server status58

It is possible to monitor the BlackBerry Enterprise Server using theBESMonitor icons. If you double-click the icon, a dialog box opensto show the name of the server being monitored, its status, and itsglobal statistics.

Icon Tooltip appearing withmouseover

Description

BES Monitor [name ofserver]: disconnected

Server is running, but theSRP connection is down

BES Monitor [name ofserver]: disabled

Server is not running

Note For information on what to do when your SRP connection islost or your server is not running, consult the FAQ chapterof this guide.

BESMonitor and BESAlert — Configuring BESAlert


59

Configuring BESAlertYou can configure the BESAlert program to send you a copy ofevents whenever an Error, Warning or Information event (withevent ID 5) is logged.

To configure BESAlert notifications1. To open the BESMonitor window, click Start > Programs >

BlackBerry Enterprise Server for Lotus Domino > BlackBerryServer Monitor.

2. Click Configure to open the BESAlert Configuration window.

Note If the Server Name field is empty, click Add. In the resultingdialog, type the name of the server to be monitored andclick OK.


BESMonitor and BESAlert — Configuring BESAlert60

3. In the Notification Account Name field, type the full SMTPaddress from which the BESAlert messages will be sent (forexample, [email protected]).

4. In the Notification Host Name field, type the name of themachine on which the SMTP server is running (for example,smtp.acme.com).

5. Some servers require an NT account name (in addition to anSMTP address and a machine name) to be able to sendBESAlert messages. Type the NT account name into theNotification Login Name field if your server requires it. (Forexample, type the name you use to log into your NT machine.)

6. Each significant event that is logged and sent to administratorscan be sent to multiple destinations. The User Notificationsection lists the destinations or users who will receive these

BESMonitor and BESAlert — Configuring BESAlert


61

event reports. To add new names to the User Notification list,click Add; to update names currently in the User Notificationlist, click Edit. The User Configuration window appears.

7. In the Name field, type the user or machine name as you’d likeit to appear in the User Notification list (a simple alias issufficient).

8. Each destination in the list can have an associated emailaddress, a popup console specification, or both. In the Emailaddress field, type the destination email address to be usedwhen sending notifications to this particular user.

9. In the Console name field, type the name of the machine onwhich the popup message is to be displayed. Click OK to closethe window.

10. If necessary, repeat steps 6-9 to add more names to the UserNotification list. Click OK to close the BESAlert ConfigurationWindow.

6Frequently asked questionsFor additional support:

• Email: [email protected]

• Phone: 1-887-BLK-BERRY (1-887-255-2377) U.S. andCanada

• Web: www.blackberry.net (for general information aboutthe BlackBerry Wireless Email Solution)

What should I do when the BESMonitor statusshows “SRP Connection Down”.

SymptomsThe BESMonitor icon in the Windows SysTray indicates thatBlackBerry Enterprise Server status is SRP Connection Down.

ProblemWhile the BlackBerry Enterprise Server is running, the SRP (the linkto the wireless network) is disconnected.

SolutionYou should check that DNS is set up properly on the servermachine. It may not be able to resolve or find srp.blackberry.net (theNetwork Access Node specified during installation). To find outwhere the connection process is failing, run the BBSRPTEST utility.


Frequently asked questions64

1. Copy bbsrptest.exe to the machine that is running BlackBerryEnterprise Server.

2. Open a command prompt and run the program with oneadditional parameter: bbsrptest srphostname. (Refer to yourInstallation Check List on page 10, under “srp host” for yourhostname information.) The utility will read the settings fromthe registry and attempt to connect to the SRP server.

What you should see is:

• Attempting to connect to srp.blackberry.net (206.51.26.33),port 3101 Successful

You may see one of the following messages instead:

• gethostbyname( ) failed for name srp.blackberry.net: errorcode = 11001This message indicates a configuration problem on yourmachine, as it is unable to look up the SRP server's name.Error 11001 means name not found.

• connect( ) failed: error code = 10060This message indicates that the connection request is notbeing answered, or that the firewall “lost” the connectionrequest. Error 10060 means a timeout.

• connect( ) failed: error code = 10061This message indicates that the connection was refused;either the SRP server is not running or the firewallprevented the connection from going through. Error 10061means that the connection was refused.

• recv( ): connection lostThis message indicates that the connection was broken (bythe firewall or proxy) before the test program couldconnect to the SRP server. The error code that is listed isthe Winsock error code.

Frequently asked questions


65

Why isn’t this laptop user's handheld receivingmessages?

SymptomsThe laptop user’s handheld has not received email messages sincethe laptop was last connected to the LAN.

ProblemIf the user is running BlackBerry Desktop Software on a laptopconnected to a LAN, and the handheld is connected to the laptop,the user must exit the BlackBerry Desktop Manager beforedisconnecting the laptop from the LAN.

If the user does not remove the handheld from the cradle (or exit theDesktop Manager) before disconnecting the laptop from the LAN,the server will not be notified that the handheld is no longer in thecradle. Therefore, if the "don't forward messages while thehandheld is in the cradle" option is turned on, no email will beforwarded to the handheld as the server believes it is still in thecradle.

SolutionInstruct the user to connect to the LAN again. Start the BlackBerryDesktop Manager and connect the handheld to the PC. Thenremove the handheld from the cradle and exit the BlackBerryDesktop Manager.

BlackBerry EnterpriseServer Software LicenseAgreementThis is a legal agreement between you, the Customer ("You"), andResearch In Motion Limited ("RIM"). BY INSTALLING, USING ORMAKING ONE OR MORE COPIES OF THIS SOFTWARE (OR ANYCOMBINATION OF THE FOREGOING), YOU ARE AGREEINGTO BE BOUND BY THE TERMS OF THIS AGREEMENT. IF YOUDO NOT AGREE TO THE TERMS OF THIS AGREEMENT,PROMPTLY RETURN THE SOFTWARE AND THEACCOMPANYING ITEMS (INCLUDING WRITTEN MATERIALSAND BINDERS OR OTHER CONTAINERS) TO RIM.

1.0 Definitions

1.1 "SOFTWARE" means the RIM Software Product(s) providedunder this license to You for use in conjunction with the BlackBerryHandheld Product (the "Handheld Product"), regardless of whetherthe SOFTWARE is the BlackBerry Enterprise Server Software orsoftware residing on the Handheld Product. The term SOFTWAREincludes all related software, regardless of the form in which it isprovided to You or the form in which You may subsequently use it,and includes all documentation and other written materials relatedto the SOFTWARE and the Handheld Product; however, the termSOFTWARE shall not include any software applications developedby a third party other than RIM ("Third Party Software"), whether ornot Third Party Software accompanies or is provided with theSOFTWARE and/or Handheld Product. Any such Third PartySoftware shall be governed by an End-User Software Licenseaccompanying and relating specifically to such Third PartySoftware.


BlackBerry Enterprise Server Software License Agreement68

2.0 Grant of License

2.1 This RIM Software License Agreement ("LICENSE") herebygrants You a non-exclusive, non-transferable right to install and useone copy of the SOFTWARE on a single CPU residing on Yourpremises solely in conjunction with the Handheld Product. Thisdoes not imply any rights to future upgrades of the SOFTWARE.

3.0 Intellectual Property; Export Restrictions

3.1 The SOFTWARE is owned by RIM and is protected by Canadian,U.S. and international copyright laws. You must, therefore, treat theSOFTWARE like any other copyrighted material. In addition, otherintellectual property laws, including patent laws, and treatiesprotect the SOFTWARE.

3.2 You may not print, copy, reproduce, distribute, modify or in anyother manner duplicate the SOFTWARE, in whole or in part. Youmay make one (1) copy for backup or archival purposes.

3.3 You may not copy the Handheld Product manual(s) or anywritten materials accompanying the SOFTWARE, if any suchmaterials are included.

3.4 You may not decompile, disassemble or otherwise reverseengineer, to extent permitted under law, the SOFTWARE, or anypart of it. You do not have the right to obtain or use any source codefor the SOFTWARE.

3.5 The SOFTWARE contains cryptographic modules that may becontrolled for export purposes by the governments of the UnitedStates and/or Canada. The Software may not be used in and/orexported to any country other than the United States and Canada.Notwithstanding the license grant in Section 2.1, You agree that youwill not export the Software or use, or permit any other party to use,the Software in any country other than the United States andCanada, and you agree to indemnify and hold RIM harmless fromany damage caused by your failure to comply with this Section 3.5.

BlackBerry Enterprise Server Software License Agreement


69

4.0 Term

4.1 The grant of rights shall be non-exclusive, non-transferable andperpetual provided that You do not breach the terms and conditionsof this Agreement or any other agreement with RIM and furtherprovided that you comply with the terms of any documentationaccompanying the SOFTWARE and/or the Handheld Product.

5.0 Warranty and Disclaimers; U.S. Government Rights

5.1 RIM warrants that any disk or other media that the SOFTWAREis recorded on, if provided by RIM, will be free from defects inmaterials and workmanship under normal use and service for aperiod of 90 days from the date of delivery. Any implied warrantiesor conditions relating to the SOFTWARE to the extent they are notdisclaimed below are limited to 90 days. This warranty does notextend to any disk or other media that has been damaged as a resultof accident, misuse, abuse, or as a result of service or modificationby anyone other than RIM.

5.2 RIM's entire liability and your exclusive remedy shall be areplacement of the defective disk, when You return to RIM thedefective disk and any copies You have made of it. Any replacementdisk that is supplied is warranted for the remainder of the originalwarranty period.

5.3 RIM DISCLAIMS ALL OTHER WARRANTIES ANDCONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUTNOT LIMITED TO IMPLIED WARRANTIES OR CONDITIONS OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,AND NONINFRINGEMENT, EACH WITH RESPECT TO THESOFTWARE AND ANY THIRD PARTY SOFTWARE, THEACCOMPANYING MANUAL(S) AND WRITTEN MATERIALS.

5.4 This limited warranty gives You specific legal rights. You mayalso have other rights that vary by state or province. Somejurisdictions may not allow the exclusion or limitation of incidentalor consequential damages nor allow limitations on how long an


BlackBerry Enterprise Server Software License Agreement70

implied warranty lasts. Thus, the above limitations or exclusionsmay not apply to You.

5.5 IN NO EVENT SHALL RIM BE LIABLE FOR ANY OTHERDAMAGES WHATSOEVER (INCLUDING, WITHOUTLIMITATION, DAMAGES FOR LOSS OF BUSINESS PROFITS,BUSINESS INTERRUPTION, LOSS OF BUSINESS INFORMATIONOR CORRUPTION OR LOSS OF DATA, OR OTHER PECUNIARYLOSS) ARISING OUT OF THE USE OF OR INABILITY TO USETHE SOFTWARE OR ANY THIRD PARTY SOFTWARE, EVEN IFRIM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCHDAMAGES. THIS LIMITATION IS INTENDED TO APPLY ANDDOES APPLY WITHOUT REGARD TO WHETHER SUCHDAMAGES ARE CLAIMED, ASSERTED OR BROUGHT IN ANACTION OR CLAIM SOUNDING IN TORT OR CONTRACT, ORBASED ON THE BREACH OF ANY EXPRESS OR IMPLIEDWARRANTY, OR UNDER ANY OTHER LAW OR FORM OFACTION. IN NO EVENT SHALL RIM'S LIABILITY TO YOUEXCEED THE COST OF REPLACING THE MEDIA UPON WHICHTHE SOFTWARE IS RECORDED.

5.6 This SOFTWARE is provided with RESTRICTED RIGHTS. Use,duplication or disclosure by the U.S. Government is subject torestrictions as set forth in DFARS 227.7202 or in FAR 52.227-19, asapplicable. Contractor is Research In Motion Limited, 295 PhillipStreet, Waterloo, Ontario, Canada N2L 3W8.

5.7 This LICENSE is to be construed in Canada under the laws of theProvince of Ontario and in the United States under the laws of theState of Texas, except for any body of law governing conflicts of law.

Index

Aabout

BESAdmin, 33BESMonitor, 57the BlackBerry encryption

model, 43the server, 5this guide, 7

addinga user and PIN, 38administrators, 27handheld licenses, 53users, 37

administrative functions, 33

administratorlogging in, 12

all points bulletin, 54

BBESAdmin

about, 33opening window, 33properties window, 45

BESAlert, 59

BESMonitorabout, 57checking status with, 57

BlackBerryAdminsadministrators, 27

BlackBerryAdmins group, 24

Cchanging a user’s handheld, 47

checking server status, 57

clearingall messages, 42in-cradle status, 43

connection lost error, 29

corporate firewall, 6

cradleinserting handheld, 36uses, 35

Ddisabling a handheld, 41

Eemail

path, 6reading status of, 45

enabling a handheld, 40

encryption key, generating, 43

encryption model, about, 43

errorconnection lost, 29statistics for users, 46

error code10060, 2810061, 3011001, 30

Ffirewall

configurationrequirements, 11

frequently asked questions, 63

Ggenerating encryption keys, 43

global statsperformance monitor, 50

Hhandheld

changing a user’s, 47disabling a, 41enabling a, 40licences for, 53placing in cradle, 36removing from cradle, 37

Iin-cradle status, clearing, 43

installingmore than one server, 16the BlackBerry Enterprise

Server, 13

Llast contact - statistic, 46

last forwarded - statistic, 46

last key date - statistic, 46

last mailbox scan - statistic, 46

last time in cradle - statistic, 46

license agreement, 15

licenses, adding, 53

Mmanaging the server fromanother machine, 16

messagelast expired - statistic, 46last forwarded - statistic, 46sending to all users, 54sending to one user, 46

messagesexpired - statistic, 46filtered - statistic, 45forwarded - statistic, 45pending - statistic, 45purging all, 42received - statistic, 45sent from handheld -

statistic, 45

monitoring email statistics, 44

Ppending messages, purging, 42

performance monitor, viewingglobal stats, 50

permissions on Dominoserver, 37

ping test, 30

polling interval, defining, 17

port 3101, 6, 11

pre-installation checklist, 9

properties window, 45

purging pending messages, 42

Rreading email status, 45

removing a user, 42

requirementsfirewall configuration, 11hardware, 9permissions, 37software, 10

Ssending a message

to one user, 46

serverchecking status, 57installing, 13managing from another

machine, 16uninstalling, 30

server add-in task, starting, 28

server-level tasks, 53

setup and installation,BlackBerry Enterprise Server, 9

setup overview, 12

Software LicenseAgreement, 67

SRP warning, 54

statisticsby queue, 48global, 48

status, of email, 45

Ttimeout error, 28

Uuninstalling, 30

useradding a PIN, 38adding to a server, 37enabling and disabling, 40registering in Notes, 37removing, 41, 42

Vviewing

global statistics, 48global stats in performance

monitor, 50

viewing global statistics, 48

blackberry enterprise server for lotus · pdf fileblackberry enterprise server software for...

Documents