BlackBerry Enterprise Server Resource Kit

Version: 5.0 | Service Pack: 3

Installation Guide

Published: 2011-01-24 SWD-1322296-0124032826-001

Contents
1 Overview........................................................................................................................................................... Options for downloading the BlackBerry Enterprise Server Resource Kit........................................................ BlackBerry Enterprise Server User Administration Tool................................................................................... BlackBerry Analysis, Monitoring, and Troubleshooting Tools.......................................................................... Available BlackBerry Analysis, Monitoring, and Troubleshooting Tools........................................................... 2 Requirements................................................................................................................................................... System requirements: BlackBerry Enterprise Server User Administration Tool............................................... System requirements: BlackBerry Analysis, Monitoring, and Troubleshooting Tools...................................... System requirements: BlackBerry Application Reporting Tool......................................................................... System requirements: BlackBerry Domain Administration History Reporting Tool......................................... System requirements: BlackBerry Message Receipt Confirmation Tool.......................................................... System requirements: BlackBerry Domain Search........................................................................................... System requirements: BlackBerry System Log Monitoring and Reporting Tool............................................... System requirements: Log analysis tools.......................................................................................................... System requirements: BlackBerry Enterprise Server Log Monitoring Tool...................................................... 3 Installing a BlackBerry Enterprise Server Resource Kit tool.............................................................................. Installation files................................................................................................................................................. Configuring the BlackBerry Enterprise Server User Administration Tool and the BlackBerry Analysis, Monitoring, and Troubleshooting Tools to use UAC-compliant file paths....................................................... Install the BlackBerry Enterprise Server User Administration Tool.................................................................. Verify that the BlackBerry Enterprise Server User Administration Tool was installed correctly...................... Install the BlackBerry Analysis, Monitoring, and Troubleshooting Tools......................................................... Install BlackBerry Domain Search..................................................................................................................... Configure BlackBerry Domain Search........................................................................................................ Configure single sign-on authentication for BlackBerry Domain Search................................................... 4 Upgrading from a previous version of a BlackBerry Enterprise Server Resource Kit tool................................ Upgrading from a previous version of the BlackBerry Enterprise Server User Administration Tool................ Upgrading from a previous version of the BlackBerry Analysis, Monitoring, and Troubleshooting Tools....... 5 Troubleshooting................................................................................................................................................ The BlackBerry Domain Search setup application does not complete successfully......................................... Check the status of the BlackBerry Enterprise Server User Administration Tool............................................. When I check the status of the BlackBerry Enterprise Server User Administration Tool I receive an "Error while initializing the logs" error message....................................................................................... Removing a BlackBerry Enterprise Server Resource Kit tool............................................................................ 3 3 3 4 4 6 6 7 7 8 8 9 10 11 12 13 13 14 14 15 15 15 16 18 19 19 19 20 20 20 21 21

Remove the BlackBerry Enterprise Server User Administration Tool........................................................ Remove the BlackBerry Analysis, Monitoring, and Troubleshooting Tools............................................... Remove BlackBerry Domain Search........................................................................................................... 6 Glossary............................................................................................................................................................ 7 Provide feedback.............................................................................................................................................. 8 Legal notice.......................................................................................................................................................

21 21 22 23 24 25

Installation Guide

Overview

Overview
The BlackBerry Enterprise Server Resource Kit contains the following tool packages: BlackBerry Enterprise Server User Administration Tool BlackBerry Analysis, Monitoring, and Troubleshooting Tools BlackBerry Enterprise Transporter

The BlackBerry Enterprise Server Resource Kit is a collection of tools that can help you extend your ability to manage and monitor the BlackBerry Enterprise Solution. You can download the BlackBerry Enterprise Server Resource Kit from www.blackberry.com/support/downloads.

Options for downloading the BlackBerry Enterprise Server Resource Kit

You have the following options for downloading the BlackBerry Enterprise Server Resource Kit: You can download the BlackBerry Enterprise Server User Administration Tool only or the BlackBerry Enterprise Transporter only. You can download a setup application that you can use to install any of the BlackBerry Analysis, Monitoring, and Troubleshooting Tools.

BlackBerry Enterprise Server User Administration Tool

You can use the BlackBerry Enterprise Server User Administration Tool to manage user accounts on the BlackBerry Enterprise Server on a large scale. For example, you can add, find, move, and remove user accounts, or change user account configurations. You can run the BlackBerry Enterprise Server User Administration Tool from a command prompt to perform BlackBerry Enterprise Server administration tasks or to gather management and monitoring information. The BlackBerry Enterprise Server User Administration Tool connects to the BlackBerry Administration Service to retrieve information from and store information in the BlackBerry Configuration Database. If the BlackBerry Enterprise Server User Administration Tool is version 5.0 SP1 or later, you can use the BlackBerry Enterprise Server User Administration Tool with any version of the BlackBerry Enterprise Server that is version 5.0 SP1 or later. The tool includes commands that are classified as server options or client options. Server options are commands that are dependent on the BlackBerry Enterprise Server version, not the version of the BlackBerry Enterprise Server User Administration Tool. If new server options are introduced in a new version of the BlackBerry Enterprise Server, you are not required to update the BlackBerry Enterprise Server User Administration Tool to the same version as the BlackBerry Enterprise Server to use the server options. Client options are commands that are dependent on the version of the BlackBerry Enterprise Server User Administration Tool. New client options are available only if you update to the latest version of the BlackBerry Enterprise Server User Administration Tool. You can use the -? parameter to view the complete list of server options and client options that are available in the BlackBerry Enterprise Server User Administration Tool.

Installation Guide

BlackBerry Analysis, Monitoring, and Troubleshooting Tools

BlackBerry Analysis, Monitoring, and Troubleshooting Tools

You can use the BlackBerry Analysis, Monitoring, and Troubleshooting Tools to streamline management tasks, monitor events, collect statistics, and troubleshoot issues with the BlackBerry Enterprise Server components.

Available BlackBerry Analysis, Monitoring, and Troubleshooting Tools

Name Description BlackBerry Application Reporting Tool This tool lists the applications that are installed in the BlackBerry Domain. (HHAppReport.exe) You can use this tool to audit the BlackBerry Domain and find unapproved applications. BlackBerry Domain Administration This tool reads the ServerConfigHistory table in the BlackBerry History Reporting Tool Configuration Database and displays configuration changes, such as (AdminHistory.exe) newly added user accounts, in a .csv file. The tool records the date and time of each change and the name of the administrator who made the change. BlackBerry IT Policy Import and Export This tool exports IT policy information from a BlackBerry Configuration Tool (ITPolicyImportExport.exe) Database. The global IT policy rules are a specific set of IT policy rules that apply to all user accounts on a BlackBerry Enterprise Server. BlackBerry Message Receipt This tool verifies that the BlackBerry Enterprise Server is sending Confirmation Tool messages to BlackBerry devices. At an interval that you specify, the (MessageConfirmService.exe) BlackBerry Message Receipt Confirmation Tool sends a message to the specified user account, monitors the status of that message, and checks for confirmation that the BlackBerry device receives the message. BlackBerry System Log Monitoring and This tool monitors the BlackBerry Enterprise Server log events as they Reporting Tool (BESSysLog.exe) are written to the log file. You can specify which BlackBerry Enterprise Server components to monitor, the events that the tool tracks, and the types of notifications and reports that the tool sends to administrators. BlackBerry Enterprise Server Log This tool monitors the text that is written to the end of a text file, typically Monitoring Tool (LogMonitor.exe) a log file. You can specify events by typing numeric event IDs or text strings at the command prompt or by using an input file. You can specify actions that the tool performs after it finds a value that meets the specified criteria. BlackBerry System Requirements Tool This tool provides a set of tests that can help you determine whether you (BBCheck.exe) can successfully run a BlackBerry Enterprise Server component on a computer.

Installation Guide

Available BlackBerry Analysis, Monitoring, and Troubleshooting Tools

Name BlackBerry Domain Search

Description This web application permits you to search for user accounts across more than one BlackBerry Domain. You can search for administrator accounts and user accounts using various criteria, including user name, user ID, IT policy, PIN, email address, BlackBerry Enterprise Server instance, and group name. The search results provide basic information for the accounts that match the search criteria that you specify. You can click the display name for a user account to view detailed information for the user account.

Installation Guide

Requirements

Requirements

System requirements: BlackBerry Enterprise Server User Administration Tool

Item operating system Requirement Any of the following 32-bit operating systems: Windows XP Professional SP2 Windows Server 2000 SP4 Windows Server 2003 SP1 or later Windows Server 2003 R2 Windows Server 2003 R2 SP2 Windows Server 2008 Windows Server 2008 R2 Any of the following 64-bit operating systems: Windows Server 2003 Windows Server 2003 SP1 or later Windows Server 2008 Windows Server 2008 R2 minimum 2 GB of memory Windows Internet Explorer version 6.0 or version 7.0 with language preferences configured to display encoded web pages The following conditions: connection from the BlackBerry Administration Service to the BlackBerry Enterprise Server User Administration Tool the BlackBerry Enterprise Server User Administration Tool is compatible with BlackBerry Enterprise Server 5.0 SP1 or later In the BlackBerry Enterprise Server User Administration Tool 5.0 SP2 and later, running the BlackBerry Enterprise Server User Administration Tool from a remote computer using the UNC path is not supported. If you did not run the setup application for the tool on the computer, the computer might not have the security requirements to run the tool.

memory browser BlackBerry Administration Service

Running the BlackBerry Enterprise Server User Administration Tool from a remote computer

Installation Guide

System requirements: BlackBerry Analysis, Monitoring, and Troubleshooting Tools

System requirements: BlackBerry Analysis, Monitoring, and Troubleshooting Tools

Item operating system Requirement Any of the following 32-bit operating systems: Windows XP Professional SP2 Windows Server 2000 SP4 Windows Server 2003 SP1 or later Windows Server 2003 R2 Windows Server 2003 R2 SP2 Windows Server 2008 Windows Server 2008 R2 Any of the following 64-bit operating systems: Windows Server 2003 Windows Server 2003 SP1 or later Windows Server 2008 Windows Server 2008 R2 You must install some of the BlackBerry Analysis, Monitoring, and Troubleshooting Tools on the same computer as a BlackBerry Enterprise Server component, as specified in the requirements for each tool. Running a tool can affect the performance of the BlackBerry Enterprise Server component.

BlackBerry Enterprise Server

System requirements: BlackBerry Application Reporting Tool

Item database management system for the BlackBerry Configuration Database Requirement Any of the following 32-bit database management systems: Microsoft SQL Server 2005 Microsoft SQL Server 2005 SP2 Microsoft SQL Server 2005 Express Microsoft SQL Server 2005 Express SP2 Microsoft SQL Server 2008 R2 Any of the following 64-bit database management systems: Microsoft SQL Server 2005 Microsoft SQL Server 2005 SP2 Microsoft SQL Server 2008 R2
7

Installation Guide

System requirements: BlackBerry Domain Administration History Reporting Tool

System requirements: BlackBerry Domain Administration History Reporting Tool

Item BlackBerry Enterprise Server Requirement You must run the BlackBerry Domain Administration History Reporting Tool on a computer that is separate from the BlackBerry Enterprise Server components. database management system Any of the following 32-bit database management systems: for the BlackBerry Microsoft SQL Server 2005 Configuration Database Microsoft SQL Server 2005 SP2 Microsoft SQL Server 2005 Express Microsoft SQL Server 2005 Express SP2 Microsoft SQL Server 2008 R2 Any of the following 64-bit database management systems: Microsoft SQL Server 2005 Microsoft SQL Server 2005 SP2 Microsoft SQL Server 2008 R2 connection from the BlackBerry Configuration Database to the BlackBerry Domain Administration History Reporting Tool

BlackBerry Configuration Database

System requirements: BlackBerry Message Receipt Confirmation Tool

Item BlackBerry Enterprise Server Requirement You must run the BlackBerry Message Receipt Confirmation Tool on a computer that is separate from the computers that host the BlackBerry Enterprise Server components. BlackBerry Message Receipt You must run the BlackBerry Message Receipt Confirmation Tool service Confirmation Tool service and (messageconfirmservice.exe) and the BlackBerry Message Receipt Confirmation client Tool client (messageconfirmconfig.exe) on the same computer. Microsoft Exchange system Before you install and run the BlackBerry Message Receipt Confirmation Tool, tools you must perform the following tasks: 1. On the computer that you want to host the tool, download and install Microsoft Exchange Server MAPI client and CDO 1.2.1. For information about the versions of the Microsoft Exchange Server MAPI client and CDO 1.2.1 that are supported by the BlackBerry Enterprise Server, visit www.blackberry.com/go/compatibility to see the BlackBerry Enterprise Server compatibility matrix.

Installation Guide

System requirements: BlackBerry Domain Search

Item

Requirement 2. On the computer that hosts the BlackBerry Enterprise Server, copy the BESProfile.exe file located at <drive>:\Program Files\Research In Motion \BlackBerry Enterprise Server to the computer that you want to host the BlackBerry Message Receipt Confirmation Tool. On the computer that you want to host the tool, open a command prompt window and type cd <drive>:\\<file_path> to navigate to the folder that contains the BESProfile.exe file. In the command prompt window, type the following command: besprofile.exe -s -p <profile_name>. Follow the instructions on the screen to create a MAPI profile.

3.

4. 5.

System requirements: BlackBerry Domain Search

Item web server Requirement Microsoft IIS 5.0 or later for Windows Server that is configured with ASP.NET 2.0. If you want to configure single sign-on authentication for BlackBerry Domain Search, Microsoft IIS 6.0 or later is required. If you are running a 64-bit version of Microsoft IIS, you must use a 64-bit version of ASP.NET. If you are running a 32-bit version of ASP.NET with a 64-bit version of Microsoft IIS, you must configure Microsoft IIS to run 32-bit applications. For more information about how to configure Microsoft IIS to run 32-bit applications, visit http://www.microsoft.com/technet/prodtechnol/windowsserver2003/ library/iis/0aafb9a0-1b1c-4a39-ac9a-994adc902485.mspx?mfr=true. Windows Internet Explorer 6.0 to 8.0 with the following settings: language preferences configured to display encoded web pages BlackBerry Administration Service and BlackBerry Domain Search web sites assigned to the local intranet or trusted sites security zone The web server that hosts BlackBerry Domain Search must be able to access the BlackBerry Domain instances that you want to search. BlackBerry Enterprise Server 5.0 or later. If your organization uses BlackBerry Enterprise Server 5.0, you must download and install the BlackBerry Administration API for the BlackBerry Enterprise Server. To download the BlackBerry Administration API, visit www.blackberry.com/support/downloads. For BlackBerry Enterprise Server 5.0 SP1 and later, the BlackBerry Administration API is installed when you install the BlackBerry Enterprise Server, so you do not need to download and install it separately.
9

browser

access to BlackBerry Domain instances BlackBerry Enterprise Server compatibility

Installation Guide

System requirements: BlackBerry System Log Monitoring and Reporting Tool

Item BlackBerry Administration Service compatibility

BlackBerry Administration Service permissions

BlackBerry Browser support supported environments

Requirement Installing BlackBerry Domain Search on a computer that hosts a BlackBerry Administration Service does not cause a port conflict. By default, BlackBerry Domain Search listens on port 80 and the BlackBerry Administration Service listens on port 443. The administrator account that you use to log in to BlackBerry Domain Search must have the Junior Helpdesk administrative role or an administrative role with less restrictive permissions than the default Junior Helpdesk role. If your organization's environment includes BlackBerry Enterprise Server instances that are earlier that BlackBerry Enterprise Server 5.0 SP2, to search for user accounts by BlackBerry Enterprise Server instance, administrator accounts require the View an instance permission. You can access BlackBerry Domain Search from the BlackBerry Browser. BlackBerry Enterprise Server 5.0 or later for Microsoft Exchange BlackBerry Enterprise Server 5.0 or later for IBM Lotus Domino BlackBerry Enterprise Server Express 5.0 SP2 or later Any of the following environments: BlackBerry Enterprise Server for Novell GroupWise Any version of the BlackBerry Enterprise Server that is earlier than version 5.0

unsupported environments

System requirements: BlackBerry System Log Monitoring and Reporting Tool

Item BlackBerry Enterprise Server Requirement You must run the BlackBerry System Log Monitoring and Reporting Tool on a computer that is separate from the computer or computers that host the BlackBerry Enterprise Server components. multiple BlackBerry Enterprise In an environment that includes more than one BlackBerry Enterprise Server Server platforms (optional) platform, the following conditions must be met: you must install and configure a separate copy of the BlackBerry System Log Monitoring and Reporting Tool for each platform you can run only one instance of the BlackBerry System Log Monitoring and Reporting Tool on a computer Windows service You must run the BlackBerry System Log Monitoring and Reporting Tool as a Windows service. Windows Server 2008 (64If your organization uses Windows Server 2008 (64-bit), you must create a reverse bit) DNS lookup record so that the BlackBerry System Log Monitoring and Reporting Tool can record the appropriate server names in the log files that it creates.

10

Installation Guide

System requirements: Log analysis tools

Item

Requirement Perform the following actions: 1. 2. In the advanced TCP/IP settings for the network connection that the tool uses, select Use this connection's DNS suffix in DNS registration.

version compatibility logging level

At the command prompt, using an account with administrator permissions, type ipconfig /registerdns and press ENTER. BESSysLog.exe and BESSysLogConfig.exe must be the same version and must be installed in the same folder on the same computer. You must set the logging level for the log files for the BlackBerry Dispatcher and the BlackBerry Messaging Agent to a minimum level of 3.

System requirements: Log analysis tools

Item operating system Requirement Any of the following 32-bit operating systems: Windows XP Professional SP2 Windows Server 2000 SP4 Windows Server 2003 SP1 or later Windows Server 2003 R2 Windows Server 2003 R2 SP2 Windows Server 2008 Windows Server 2008 R2 Any of the following 64-bit operating systems: Windows Server 2003 Windows Server 2003 SP1 or later Windows Server 2008 Windows Server 2008 R2 minimum 2 GB of memory The computer that you install the log analysis tools on must have a large volume of available disk space to accommodate the size of the log files for the BlackBerry Enterprise Server components and the log analysis output files. You must run the log analysis tools on a computer that is separate from the computers that host the BlackBerry Enterprise Server components. You must store or copy the log files for the BlackBerry Enterprise Server components that you plan to analyze on the same computer as the log analysis tools. The log analysis tools and the BlackBerry Enterprise Server components must be the same version.

memory disk space

BlackBerry Enterprise Server BlackBerry Enterprise Server log files version compatibility

11

Installation Guide

System requirements: BlackBerry Enterprise Server Log Monitoring Tool

System requirements: BlackBerry Enterprise Server Log Monitoring Tool

Item BlackBerry Enterprise Server log files Requirement You must run the BlackBerry Enterprise Server Log Monitoring Tool on the computer that hosts the BlackBerry Enterprise Server component. The BlackBerry Enterprise Server Log Monitoring Tool can monitor only one log file at a time.

12

Installation Guide

Installing a BlackBerry Enterprise Server Resource Kit tool

Installing a BlackBerry Enterprise Server Resource Kit tool

Installation files
Tool BlackBerry Enterprise Server User Administration Tool BlackBerry Enterprise Transporter Installation file name Environment brk-besuseradminclient<version>.msi All brkbbenterprisetransporter<version>.ms i brk-amt<version>.msi brk-amt<version>.msi brk-amt<version>.msi brk-amt<version>.msi brk-amt<version>.msi brk-amt<version>.msi blackberrysearch<version>.msi (must run brk-amt<version>.msi) All

BlackBerry Application Reporting Tool BlackBerry Domain Administration History Reporting Tool BlackBerry IT Policy Import and Export Tool BlackBerry Message Receipt Confirmation Tool BlackBerry System Log Monitoring and Reporting Tool BlackBerry System Requirements Tool BlackBerry Domain Search

All All All All All All Microsoft Exchange and IBM Lotus Domino BlackBerry Enterprise Server Express

Log analysis tools BlackBerry Delayed Notifications Monitoring Tool BlackBerry Enterprise Server Log Monitoring Tool BlackBerry Historical Statistics Tool BlackBerry MAPI and CDO Error Monitoring Tool BlackBerry MDS Services Data Monitoring Tool BlackBerry Message Flow Reporting Tool BlackBerry Message Pending Delivery Tool BlackBerry Thread Analyzer Tool BlackBerry Usage Monitoring Tool BlackBerry User Activity Reporting Tool

brk-amt<version>.msi brk-amt<version>.msi brk-amt<version>.msi brk-amt<version>.msi brk-amt<version>.msi brk-amt<version>.msi brk-amt<version>.msi brk-amt<version>.msi brk-amt<version>.msi brk-amt<version>.msi

Microsoft Exchange only All All Microsoft Exchange only All All All All All Microsoft Exchange only
13

Installation Guide

Configuring the BlackBerry Enterprise Server User Administration Tool and the BlackBerry Analysis, Monitoring, and Troubleshooting Tools to use UAC-compliant file paths

Configuring the BlackBerry Enterprise Server User Administration Tool and the BlackBerry Analysis, Monitoring, and Troubleshooting Tools to use UACcompliant file paths
If you install the BlackBerry Enterprise Server User Administration Tool or any of the BlackBerry Analysis, Monitoring, and Troubleshooting Tools that use a command-line interface, when you run the setup application you can specify whether you want the tool to use a UAC-compliant file path for configuration files, input files, output files, and log files. The setup application creates a subfolder for the files in the application data folder for the current user (for example, <drive>:\Users\<user_name>\AppData\Roaming\Research In Motion\AMT\ or <drive>:\Documents and Settings\user_name\Application Data\Research In Motion\AMT\). When you use the BlackBerry Enterprise Server User Administration Tool or any of the BlackBerry Analysis, Monitoring, and Troubleshooting Tools that use a command-line interface, you can use the -uac or -no_uac subparameters when you run a command to override the setting that you configured when you installed the tool. For example, if you configured the BlackBerry Application Reporting Tool to use a UAC-compliant file path, you can use the -no_uac subparameter to write output files and log files to a file path that is relative to the current working directory (for example, <drive>:\Program Files\Research In Motion\BlackBerry Enterprise Server Resource Kit \BlackBerry AMT Tools).

Install the BlackBerry Enterprise Server User Administration Tool

1. 2. 3. 4. 5. 6. On the computer where you plan to install the BlackBerry Enterprise Server User Administration Tool, create a folder to store the installation files. In a browser, visit www.blackberry.com/support/downloads, and navigate to the Downloads area for the BlackBerry Enterprise Server Resource Kit. Download the installation package for the version of the BlackBerry Enterprise Server User Administration Tool that is compatible with your organization's version of the BlackBerry Enterprise Server. Extract the contents of the installation package to the folder you created. Double-click the .msi file for the tool. Complete the instructions on the screen.

After you finish: Verify that the BlackBerry Enterprise Server User Administration Tool was installed correctly. If you specified incorrect information when you ran the setup application for the BlackBerry Enterprise Server User Administration Tool, you can edit the information in the BESUserAdminClient.exe.config file.

14

Installation Guide

Verify that the BlackBerry Enterprise Server User Administration Tool was installed correctly

Verify that the BlackBerry Enterprise Server User Administration Tool was installed correctly
Before you begin: Verify that you have the required permissions to manage users in the BlackBerry Administration Service. 1. On the computer that hosts the BlackBerry Enterprise Server User Administration Tool, on the taskbar, click Start > All Programs > BlackBerry Enterprise Server Resource Kit > BlackBerry Enterprise Server User Administration Tool. Click BlackBerry Enterprise Server User Administration Tool. Using the BlackBerry Enterprise Server User Administration Tool, add a user account to the BlackBerry Enterprise Server. For instructions on how to perform this task, visit www.blackberry.com/go/serverdocs to read the BlackBerry Enterprise Server User Administration Tool Administration Guide. In the BlackBerry Administration Service, verify that the user account was added correctly and that you can perform all the tasks for managing the user account in the BlackBerry Administration Service. These tasks include adding the user account to a group, assigning an IT policy or a software configuration to the user account, and assigning a BlackBerry device to the user account. For instructions on how to perform these tasks, visit www.blackberry.com/go/serverdocs to read the BlackBerry Enterprise Server Administration Guide.

2. 3.

4.

Install the BlackBerry Analysis, Monitoring, and Troubleshooting Tools

You can download a setup application that you can use to install any of the BlackBerry Analysis, Monitoring, and Troubleshooting Tools. 1. 2. 3. 4. 5. In a browser, visit www.blackberry.com/support/downloads, and navigate to the Downloads area for the BlackBerry Enterprise Server Resource Kit. Download the latest installation package of the BlackBerry Analysis, Monitoring, and Troubleshooting Tools. Extract the contents of the installation package. Run the setup application. Complete the instructions on the screen.

Install BlackBerry Domain Search

BlackBerry Domain Search is packaged with the BlackBerry Analysis, Monitoring, and Troubleshooting Tools. 1. 2. Visit www.blackberry.com/support/downloads, and navigate to the Downloads area for the BlackBerry Enterprise Server Resource Kit. Download the latest installation package of the BlackBerry Analysis, Monitoring, and Troubleshooting Tools.

15

Installation Guide

Install BlackBerry Domain Search

3. 4. 5.

Extract the contents of the installation package. Run the setup application to install the installation files for BlackBerry Domain Search only. Browse to the installation files that you installed in step 4 and perform one of the following actions: If your organization uses Windows Server 2008, double-click the setup.exe file. If your organization uses any other operating system, double-click the blackberrysearch<version>.msi file.

In the setup application, click Next. In the Site drop-down list, click the web location that you want to use for BlackBerry Domain Search. In the Virtual directory field, type the name of the virutal directory using the following format: http:// <web_server_name>/<virtual_directory_name>. 9. In the Application Pool drop-down list, click the application pool that you want to use. 10. Click Next. 11. Click Next again. After you finish: In a browser, navigate to BlackBerry Domain Search using the virtual directory name that you specified.

6. 7. 8.

Configure BlackBerry Domain Search

Before you begin: Install BlackBerry Domain Search. Note the location of the web.config file. The web.config file is located in the bbsearch virtual directory folder. 1. 2. On the computer that hosts BlackBerry Domain Search, in a text editor, open the web.config file for BlackBerry Domain Search. To configure BlackBerry Domain Search to log you in automatically, complete the instructions that are included before the <realmConfig> section. You can configure automatic login using this method or you can configure single sign-on authentication for BlackBerry Domain Search after you complete the web.config file. In the <realmConfig> section, complete the instructions to specify the BlackBerry Administration Service instances that you want BlackBerry Domain Search to access. Note: If you want BlackBerry Domain Search to connect to a BlackBerry Domain that contains one or more BlackBerry Enterprise Server Express instances, you must specify the BlackBerry Administration Service port for the BlackBerry Enterprise Server Express instances. By default, the BlackBerry Administration Service for BlackBerry Enterprise Server Express uses port 3443. If you did not configure the automatic login option and you want to configure BlackBerry Domain Search to complete the Domain field automatically when you log in using Microsoft Active Directory authentication, in the <appSettings> section, complete the instructions. To configure BlackBerry Domain Search to limit the number of results that are retrieved from each BlackBerry Domain, in the <appSettings> section, complete the instructions. The default value is 500 results for each BlackBerry Domain. If you change this setting, there might be a performance impact on BlackBerry Domain Search and the computer. Verify that you have the appropriate system requirements before you change this setting.
16

3.

4.

5.

Installation Guide

Install BlackBerry Domain Search

6.

Save the web.config file.

It is a best practice to change the information in the <realmAuthConfig>, <realmConfig>, and <appSettings> sections of the web.config file only. If you change the information in the other sections, there might be a performance impact on BlackBerry Domain Search and the computer.

Example: Web.config file

This example shows a web.config file that was configured with the following settings: automatic login using Microsoft Active Directory authentication validation check for login credentials specifies three BlackBerry Domain instances returns a maximum of 450 results for each BlackBerry Domain <?xml version="1.0"?> <configuration> <configSections> <section name="realmConfig" type="Rim.Enterprise.Brk.RealmSearch.RealmSearchLib.RealmConfiguration, RealmSearchLib"/> </configSections> <realmAuthConfig authType="ActiveDirectory" username="besadmin" password="password" logOnDomain="Domain1" validate="true"/> <realmAuthConfig/> <realmConfig> <domains> <add name="Domain1" hostname="BAS1.company.net" port="443"/> <add name="Domain2" hostname="BAS2.company.net" port="443"/> <add name="Domain3" hostname="BAS3.company.net" port="8443"/> </domains> </realmConfig> <appSettings> <add key="defaultLoginDomain" value="Domain"/> <add key="maxResultsPerDomain" value="450"/> </appSettings> </configuration>

17

Installation Guide

Install BlackBerry Domain Search

Configure single sign-on authentication for BlackBerry Domain Search

Single sign-on authentication allows you to log in to BlackBerry Domain Search using a specific administration account without having to type a user name and password. You must configure BlackBerry Domain Search to log in using the same administration account that you configured the BlackBerry Administration Service to use for single sign-on authentication. You can configure single sign-on authentication for BlackBerry Domain Search if your organization uses Microsoft IIS 6.0 or later. Before you begin: Install and configure BlackBerry Domain Search. Note the location of the web.config file. The web.config file is located in the bbsearch virtual directory folder (for example, <drive>:\Inetpub\wwwroot\bbsearch.) 1. 2. 3. 4. On the computer that hosts BlackBerry Domain Search, open the Microsoft IIS Manager. Create a new application pool. Set the identity of the application pool to the user account that you configured the BlackBerry Administration Service to use for single sign-on authentication. In the virtual directory properties for the bbsearch web site, select the application pool that you created in step 2. In the authentication and access control section of the directory security properties for the bbsearch web site, configure the following settings: Do not permit anonymous access. Permit Integrated Windows authentication. Save the changes that you made to the bbsearch web site. Verify that the single sign-on user account is a member of the IIS_WPG group. Verify that the IIS_WPG group has write and modify permissions for the bbsearch virtual directory folder. In the bbsearch virtual directory folder, navigate to the web.config file. In a text editor, open the web.config file. In the <realmAuthConfig> section, type the following: <realmAuthConfig useBasSso="true"/>. Save the web.config file.

5. 6. 7. 8. 9. 10. 11.

18

Installation Guide

Upgrading from a previous version of a BlackBerry Enterprise Server Resource Kit tool

Upgrading from a previous version of a BlackBerry Enterprise Server Resource Kit tool
Upgrading from a previous version of the BlackBerry Enterprise Server User Administration Tool

If the BlackBerry Enterprise Server User Administration Tool is already installed in your environment, you do not have to remove it before you install a new version of the tool. If you want to upgrade from BlackBerry Enterprise Server User Administration Tool 5.0 to BlackBerry Enterprise Server User Administration Tool 5.0 SP2 or later, the installation process does not overwrite the 5.0 version of the tool. You must install BlackBerry Enterprise Server User Administration Tool 5.0 SP2 or later separately. If you want to upgrade from BlackBerry Enterprise Server User Administration Tool 5.0 SP1 to BlackBerry Enterprise Server User Administration Tool 5.0 SP2 or later, the installation process overwrites the 5.0 SP1 version of the tool and preserves user information such as registry values and exe.config files. Patch upgrades that are version 5.0 SP2 or later overwrite 5.0 SP1 and later versions of the BlackBerry Enterprise Server User Administration Tool.

Upgrading from a previous version of the BlackBerry Analysis, Monitoring, and Troubleshooting Tools
If the BlackBerry Analysis, Monitoring, and Troubleshooting Tools are already installed in your environment, you do not have to remove the tools before you install new versions of the tools. If you want to upgrade a tool from version 5.0 to version 5.0 SP2 or later, the installation process does not overwrite previous versions of the tool (except for the BlackBerry System Log Monitoring and Reporting Tool and the BlackBerry Message Receipt Confirmation Tool). You must install the tool separately. If you want to upgrade a tool from version 5.0 SP1 to version 5.0 SP2 or later, the installation process overwrites the 5.0 SP1 version of the tool and preserves user information such as registry values and exe.config files. Patch upgrades that are version 5.0 SP2 or later overwrite 5.0 SP1 and later versions of the tool.

19

Installation Guide

Troubleshooting

Troubleshooting

The BlackBerry Domain Search setup application does not complete successfully
Possible cause
ASP.NET 2.0 might have been installed before Microsoft IIS 5.0 or later was installed. As a result, ASP.NET might not be registered correctly and might not be present in the IIS web service extensions list.

Possible solution
Run a repair installation of ASP.NET. Run the BlackBerry Domain Search setup application again.

Check the status of the BlackBerry Enterprise Server User Administration Tool
You can use this command to verify that there is a valid connection between the BlackBerry Administration Service and the BlackBerry Enterprise Server User Administration Tool and that the credentials are valid. 1. To open the command window for the BlackBerry Enterprise Server User Administration Tool, on the computer that hosts the tool, on the taskbar, click Start > Programs > BlackBerry Enterprise Server Resource Kit > BlackBerry Enterprise Server User Administration Tool Client > BlackBerry Enterprise Server User Administration Tool. Type besuseradminclient -n <server_name> <credentials> -status.

2.

Example besuseradminclient -username admin -password password -status Example output BlackBerry(R) Enterprise Server User Administration Tool Version 5.0.2.6 Copyright (c) Research In Motion, Ltd. 2009-2010. All rights reserved. Log files being written to C:\Users\administrator\AppData\Roaming\Research In Mo tion\BlackBerry User Administration Tool Client\Logs. (05/18 15:51:27) Running command... (05/18 15:51:28) ...Done (05/18 15:51:28) Command Results: Property,Value BAS Version,5.0.2.14 BAA Version,5.0.2.6

20

Installation Guide

Removing a BlackBerry Enterprise Server Resource Kit tool

When I check the status of the BlackBerry Enterprise Server User Administration Tool I receive an "Error while initializing the logs" error message
When you use the -status parameter to check the status of the BlackBerry Enterprise Server User Administration Tool, the "Error while initializing the logs" error message appears. This error message indicates the location where the BlackBerry Enterprise Server User Administration Tool tried to write the log files, and a stack trace.

Possible cause
If you are using Windows Server 2008, the UAC security infrastructure might prevent the BlackBerry Enterprise Server User Administration Tool from opening and writing information to log files.

Possible solution
Perform one of the following actions: The error message indicates the folder that the tool tried to write the log files to. If the folder does not exist, create the folder. Configure security permissions on the folder that permit the user account that you use to run the tool to write log files to the folder. Open the BESUserAdminClient.exe.config file in a text editor and change the LogFolder value to a folder that the user account that you use to run the tool has permissions to write to.

Removing a BlackBerry Enterprise Server Resource Kit tool

Remove the BlackBerry Enterprise Server User Administration Tool
1. On the computer that hosts the BlackBerry Enterprise Server User Administration Tool, on the taskbar, click Start > Program Files > BlackBerry Enterprise Server Resource Kit > BlackBerry Enterprise Server User Administration Tool Client. Click Uninstall. Complete the instructions on the screen.

2. 3.

Remove the BlackBerry Analysis, Monitoring, and Troubleshooting Tools

1. On the computer that hosts the BlackBerry Analysis, Monitoring, and Troubleshooting Tools, on the taskbar, click Program Files > BlackBerry Enterprise Server Resource Kit > BlackBerry Analysis Monitoring and Troubleshooting Tools > Uninstall or Modify Installation. Complete the instructions on the screen.

2.

21

Installation Guide

Removing a BlackBerry Enterprise Server Resource Kit tool

Remove BlackBerry Domain Search

1. 2. 3. 4. On the computer that hosts BlackBerry Domain Search, on the taskbar, click Start > Settings > Control Panel > Add/Remove Programs. Click BlackBerry Search. Click Remove. Click Yes.

22

Installation Guide

Glossary

Glossary

BlackBerry Enterprise Server databases The BlackBerry Enterprise Server databases are the BlackBerry Configuration Database and the BlackBerry Monitoring Service database. BlackBerry Domain A BlackBerry Domain consists of the BlackBerry Configuration Database with its users and any BlackBerry Enterprise Server instances that connect to it. BlackBerry MDS BlackBerry Mobile Data System CDO Collaboration Data Object .csv comma-separated values DNS Domain Name System MAPI Messaging Application Programming Interface messaging server A messaging server sends and processes messages and provides collaboration services, such as updating and communicating calendar and address book information.

23

Installation Guide

Provide feedback

Provide feedback
To provide feedback on this deliverable, visit www.blackberry.com/docsfeedback.

24

Installation Guide

Legal notice

Legal notice

2011 Research In Motion Limited. All rights reserved. BlackBerry, RIM, Research In Motion, and related trademarks, names, and logos are the property of Research In Motion Limited and are registered and/or used in the U.S. and countries around the world. IBM, Domino, and Lotus are trademarks of International Business Machines Corporation. Java and JRE are trademarks of Oracle America, Inc. Microsoft, Internet Explorer, SQL Server, Windows, and Windows Server are trademarks of Microsoft Corporation. All other trademarks are the property of their respective owners. This documentation including all documentation incorporated by reference herein such as documentation provided or made available at www.blackberry.com/go/docs is provided or made accessible "AS IS" and "AS AVAILABLE" and without condition, endorsement, guarantee, representation, or warranty of any kind by Research In Motion Limited and its affiliated companies ("RIM") and RIM assumes no responsibility for any typographical, technical, or other inaccuracies, errors, or omissions in this documentation. In order to protect RIM proprietary and confidential information and/or trade secrets, this documentation may describe some aspects of RIM technology in generalized terms. RIM reserves the right to periodically change information that is contained in this documentation; however, RIM makes no commitment to provide any such changes, updates, enhancements, or other additions to this documentation to you in a timely manner or at all. This documentation might contain references to third-party sources of information, hardware or software, products or services including components and content such as content protected by copyright and/or third-party web sites (collectively the "Third Party Products and Services"). RIM does not control, and is not responsible for, any Third Party Products and Services including, without limitation the content, accuracy, copyright compliance, compatibility, performance, trustworthiness, legality, decency, links, or any other aspect of Third Party Products and Services. The inclusion of a reference to Third Party Products and Services in this documentation does not imply endorsement by RIM of the Third Party Products and Services or the third party in any way. EXCEPT TO THE EXTENT SPECIFICALLY PROHIBITED BY APPLICABLE LAW IN YOUR JURISDICTION, ALL CONDITIONS, ENDORSEMENTS, GUARANTEES, REPRESENTATIONS, OR WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION, ANY CONDITIONS, ENDORSEMENTS, GUARANTEES, REPRESENTATIONS OR WARRANTIES OF DURABILITY, FITNESS FOR A PARTICULAR PURPOSE OR USE, MERCHANTABILITY, MERCHANTABLE QUALITY, NON-INFRINGEMENT, SATISFACTORY QUALITY, OR TITLE, OR ARISING FROM A STATUTE OR CUSTOM OR A COURSE OF DEALING OR USAGE OF TRADE, OR RELATED TO THE DOCUMENTATION OR ITS USE, OR PERFORMANCE OR NON-PERFORMANCE OF ANY SOFTWARE, HARDWARE, SERVICE, OR ANY THIRD PARTY PRODUCTS AND SERVICES REFERENCED HEREIN, ARE HEREBY EXCLUDED. YOU MAY ALSO HAVE OTHER RIGHTS THAT VARY BY STATE OR PROVINCE. SOME JURISDICTIONS MAY NOT ALLOW THE EXCLUSION OR LIMITATION OF IMPLIED WARRANTIES AND CONDITIONS. TO THE EXTENT PERMITTED BY LAW, ANY IMPLIED WARRANTIES OR CONDITIONS RELATING TO THE DOCUMENTATION TO THE EXTENT THEY CANNOT BE EXCLUDED AS SET OUT ABOVE, BUT CAN BE LIMITED, ARE HEREBY LIMITED TO NINETY (90) DAYS FROM THE DATE YOU FIRST ACQUIRED THE DOCUMENTATION OR THE ITEM THAT IS THE SUBJECT OF THE CLAIM. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW IN YOUR JURISDICTION, IN NO EVENT SHALL RIM BE LIABLE FOR ANY TYPE OF DAMAGES RELATED TO THIS DOCUMENTATION OR ITS USE, OR PERFORMANCE OR NONPERFORMANCE OF ANY SOFTWARE, HARDWARE, SERVICE, OR ANY THIRD PARTY PRODUCTS AND SERVICES

25

Installation Guide

Legal notice

REFERENCED HEREIN INCLUDING WITHOUT LIMITATION ANY OF THE FOLLOWING DAMAGES: DIRECT, CONSEQUENTIAL, EXEMPLARY, INCIDENTAL, INDIRECT, SPECIAL, PUNITIVE, OR AGGRAVATED DAMAGES, DAMAGES FOR LOSS OF PROFITS OR REVENUES, FAILURE TO REALIZE ANY EXPECTED SAVINGS, BUSINESS INTERRUPTION, LOSS OF BUSINESS INFORMATION, LOSS OF BUSINESS OPPORTUNITY, OR CORRUPTION OR LOSS OF DATA, FAILURES TO TRANSMIT OR RECEIVE ANY DATA, PROBLEMS ASSOCIATED WITH ANY APPLICATIONS USED IN CONJUNCTION WITH RIM PRODUCTS OR SERVICES, DOWNTIME COSTS, LOSS OF THE USE OF RIM PRODUCTS OR SERVICES OR ANY PORTION THEREOF OR OF ANY AIRTIME SERVICES, COST OF SUBSTITUTE GOODS, COSTS OF COVER, FACILITIES OR SERVICES, COST OF CAPITAL, OR OTHER SIMILAR PECUNIARY LOSSES, WHETHER OR NOT SUCH DAMAGES WERE FORESEEN OR UNFORESEEN, AND EVEN IF RIM HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW IN YOUR JURISDICTION, RIM SHALL HAVE NO OTHER OBLIGATION, DUTY, OR LIABILITY WHATSOEVER IN CONTRACT, TORT, OR OTHERWISE TO YOU INCLUDING ANY LIABILITY FOR NEGLIGENCE OR STRICT LIABILITY. THE LIMITATIONS, EXCLUSIONS, AND DISCLAIMERS HEREIN SHALL APPLY: (A) IRRESPECTIVE OF THE NATURE OF THE CAUSE OF ACTION, DEMAND, OR ACTION BY YOU INCLUDING BUT NOT LIMITED TO BREACH OF CONTRACT, NEGLIGENCE, TORT, STRICT LIABILITY OR ANY OTHER LEGAL THEORY AND SHALL SURVIVE A FUNDAMENTAL BREACH OR BREACHES OR THE FAILURE OF THE ESSENTIAL PURPOSE OF THIS AGREEMENT OR OF ANY REMEDY CONTAINED HEREIN; AND (B) TO RIM AND ITS AFFILIATED COMPANIES, THEIR SUCCESSORS, ASSIGNS, AGENTS, SUPPLIERS (INCLUDING AIRTIME SERVICE PROVIDERS), AUTHORIZED RIM DISTRIBUTORS (ALSO INCLUDING AIRTIME SERVICE PROVIDERS) AND THEIR RESPECTIVE DIRECTORS, EMPLOYEES, AND INDEPENDENT CONTRACTORS. IN ADDITION TO THE LIMITATIONS AND EXCLUSIONS SET OUT ABOVE, IN NO EVENT SHALL ANY DIRECTOR, EMPLOYEE, AGENT, DISTRIBUTOR, SUPPLIER, INDEPENDENT CONTRACTOR OF RIM OR ANY AFFILIATES OF RIM HAVE ANY LIABILITY ARISING FROM OR RELATED TO THE DOCUMENTATION. Prior to subscribing for, installing, or using any Third Party Products and Services, it is your responsibility to ensure that your airtime service provider has agreed to support all of their features. Some airtime service providers might not offer Internet browsing functionality with a subscription to the BlackBerry Internet Service. Check with your service provider for availability, roaming arrangements, service plans and features. Installation or use of Third Party Products and Services with RIM's products and services may require one or more patent, trademark, copyright, or other licenses in order to avoid infringement or violation of third party rights. You are solely responsible for determining whether to use Third Party Products and Services and if any third party licenses are required to do so. If required you are responsible for acquiring them. You should not install or use Third Party Products and Services until all necessary licenses have been acquired. Any Third Party Products and Services that are provided with RIM's products and services are provided as a convenience to you and are provided "AS IS" with no express or implied conditions, endorsements, guarantees, representations, or warranties of any kind by RIM and RIM assumes no liability whatsoever, in relation thereto. Your use of Third Party Products and Services shall be governed by and subject to you agreeing to the terms of separate licenses and other agreements applicable thereto with third parties, except to the extent expressly covered by a license or other agreement with RIM. Certain features outlined in this documentation require a minimum version of BlackBerry Enterprise Server, BlackBerry Desktop Software, and/or BlackBerry Device Software.

26

Installation Guide

Legal notice

The terms of use of any RIM product or service are set out in a separate license or other agreement with RIM applicable thereto. NOTHING IN THIS DOCUMENTATION IS INTENDED TO SUPERSEDE ANY EXPRESS WRITTEN AGREEMENTS OR WARRANTIES PROVIDED BY RIM FOR PORTIONS OF ANY RIM PRODUCT OR SERVICE OTHER THAN THIS DOCUMENTATION. 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

27