blackberry enterprise server resource kit installation guide 1322296 0124032826 001 5.0.3 us

BlackBerry Enterprise ServerResource KitVersion: 5.0 | Service Pack: 3

Installation Guide

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

Contents1 Overview........................................................................................................................................................... 3

Options for downloading the BlackBerry Enterprise Server Resource Kit........................................................ 3BlackBerry Enterprise Server User Administration Tool................................................................................... 3BlackBerry Analysis, Monitoring, and Troubleshooting Tools.......................................................................... 4Available BlackBerry Analysis, Monitoring, and Troubleshooting Tools........................................................... 4

2 Requirements................................................................................................................................................... 6System requirements: BlackBerry Enterprise Server User Administration Tool............................................... 6System requirements: BlackBerry Analysis, Monitoring, and Troubleshooting Tools...................................... 7System requirements: BlackBerry Application Reporting Tool......................................................................... 7System requirements: BlackBerry Domain Administration History Reporting Tool......................................... 8System requirements: BlackBerry Message Receipt Confirmation Tool.......................................................... 8System requirements: BlackBerry Domain Search........................................................................................... 9System requirements: BlackBerry System Log Monitoring and Reporting Tool............................................... 10System requirements: Log analysis tools.......................................................................................................... 11System requirements: BlackBerry Enterprise Server Log Monitoring Tool...................................................... 12

3 Installing a BlackBerry Enterprise Server Resource Kit tool.............................................................................. 13Installation files................................................................................................................................................. 13Configuring the BlackBerry Enterprise Server User Administration Tool and the BlackBerry Analysis,Monitoring, and Troubleshooting Tools to use UAC-compliant file paths....................................................... 14Install the BlackBerry Enterprise Server User Administration Tool.................................................................. 14Verify that the BlackBerry Enterprise Server User Administration Tool was installed correctly...................... 15Install the BlackBerry Analysis, Monitoring, and Troubleshooting Tools......................................................... 15Install BlackBerry Domain Search..................................................................................................................... 15

Configure BlackBerry Domain Search........................................................................................................ 16Configure single sign-on authentication for BlackBerry Domain Search................................................... 18

4 Upgrading from a previous version of a BlackBerry Enterprise Server Resource Kit tool................................ 19Upgrading from a previous version of the BlackBerry Enterprise Server User Administration Tool................ 19Upgrading from a previous version of the BlackBerry Analysis, Monitoring, and Troubleshooting Tools....... 19

5 Troubleshooting................................................................................................................................................ 20The BlackBerry Domain Search setup application does not complete successfully......................................... 20Check the status of the BlackBerry Enterprise Server User Administration Tool............................................. 20

When I check the status of the BlackBerry Enterprise Server User Administration Tool I receive an"Error while initializing the logs" error message....................................................................................... 21

Removing a BlackBerry Enterprise Server Resource Kit tool............................................................................ 21

Remove the BlackBerry Enterprise Server User Administration Tool........................................................ 21Remove the BlackBerry Analysis, Monitoring, and Troubleshooting Tools............................................... 21Remove BlackBerry Domain Search........................................................................................................... 22

6 Glossary............................................................................................................................................................ 23

7 Provide feedback.............................................................................................................................................. 24

8 Legal notice....................................................................................................................................................... 25

Overview 1The BlackBerry® Enterprise Server Resource Kit is a collection of tools that can help you extend your ability to manageand monitor the BlackBerry® Enterprise Solution. You can download the BlackBerry Enterprise Server Resource Kitfrom www.blackberry.com/support/downloads.

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

Options for downloading the BlackBerry Enterprise ServerResource KitYou 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 ToolYou 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 useraccount configurations.

You can run the BlackBerry Enterprise Server User Administration Tool from a command prompt to performBlackBerry Enterprise Server administration tasks or to gather management and monitoring information.

The BlackBerry Enterprise Server User Administration Tool connects to the BlackBerry Administration Service toretrieve information from and store information in the BlackBerry Configuration Database. If the BlackBerryEnterprise Server User Administration Tool is version 5.0 SP1 or later, you can use the BlackBerry Enterprise ServerUser 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 thatare dependent on the BlackBerry Enterprise Server version, not the version of the BlackBerry Enterprise Server UserAdministration Tool. If new server options are introduced in a new version of the BlackBerry Enterprise Server, youare not required to update the BlackBerry Enterprise Server User Administration Tool to the same version as theBlackBerry Enterprise Server to use the server options. Client options are commands that are dependent on theversion of the BlackBerry Enterprise Server User Administration Tool. New client options are available only if youupdate 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 theBlackBerry Enterprise Server User Administration Tool.

Installation Guide Overview

3

http://www.blackberry.com/support/downloads

BlackBerry Analysis, Monitoring, and TroubleshootingToolsYou 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, andTroubleshooting Tools

Name Description

BlackBerry® Application Reporting Tool(HHAppReport.exe)

This tool lists the applications that are installed in the BlackBerry Domain.You can use this tool to audit the BlackBerry Domain and find unapprovedapplications.

BlackBerry Domain AdministrationHistory Reporting Tool(AdminHistory.exe)

This tool reads the ServerConfigHistory table in the BlackBerryConfiguration Database and displays configuration changes, such asnewly added user accounts, in a .csv file. The tool records the date andtime of each change and the name of the administrator who made thechange.

BlackBerry IT Policy Import and ExportTool (ITPolicyImportExport.exe)

This tool exports IT policy information from a BlackBerry ConfigurationDatabase. The global IT policy rules are a specific set of IT policy rulesthat apply to all user accounts on a BlackBerry® Enterprise Server.

BlackBerry Message ReceiptConfirmation Tool(MessageConfirmService.exe)

This tool verifies that the BlackBerry Enterprise Server is sendingmessages to BlackBerry devices. At an interval that you specify, theBlackBerry Message Receipt Confirmation Tool sends a message to thespecified user account, monitors the status of that message, and checksfor confirmation that the BlackBerry device receives the message.

BlackBerry System Log Monitoring andReporting Tool (BESSysLog.exe)

This tool monitors the BlackBerry Enterprise Server log events as theyare written to the log file. You can specify which BlackBerry EnterpriseServer components to monitor, the events that the tool tracks, and thetypes of notifications and reports that the tool sends to administrators.

BlackBerry Enterprise Server LogMonitoring Tool (LogMonitor.exe)

This tool monitors the text that is written to the end of a text file, typicallya log file. You can specify events by typing numeric event IDs or textstrings at the command prompt or by using an input file. You can specifyactions that the tool performs after it finds a value that meets thespecified criteria.

BlackBerry System Requirements Tool(BBCheck.exe)

This tool provides a set of tests that can help you determine whether youcan successfully run a BlackBerry Enterprise Server component on acomputer.

Installation Guide BlackBerry Analysis, Monitoring, and Troubleshooting Tools

4

Name Description

BlackBerry Domain Search This web application permits you to search for user accounts across morethan one BlackBerry Domain. You can search for administrator accountsand user accounts using various criteria, including user name, user ID, ITpolicy, PIN, email address, BlackBerry Enterprise Server instance, andgroup name. The search results provide basic information for theaccounts that match the search criteria that you specify. You can clickthe display name for a user account to view detailed information for theuser account.

Installation Guide Available BlackBerry Analysis, Monitoring, and Troubleshooting Tools

5

Requirements 2

System requirements: BlackBerry Enterprise Server UserAdministration Tool

Item Requirement

operating system 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

memory minimum 2 GB of memorybrowser Windows® Internet Explorer® version 6.0 or version 7.0 with language

preferences configured to display encoded web pagesBlackBerry® AdministrationService

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 laterRunning the BlackBerryEnterprise Server UserAdministration Tool from aremote computer

In the BlackBerry Enterprise Server User Administration Tool 5.0 SP2 and later,running the BlackBerry Enterprise Server User Administration Tool from a remotecomputer using the UNC path is not supported. If you did not run the setupapplication for the tool on the computer, the computer might not have thesecurity requirements to run the tool.

Installation Guide Requirements

6

System requirements: BlackBerry Analysis, Monitoring, andTroubleshooting Tools

Item Requirement



BlackBerry® Enterprise Server You must install some of the BlackBerry® Analysis, Monitoring, andTroubleshooting Tools on the same computer as a BlackBerry® Enterprise Servercomponent, as specified in the requirements for each tool. Running a tool canaffect the performance of the BlackBerry Enterprise Server component.

System requirements: BlackBerry Application ReportingTool

Item Requirement

database management systemfor the BlackBerryConfiguration Database

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

Installation Guide System requirements: BlackBerry Analysis, Monitoring, and Troubleshooting Tools

7

System requirements: BlackBerry Domain AdministrationHistory Reporting Tool

Item Requirement

BlackBerry® Enterprise Server You must run the BlackBerry Domain Administration History Reporting Tool on acomputer that is separate from the BlackBerry Enterprise Server components.

database management systemfor the BlackBerryConfiguration Database

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

BlackBerry ConfigurationDatabase

connection from the BlackBerry Configuration Database to the BlackBerryDomain Administration History Reporting Tool

System requirements: BlackBerry Message ReceiptConfirmation Tool

Item Requirement

BlackBerry® Enterprise Server You must run the BlackBerry Message Receipt Confirmation Tool on a computerthat is separate from the computers that host the BlackBerry Enterprise Servercomponents.

BlackBerry Message ReceiptConfirmation Tool service andclient

You must run the BlackBerry Message Receipt Confirmation Tool service(messageconfirmservice.exe) and the BlackBerry Message Receipt ConfirmationTool client (messageconfirmconfig.exe) on the same computer.

Microsoft® Exchange systemtools

Before you install and run the BlackBerry Message Receipt Confirmation Tool,you must perform the following tasks:

1. On the computer that you want to host the tool, download and installMicrosoft® Exchange Server MAPI client and CDO 1.2.1.For information about the versions of the Microsoft Exchange Server MAPIclient and CDO 1.2.1 that are supported by the BlackBerry Enterprise Server,visit www.blackberry.com/go/compatibility to see the BlackBerry EnterpriseServer compatibility matrix.

Installation Guide System requirements: BlackBerry Domain Administration History Reporting Tool

8

http://na.blackberry.com/eng/support/software/server_compatibility.jsp

Item Requirement

2. On the computer that hosts the BlackBerry Enterprise Server, copy theBESProfile.exe file located at <drive>:\Program Files\Research In Motion\BlackBerry Enterprise Server to the computer that you want to host theBlackBerry Message Receipt Confirmation Tool.

3. On the computer that you want to host the tool, open a command promptwindow and type cd <drive>:\\<file_path> to navigate to the folder thatcontains the BESProfile.exe file.

4. In the command prompt window, type the following command:besprofile.exe -s -p <profile_name>.

5. Follow the instructions on the screen to create a MAPI profile.

System requirements: BlackBerry Domain Search

Item Requirement

web server Microsoft® IIS 5.0 or later for Windows Server® that is configured with ASP.NET2.0. If you want to configure single sign-on authentication for BlackBerry DomainSearch, 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 versionof ASP.NET. If you are running a 32-bit version of ASP.NET with a 64-bit versionof Microsoft IIS, you must configure Microsoft IIS to run 32-bit applications. Formore 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.

browser 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 zoneaccess to BlackBerry® Domaininstances

The web server that hosts BlackBerry Domain Search must be able to access theBlackBerry Domain instances that you want to search.

BlackBerry® Enterprise Servercompatibility

BlackBerry Enterprise Server 5.0 or later.

If your organization uses BlackBerry Enterprise Server 5.0, you must downloadand install the BlackBerry® Administration API for the BlackBerry EnterpriseServer. To download the BlackBerry Administration API, visitwww.blackberry.com/support/downloads.

For BlackBerry Enterprise Server 5.0 SP1 and later, the BlackBerry AdministrationAPI is installed when you install the BlackBerry Enterprise Server, so you do notneed to download and install it separately.

Installation Guide System requirements: BlackBerry Domain Search

9

http://na.blackberry.com/eng/support/downloads/

Item Requirement

BlackBerry AdministrationService compatibility

Installing BlackBerry Domain Search on a computer that hosts a BlackBerryAdministration Service does not cause a port conflict. By default, BlackBerryDomain Search listens on port 80 and the BlackBerry Administration Servicelistens on port 443.

BlackBerry AdministrationService permissions

The administrator account that you use to log in to BlackBerry Domain Searchmust have the Junior Helpdesk administrative role or an administrative role withless restrictive permissions than the default Junior Helpdesk role. If yourorganization's environment includes BlackBerry Enterprise Server instances thatare earlier that BlackBerry® Enterprise Server 5.0 SP2, to search for user accountsby BlackBerry Enterprise Server instance, administrator accounts require theView an instance permission.

BlackBerry® Browser support You can access BlackBerry Domain Search from the BlackBerry Browser.supported environments 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 laterunsupported environments 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

System requirements: BlackBerry System Log Monitoringand Reporting Tool

Item Requirement

BlackBerry® Enterprise Server You must run the BlackBerry System Log Monitoring and Reporting Tool on acomputer that is separate from the computer or computers that host theBlackBerry Enterprise Server components.

multiple BlackBerry EnterpriseServer platforms (optional)

In an environment that includes more than one BlackBerry Enterprise Serverplatform, 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 computerWindows® service You must run the BlackBerry System Log Monitoring and Reporting Tool as a

Windows service.Windows Server® 2008 (64-bit)

If your organization uses Windows Server 2008 (64-bit), you must create a reverseDNS lookup record so that the BlackBerry System Log Monitoring and ReportingTool can record the appropriate server names in the log files that it creates.

Installation Guide System requirements: BlackBerry System Log Monitoring and Reporting Tool

10

Item Requirement

Perform the following actions:

1. In the advanced TCP/IP settings for the network connection that the tooluses, select Use this connection's DNS suffix in DNS registration.

2. At the command prompt, using an account with administrator permissions,type ipconfig /registerdns and press ENTER.

version compatibility BESSysLog.exe and BESSysLogConfig.exe must be the same version and must beinstalled in the same folder on the same computer.

logging level You must set the logging level for the log files for the BlackBerry Dispatcher andthe BlackBerry Messaging Agent to a minimum level of 3.

System requirements: Log analysis tools

Item Requirement



memory minimum 2 GB of memorydisk space 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.

BlackBerry Enterprise Server You must run the log analysis tools on a computer that is separate from thecomputers that host the BlackBerry Enterprise Server components.

BlackBerry Enterprise Serverlog files

You must store or copy the log files for the BlackBerry Enterprise Servercomponents that you plan to analyze on the same computer as the log analysistools.

version compatibility The log analysis tools and the BlackBerry Enterprise Server components must bethe same version.

Installation Guide System requirements: Log analysis tools

11

System requirements: BlackBerry Enterprise Server LogMonitoring Tool

Item Requirement

BlackBerry® Enterprise Server You must run the BlackBerry Enterprise Server Log Monitoring Tool on thecomputer that hosts the BlackBerry Enterprise Server component.

log files The BlackBerry Enterprise Server Log Monitoring Tool can monitor only one logfile at a time.

Installation Guide System requirements: BlackBerry Enterprise Server Log Monitoring Tool

12

Installing a BlackBerry Enterprise ServerResource Kit tool

3

Installation files

Tool Installation file name Environment

BlackBerry® Enterprise Server UserAdministration Tool

brk-besuseradminclient<version>.msi All

BlackBerry Enterprise Transporter brk-bbenterprisetransporter<version>.msi

All

BlackBerry Application Reporting Tool brk-amt<version>.msi AllBlackBerry Domain Administration HistoryReporting Tool

brk-amt<version>.msi All

BlackBerry IT Policy Import and Export Tool brk-amt<version>.msi AllBlackBerry Message Receipt ConfirmationTool


BlackBerry System Log Monitoring andReporting Tool


BlackBerry System Requirements Tool brk-amt<version>.msi AllBlackBerry Domain Search blackberrysearch<version>.msi (must

run brk-amt<version>.msi)Microsoft® Exchange andIBM® Lotus® Domino®

BlackBerry® EnterpriseServer Express

Log analysis toolsBlackBerry Delayed Notifications MonitoringTool

brk-amt<version>.msi Microsoft Exchange only

BlackBerry Enterprise Server Log MonitoringTool


BlackBerry Historical Statistics Tool brk-amt<version>.msi AllBlackBerry MAPI and CDO Error MonitoringTool

brk-amt<version>.msi Microsoft Exchange only

BlackBerry MDS Services Data MonitoringTool


BlackBerry Message Flow Reporting Tool brk-amt<version>.msi AllBlackBerry Message Pending Delivery Tool brk-amt<version>.msi AllBlackBerry Thread Analyzer Tool brk-amt<version>.msi AllBlackBerry Usage Monitoring Tool brk-amt<version>.msi AllBlackBerry User Activity Reporting Tool brk-amt<version>.msi Microsoft Exchange only

Installation Guide Installing a BlackBerry Enterprise Server Resource Kit tool

13

Configuring the BlackBerry Enterprise Server UserAdministration Tool and the BlackBerry Analysis,Monitoring, and Troubleshooting Tools to use UAC-compliant file pathsIf 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 specifywhether you want the tool to use a UAC-compliant file path for configuration files, input files, output files, and logfiles. The setup application creates a subfolder for the files in the application data folder for the current user (forexample, <drive>:\Users\<user_name>\AppData\Roaming\Research In Motion\AMT\ or <drive>:\Documents andSettings\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_uacsubparameters 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 canuse the -no_uac subparameter to write output files and log files to a file path that is relative to the current workingdirectory (for example, <drive>:\Program Files\Research In Motion\BlackBerry Enterprise Server Resource Kit\BlackBerry AMT Tools).

Install the BlackBerry Enterprise Server User AdministrationTool1. On the computer where you plan to install the BlackBerry Enterprise Server User Administration Tool, create a

folder to store the installation files.

2. In a browser, visit www.blackberry.com/support/downloads, and navigate to the Downloads area for theBlackBerry® Enterprise Server Resource Kit.

3. Download the installation package for the version of the BlackBerry Enterprise Server User Administration Toolthat is compatible with your organization's version of the BlackBerry® Enterprise Server.

4. Extract the contents of the installation package to the folder you created.

5. Double-click the .msi file for the tool.

6. 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.

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

14


Verify that the BlackBerry Enterprise Server UserAdministration Tool was installed correctlyBefore you begin: Verify that you have the required permissions to manage users in the BlackBerry® AdministrationService.

1. On the computer that hosts the BlackBerry Enterprise Server User Administration Tool, on the taskbar, clickStart > All Programs > BlackBerry Enterprise Server Resource Kit > BlackBerry Enterprise Server UserAdministration Tool.

2. Click BlackBerry Enterprise Server User Administration Tool.

3. 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 BlackBerryEnterprise Server User Administration Tool Administration Guide.

4. In the BlackBerry Administration Service, verify that the user account was added correctly and that you canperform all the tasks for managing the user account in the BlackBerry Administration Service. These tasks includeadding the user account to a group, assigning an IT policy or a software configuration to the user account, andassigning a BlackBerry device to the user account.For instructions on how to perform these tasks, visit www.blackberry.com/go/serverdocs to read the BlackBerryEnterprise Server Administration Guide.

Install the BlackBerry Analysis, Monitoring, andTroubleshooting ToolsYou can download a setup application that you can use to install any of the BlackBerry Analysis, Monitoring, andTroubleshooting Tools.

1. In a browser, visit www.blackberry.com/support/downloads, and navigate to the Downloads area for theBlackBerry Enterprise Server Resource Kit.

2. Download the latest installation package of the BlackBerry Analysis, Monitoring, and Troubleshooting Tools.

3. Extract the contents of the installation package.

4. Run the setup application.


Install BlackBerry Domain SearchBlackBerry® Domain Search is packaged with the BlackBerry Analysis, Monitoring, and Troubleshooting Tools.

1. Visit www.blackberry.com/support/downloads, and navigate to the Downloads area for the BlackBerryEnterprise Server Resource Kit.

2. Download the latest installation package of the BlackBerry Analysis, Monitoring, and Troubleshooting Tools.

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

15

http://docs.blackberry.com/en/admin/?userType=2

http://docs.blackberry.com/en/admin/?userType=2



3. Extract the contents of the installation package.

4. Run the setup application to install the installation files for BlackBerry Domain Search only.

5. 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.

6. In the setup application, click Next.

7. In the Site drop-down list, click the web location that you want to use for BlackBerry Domain Search.

8. 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 youspecified.

Configure BlackBerry Domain SearchBefore you begin: Install BlackBerry® Domain Search. Note the location of the web.config file. The web.config file islocated in the bbsearch virtual directory folder.

1. On the computer that hosts BlackBerry Domain Search, in a text editor, open the web.config file for BlackBerryDomain Search.

2. To configure BlackBerry Domain Search to log you in automatically, complete the instructions that are includedbefore the <realmConfig> section.You can configure automatic login using this method or you can configure single sign-on authentication forBlackBerry Domain Search after you complete the web.config file.

3. In the <realmConfig> section, complete the instructions to specify the BlackBerry Administration Serviceinstances 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 moreBlackBerry® Enterprise Server Express instances, you must specify the BlackBerry Administration Service portfor the BlackBerry Enterprise Server Express instances. By default, the BlackBerry Administration Service forBlackBerry Enterprise Server Express uses port 3443.

4. If you did not configure the automatic login option and you want to configure BlackBerry Domain Search tocomplete the Domain field automatically when you log in using Microsoft® Active Directory® authentication, inthe <appSettings> section, complete the instructions.

5. To configure BlackBerry Domain Search to limit the number of results that are retrieved from each BlackBerryDomain, 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 aperformance impact on BlackBerry Domain Search and the computer. Verify that you have the appropriatesystem requirements before you change this setting.

Installation Guide Install BlackBerry Domain Search

16

6. Save the web.config file.

It is a best practice to change the information in the <realmAuthConfig>, <realmConfig>, and <appSettings> sectionsof the web.config file only. If you change the information in the other sections, there might be a performance impacton 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

Configure single sign-on authentication for BlackBerry Domain SearchSingle sign-on authentication allows you to log in to BlackBerry® Domain Search using a specific administrationaccount without having to type a user name and password. You must configure BlackBerry Domain Search to log inusing the same administration account that you configured the BlackBerry Administration Service to use for singlesign-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. Theweb.config file is located in the bbsearch virtual directory folder (for example, <drive>:\Inetpub\wwwroot\bbsearch.)

1. On the computer that hosts BlackBerry Domain Search, open the Microsoft® IIS Manager.

2. Create a new application pool. Set the identity of the application pool to the user account that you configuredthe BlackBerry Administration Service to use for single sign-on authentication.

3. In the virtual directory properties for the bbsearch web site, select the application pool that you created in step2.

4. 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.

5. Save the changes that you made to the bbsearch web site.

6. Verify that the single sign-on user account is a member of the IIS_WPG group.

7. Verify that the IIS_WPG group has write and modify permissions for the bbsearch virtual directory folder.

8. In the bbsearch virtual directory folder, navigate to the web.config file.

9. In a text editor, open the web.config file.

10. In the <realmAuthConfig> section, type the following: <realmAuthConfig useBasSso="true"/>.

11. Save the web.config file.


18

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

4

Upgrading from a previous version of the BlackBerryEnterprise Server User Administration ToolIf the BlackBerry® Enterprise Server User Administration Tool is already installed in your environment, you do nothave 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 EnterpriseServer User Administration Tool 5.0 SP2 or later, the installation process does not overwrite the 5.0 version of thetool. 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 EnterpriseServer User Administration Tool 5.0 SP2 or later, the installation process overwrites the 5.0 SP1 version of the tooland preserves user information such as registry values and exe.config files. Patch upgrades that are version 5.0 SP2or later overwrite 5.0 SP1 and later versions of the BlackBerry Enterprise Server User Administration Tool.

Upgrading from a previous version of the BlackBerryAnalysis, Monitoring, and Troubleshooting ToolsIf the BlackBerry® Analysis, Monitoring, and Troubleshooting Tools are already installed in your environment, youdo 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 overwriteprevious versions of the tool (except for the BlackBerry System Log Monitoring and Reporting Tool and the BlackBerryMessage 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 the5.0 SP1 version of the tool and preserves user information such as registry values and exe.config files. Patch upgradesthat are version 5.0 SP2 or later overwrite 5.0 SP1 and later versions of the tool.

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

19

Troubleshooting 5

The BlackBerry Domain Search setup application does notcomplete successfullyPossible cause

ASP.NET 2.0 might have been installed before Microsoft® IIS 5.0 or later was installed. As a result, ASP.NET mightnot 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 UserAdministration ToolYou can use this command to verify that there is a valid connection between the BlackBerry® Administration Serviceand 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 computerthat hosts the tool, on the taskbar, click Start > Programs > BlackBerry Enterprise Server Resource Kit >BlackBerry Enterprise Server User Administration Tool Client > BlackBerry Enterprise Server UserAdministration Tool.

2. Type besuseradminclient -n <server_name> <credentials> -status.

Example

besuseradminclient -username admin -password password -status

Example output

BlackBerry(R) Enterprise Server User Administration Tool Version 5.0.2.6Copyright (c) Research In Motion, Ltd. 2009-2010. All rights reserved.

Log files being written to C:\Users\administrator\AppData\Roaming\Research In Motion\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,ValueBAS Version,5.0.2.14BAA Version,5.0.2.6

Installation Guide Troubleshooting

20

When I check the status of the BlackBerry Enterprise Server UserAdministration Tool I receive an "Error while initializing the logs" errormessageWhen you use the -status parameter to check the status of the BlackBerry Enterprise Server User AdministrationTool, the "Error while initializing the logs" error message appears. This error message indicates the location wherethe 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 EnterpriseServer 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 runthe 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 thatthe 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, clickStart > Program Files > BlackBerry Enterprise Server Resource Kit > BlackBerry Enterprise Server UserAdministration Tool Client.

2. Click Uninstall.


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 andTroubleshooting Tools > Uninstall or Modify Installation.


Installation Guide Removing a BlackBerry Enterprise Server Resource Kit tool

21

Remove BlackBerry Domain Search

1. On the computer that hosts BlackBerry® Domain Search, on the taskbar, click Start > Settings > Control Panel> Add/Remove Programs.

2. Click BlackBerry Search.

3. Click Remove.

4. Click Yes.

Installation Guide Removing a BlackBerry Enterprise Server Resource Kit tool

22

Glossary 6

BlackBerry Enterprise Server databasesThe BlackBerry® Enterprise Server databases are the BlackBerry Configuration Database and the BlackBerryMonitoring Service database.

BlackBerry DomainA BlackBerry Domain consists of the BlackBerry Configuration Database with its users and any BlackBerry®Enterprise Server instances that connect to it.

BlackBerry MDSBlackBerry® Mobile Data System

CDOCollaboration Data Object

.csvcomma-separated values

DNSDomain Name System

MAPIMessaging Application Programming Interface

messaging serverA messaging server sends and processes messages and provides collaboration services, such as updating andcommunicating calendar and address book information.

Installation Guide Glossary

23

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

Installation Guide Provide feedback

24

http://www.blackberry.com/docsfeedback

Legal notice 8©2011 Research In Motion Limited. All rights reserved. BlackBerry®, RIM®, Research In Motion®, and relatedtrademarks, names, and logos are the property of Research In Motion Limited and are registered and/or used in theU.S. and countries around the world.

IBM, Domino, and Lotus are trademarks of International Business Machines Corporation. Java and JRE are trademarksof Oracle America, Inc. Microsoft, Internet Explorer, SQL Server, Windows, and Windows Server are trademarks ofMicrosoft Corporation. All other trademarks are the property of their respective owners.

This documentation including all documentation incorporated by reference herein such as documentation providedor made available at www.blackberry.com/go/docs is provided or made accessible "AS IS" and "AS AVAILABLE" andwithout condition, endorsement, guarantee, representation, or warranty of any kind by Research In Motion Limitedand its affiliated companies ("RIM") and RIM assumes no responsibility for any typographical, technical, or otherinaccuracies, errors, or omissions in this documentation. In order to protect RIM proprietary and confidentialinformation and/or trade secrets, this documentation may describe some aspects of RIM technology in generalizedterms. 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 thisdocumentation to you in a timely manner or at all.

This documentation might contain references to third-party sources of information, hardware or software, productsor 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 ThirdParty 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. Theinclusion of a reference to Third Party Products and Services in this documentation does not imply endorsement byRIM 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 ORWARRANTIES OF DURABILITY, FITNESS FOR A PARTICULAR PURPOSE OR USE, MERCHANTABILITY, MERCHANTABLEQUALITY, NON-INFRINGEMENT, SATISFACTORY QUALITY, OR TITLE, OR ARISING FROM A STATUTE OR CUSTOM ORA COURSE OF DEALING OR USAGE OF TRADE, OR RELATED TO THE DOCUMENTATION OR ITS USE, OR PERFORMANCEOR NON-PERFORMANCE OF ANY SOFTWARE, HARDWARE, SERVICE, OR ANY THIRD PARTY PRODUCTS AND SERVICESREFERENCED HEREIN, ARE HEREBY EXCLUDED. YOU MAY ALSO HAVE OTHER RIGHTS THAT VARY BY STATE ORPROVINCE. SOME JURISDICTIONS MAY NOT ALLOW THE EXCLUSION OR LIMITATION OF IMPLIED WARRANTIES ANDCONDITIONS. TO THE EXTENT PERMITTED BY LAW, ANY IMPLIED WARRANTIES OR CONDITIONS RELATING TO THEDOCUMENTATION TO THE EXTENT THEY CANNOT BE EXCLUDED AS SET OUT ABOVE, BUT CAN BE LIMITED, AREHEREBY LIMITED TO NINETY (90) DAYS FROM THE DATE YOU FIRST ACQUIRED THE DOCUMENTATION OR THE ITEMTHAT IS THE SUBJECT OF THE CLAIM.

TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW IN YOUR JURISDICTION, IN NO EVENT SHALL RIM BELIABLE FOR ANY TYPE OF DAMAGES RELATED TO THIS DOCUMENTATION OR ITS USE, OR PERFORMANCE OR NON-PERFORMANCE OF ANY SOFTWARE, HARDWARE, SERVICE, OR ANY THIRD PARTY PRODUCTS AND SERVICES

Installation Guide Legal notice

25

http://www.blackberry.com/go/docs

REFERENCED HEREIN INCLUDING WITHOUT LIMITATION ANY OF THE FOLLOWING DAMAGES: DIRECT,CONSEQUENTIAL, EXEMPLARY, INCIDENTAL, INDIRECT, SPECIAL, PUNITIVE, OR AGGRAVATED DAMAGES, DAMAGESFOR LOSS OF PROFITS OR REVENUES, FAILURE TO REALIZE ANY EXPECTED SAVINGS, BUSINESS INTERRUPTION, LOSSOF BUSINESS INFORMATION, LOSS OF BUSINESS OPPORTUNITY, OR CORRUPTION OR LOSS OF DATA, FAILURES TOTRANSMIT OR RECEIVE ANY DATA, PROBLEMS ASSOCIATED WITH ANY APPLICATIONS USED IN CONJUNCTION WITHRIM PRODUCTS OR SERVICES, DOWNTIME COSTS, LOSS OF THE USE OF RIM PRODUCTS OR SERVICES OR ANY PORTIONTHEREOF 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 ORUNFORESEEN, 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 OTHEROBLIGATION, DUTY, OR LIABILITY WHATSOEVER IN CONTRACT, TORT, OR OTHERWISE TO YOU INCLUDING ANYLIABILITY FOR NEGLIGENCE OR STRICT LIABILITY.

THE LIMITATIONS, EXCLUSIONS, AND DISCLAIMERS HEREIN SHALL APPLY: (A) IRRESPECTIVE OF THE NATURE OF THECAUSE 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 BREACHOR BREACHES OR THE FAILURE OF THE ESSENTIAL PURPOSE OF THIS AGREEMENT OR OF ANY REMEDY CONTAINEDHEREIN; AND (B) TO RIM AND ITS AFFILIATED COMPANIES, THEIR SUCCESSORS, ASSIGNS, AGENTS, SUPPLIERS(INCLUDING AIRTIME SERVICE PROVIDERS), AUTHORIZED RIM DISTRIBUTORS (ALSO INCLUDING AIRTIME SERVICEPROVIDERS) 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 ANYLIABILITY 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 ensurethat your airtime service provider has agreed to support all of their features. Some airtime service providers mightnot offer Internet browsing functionality with a subscription to the BlackBerry® Internet Service. Check with yourservice provider for availability, roaming arrangements, service plans and features. Installation or use of Third PartyProducts and Services with RIM's products and services may require one or more patent, trademark, copyright, orother licenses in order to avoid infringement or violation of third party rights. You are solely responsible fordetermining 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 Servicesuntil all necessary licenses have been acquired. Any Third Party Products and Services that are provided with RIM'sproducts and services are provided as a convenience to you and are provided "AS IS" with no express or impliedconditions, endorsements, guarantees, representations, or warranties of any kind by RIM and RIM assumes no liabilitywhatsoever, in relation thereto. Your use of Third Party Products and Services shall be governed by and subject toyou agreeing to the terms of separate licenses and other agreements applicable thereto with third parties, exceptto 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

The terms of use of any RIM product or service are set out in a separate license or other agreement with RIM applicablethereto. NOTHING IN THIS DOCUMENTATION IS INTENDED TO SUPERSEDE ANY EXPRESS WRITTEN AGREEMENTS ORWARRANTIES PROVIDED BY RIM FOR PORTIONS OF ANY RIM PRODUCT OR SERVICE OTHER THAN THISDOCUMENTATION.

Research In Motion Limited295 Phillip StreetWaterloo, ON N2L 3W8Canada

Research In Motion UK Limited Centrum House 36 Station Road Egham, Surrey TW20 9LF United Kingdom

Published in Canada


27

blackberry enterprise server resource kit installation guide 1322296 0124032826 001 5.0.3 us

Documents

available blackberry

system requirements

troubleshooting tools

log analysis tools

previous version

logs error message

installation guide

installation files