BlackBerry Enterprise Server Resource Kit

Transcription

1 BlackBerry Enterprise Server Resource Kit Version: 5.0 Service Pack: 3 Installation Guide

2 Published: SWD

3 Contents 1 Overview... 3 Options for downloading the BlackBerry Enterprise Server Resource Kit... 3 BlackBerry Enterprise Server User Administration Tool... 3 BlackBerry Analysis, Monitoring, and Troubleshooting Tools... 4 Available BlackBerry Analysis, Monitoring, and Troubleshooting Tools Requirements... 6 System requirements: BlackBerry Enterprise Server User Administration Tool... 6 System requirements: BlackBerry Analysis, Monitoring, and Troubleshooting Tools... 7 System requirements: BlackBerry Application Reporting Tool... 7 System requirements: BlackBerry Domain Administration History Reporting Tool... 8 System requirements: BlackBerry Message Receipt Confirmation Tool... 8 System requirements: BlackBerry Domain Search... 9 System requirements: BlackBerry Directory Sync Tool System requirements: BlackBerry System Log Monitoring and Reporting Tool System requirements: Log analysis tools System requirements: BlackBerry Enterprise Server Log Monitoring Tool 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 Install the BlackBerry Directory Sync Tool Configure the BlackBerry Directory Sync Tool to search for groups in Microsoft Active Directory Configure the BlackBerry Directory Sync Tool to search for groups in a BlackBerry Domain Change the performance and configuration settings for the BlackBerry Directory Sync 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 Upgrading from a previous version of the BlackBerry Analysis, Monitoring, and Troubleshooting Tools Troubleshooting... 25

4 The BlackBerry Domain Search setup application does not complete successfully BlackBerry Directory Sync Tool No Directory groups to display. Please check the configuration No BlackBerry groups to display. Please check the configuration Exception retrieving BlackBerry groups 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 Remove the BlackBerry Enterprise Server User Administration Tool Remove the BlackBerry Analysis, Monitoring, and Troubleshooting Tools Remove BlackBerry Domain Search Glossary Provide feedback Legal notice... 31

5 Overview Overview 1 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 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 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. 3

6 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 Tool BlackBerry Application Reporting Tool (HHAppReport.exe) BlackBerry IT Policy Import and Export Tool (ITPolicyImportExport.exe) BlackBerry Message Receipt Confirmation Tool (MessageConfirmService.exe) BlackBerry System Log Monitoring and Reporting Tool (BESSysLog.exe) BlackBerry Enterprise Server Log Monitoring Tool (LogMonitor.exe) BlackBerry System Requirements Tool (BBCheck.exe) BlackBerry Domain Search Description This tool lists the applications that are installed in the BlackBerry Domain. You can use this tool to audit the BlackBerry Domain and find unapproved applications. This tool exports IT policy information from a BlackBerry Configuration 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. This tool verifies that the BlackBerry Enterprise Server is sending messages to BlackBerry devices. At an interval that you specify, the tool sends a message to the specified user account, monitors the status of that message, and checks for confirmation that the BlackBerry device received the message. This tool monitors the BlackBerry Enterprise Server log events as they 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. This tool monitors the text that is written to the end of a text file, typically 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. This tool provides a set of tests that can help you determine whether you can successfully run a BlackBerry Enterprise Server component on a computer. 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, address, BlackBerry Enterprise Server instance, and group name. The search results provide basic information for the 4

7 Available BlackBerry Analysis, Monitoring, and Troubleshooting Tools Tool BlackBerry Directory Sync Tool (DirectorySync.exe) BlackBerry Domain Administration History Reporting Tool (AdminHistory.exe) Description 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. You can use the BlackBerry Directory Sync Tool to synchronize the membership of security and distribution groups in Microsoft Active Directory to selected groups in a BlackBerry Domain. After you map relationships between Microsoft Active Directory groups and BlackBerry Enterprise Server groups (the groups can exist across different BlackBerry Domain instances), you can start the synchronization process manually or you can schedule the synchronization process to occur automatically at a set interval using a task scheduling application. This tool reads the ServerConfigHistory table in the BlackBerry Configuration Database and displays configuration changes, such as 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. The tool is compatible only with BlackBerry Enterprise Server 4.1 SP7 and earlier. 5

8 Requirements Requirements 2 System requirements: BlackBerry Enterprise Server User Administration Tool Item operating system memory browser BlackBerry Administration Service Running the BlackBerry Enterprise Server User Administration Tool from a remote computer 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. 6

9 System requirements: BlackBerry Analysis, Monitoring, and Troubleshooting Tools System requirements: BlackBerry Analysis, Monitoring, and Troubleshooting Tools Item operating system BlackBerry Enterprise Server Requirement Certain tools might not support some of the operating systems listed below. See the system requirements for each tool for more information. 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. 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: 7

10 System requirements: BlackBerry Domain Administration History Reporting Tool Item Requirement Microsoft SQL Server 2005 Microsoft SQL Server 2005 SP2 Microsoft SQL Server 2008 R2 System requirements: BlackBerry Domain Administration History Reporting Tool Item BlackBerry Enterprise Server database management system for the BlackBerry Configuration Database BlackBerry Configuration Database Requirement You must run the BlackBerry Domain Administration History Reporting Tool on a computer that is separate from the BlackBerry Enterprise Server components. The tool is compatible only with BlackBerry Enterprise Server 4.1 SP7 and earlier. 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 connection from the BlackBerry Configuration Database to the BlackBerry Domain Administration History Reporting Tool System requirements: BlackBerry Message Receipt Confirmation Tool Item BlackBerry Enterprise Server BlackBerry Message Receipt Confirmation Tool service and client 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. You must run the BlackBerry Message Receipt Confirmation Tool service (messageconfirmservice.exe) and the BlackBerry Message Receipt Confirmation Tool client (messageconfirmconfig.exe) on the same computer. 8

11 System requirements: BlackBerry Domain Search Item Microsoft Exchange system tools Requirement 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 install Microsoft Exchange Server MAPI client and CDO For information about the versions of the Microsoft Exchange Server MAPI client and CDO that are supported by the BlackBerry Enterprise Server, visit to see the BlackBerry Enterprise Server compatibility matrix. 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. 3. 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. 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 web server browser access to BlackBerry Domain instances 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 library/iis/0aafb9a0-1b1c-4a39-ac9a-994adc 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. 9

12 System requirements: BlackBerry Directory Sync Tool Item BlackBerry Enterprise Server compatibility BlackBerry Web Services BlackBerry Administration Service compatibility BlackBerry Administration Service permissions BlackBerry Browser support supported environments unsupported environments Requirement 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 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. BlackBerry Domain Search uses the BlackBerry Web Services to access BlackBerry Enterprise Server instances that are version 5.0 SP3 or later. The BlackBerry Web Services are installed when you install BlackBerry Enterprise Server 5.0 SP3 or later, so you do not need to download and install it separately. 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 instances that are earlier than 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 System requirements: BlackBerry Directory Sync Tool Item BlackBerry Enterprise Server compatibility Requirement BlackBerry Enterprise Server 5.0 SP3 MR1 or later for Microsoft Exchange BlackBerry Enterprise Server 5.0 SP3 MR1 or later for IBM Lotus Domino BlackBerry Enterprise Server Express 5.0 SP3 or later 10

13 System requirements: BlackBerry Directory Sync Tool Item Operating system Microsoft.NET Framework Access to Microsoft Active Directory and BlackBerry Domain instances Administrator permissions User accounts must exist on the BlackBerry Enterprise Server Requirement Any of the following 32-bit operating systems: Windows XP Professional SP2 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 Microsoft.NET Framework 3.5 or later must be installed on the computer that hosts the BlackBerry Directory Sync Tool. The computer that hosts the BlackBerry Directory Sync Tool must be able to access Microsoft Active Directory and the BlackBerry Domain instances that you want to connect to. Install the BlackBerry Directory Sync Tool on a computer that does not host a BlackBerry Enterprise Server. The Windows account that you use to run the tool must have read permissions for Microsoft Active Directory. The BlackBerry Administration Service administrator account that you configure the tool to use must have permissions to view and edit groups in the BlackBerry Administration Service. The administrator account that you specify must exist in and have the required permissions in every BlackBerry Domain that you want the tool to connect to. For more information about administrator roles and permissions, visit to see the BlackBerry Enterprise Server Administration Guide. The BlackBerry Directory Sync Tool can synchronize group membership only if the user accounts in Microsoft Active Directory have corresponding user accounts on a BlackBerry Enterprise Server. Before you run the tool, verify that the user accounts that you want to synchronize exist in both Microsoft Active Directory and in the appropriate BlackBerry Domain. If necessary, add any user accounts to a BlackBerry Enterprise Server before you start the synchronization process. For more information about adding a user account to a BlackBerry Enterprise Server, visit to see the BlackBerry Enterprise Server Administration Guide. 11

14 System requirements: BlackBerry System Log Monitoring and Reporting Tool Item Group size limit Multiple instances are not supported Property names in Microsoft Active Directory Requirement The BlackBerry Directory Sync Tool does not add user accounts to the BlackBerry Enterprise Server as part of the synchronization process. The tool writes information about any user accounts that it cannot synchronize to a report and a log file. By default, the BlackBerry Directory Sync Tool cannot synchronize changes to BlackBerry Enterprise Server groups that have more than 2000 members. There is no size limit for Microsoft Active Directory groups. If you want to synchronize changes to BlackBerry Enterprise Server groups that have more than 2000 members, you must upgrade to BlackBerry Enterprise Server 5.0 SP3 MR3 or later and change the maximum group size limit in the configuration file (DirectorySync.exe.Config). For more information about changing the configuration file, see "Change the performance and configuration settings for the BlackBerry Directory Synchronization Tool". Do not install more than one instance of the BlackBerry Directory Sync Tool on the same computer. You cannot run multiple instances of the tool at the same time. The BlackBerry Directory Sync Tool retrieves information from Microsoft Active Directory by reading standard property names for group names, addresses, and user display names. If your organization uses property names that are not standard, you must add the property names to the configuration file (DirectorySync.exe.Config) so that the BlackBerry Directory Sync Tool can retrieve information from Microsoft Active Directory. For more information about changing the configuration file, see "Change the performance and configuration settings for the BlackBerry Directory Synchronization Tool". Unsupported environments BlackBerry Enterprise Server for Novell GroupWise Any version of the BlackBerry Enterprise Server or BlackBerry Enterprise Server Express earlier than 5.0 SP3 System requirements: BlackBerry System Log Monitoring and Reporting Tool Item BlackBerry Enterprise Server multiple BlackBerry Enterprise Server platforms (optional) 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. In an environment that includes more than one BlackBerry Enterprise Server platform, the following conditions must be met: 12

15 System requirements: Log analysis tools Item Windows service Windows Server 2008 (64- bit) version compatibility logging level Requirement 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 You must run the BlackBerry System Log Monitoring and Reporting Tool as a Windows service. If your organization uses Windows Server 2008 (64-bit), you must create a reverse 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. Perform the following actions: 1. In the advanced TCP/IP settings for the network connection that the tool uses, 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. 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 memory 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 13

16 System requirements: BlackBerry Enterprise Server Log Monitoring Tool Item disk space BlackBerry Enterprise Server BlackBerry Enterprise Server log files version compatibility Requirement 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. 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. 14

17 Installing a BlackBerry Enterprise Server Resource Kit tool Installing a BlackBerry Enterprise Server Resource Kit tool Installation files 3 Tool Installation file name Environment BlackBerry Enterprise Server User Administration Tool BlackBerry Enterprise Transporter brk-besuseradminclient<version>.msi brkbbenterprisetransporter<version>.ms i BlackBerry Application Reporting Tool brk-amt<version>.msi All BlackBerry Domain Administration History brk-amt<version>.msi All Reporting Tool BlackBerry IT Policy Import and Export Tool brk-amt<version>.msi All BlackBerry Message Receipt Confirmation brk-amt<version>.msi All Tool BlackBerry System Log Monitoring and brk-amt<version>.msi All Reporting Tool BlackBerry System Requirements Tool brk-amt<version>.msi All BlackBerry Domain Search blackberrysearch<version>.msi (must run brk-amt<version>.msi) Microsoft Exchange and IBM Lotus Domino BlackBerry Enterprise Server Express BlackBerry Directory Sync Tool brk-amt<version>.msi Microsoft Exchange and IBM Lotus Domino BlackBerry Enterprise Server Express Log analysis tools BlackBerry Delayed Notifications Monitoring brk-amt<version>.msi Microsoft Exchange only Tool BlackBerry Enterprise Server Log Monitoring brk-amt<version>.msi All Tool BlackBerry Historical Statistics Tool brk-amt<version>.msi All BlackBerry MAPI and CDO Error Monitoring brk-amt<version>.msi Microsoft Exchange only Tool BlackBerry MDS Services Data Monitoring Tool brk-amt<version>.msi All All All 15

18 Configuring the BlackBerry Enterprise Server User Administration Tool and the BlackBerry Analysis, Monitoring, and Troubleshooting Tools to use UAC-compliant file paths Tool Installation file name Environment BlackBerry Message Flow Reporting Tool brk-amt<version>.msi All BlackBerry Message Pending Delivery Tool brk-amt<version>.msi All BlackBerry Thread Analyzer Tool brk-amt<version>.msi All BlackBerry Usage Monitoring Tool brk-amt<version>.msi All BlackBerry User Activity Reporting Tool brk-amt<version>.msi Microsoft Exchange only 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. 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 and navigate to the Downloads area for the BlackBerry Enterprise Server Resource Kit. 3. 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. 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: 16

19 Verify that the BlackBerry Enterprise Server User Administration Tool was installed correctly 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. 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. 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 to read the BlackBerry Enterprise Server User Administration Tool Administration Guide. 4. 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 to read the BlackBerry Enterprise Server Administration Guide. 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. In a browser, visit and navigate to the Downloads area for the BlackBerry 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. 5. Complete the instructions on the screen. 17

20 Install BlackBerry Domain Search Install BlackBerry Domain Search BlackBerry Domain Search is packaged with the BlackBerry Analysis, Monitoring, and Troubleshooting Tools. 1. Visit and navigate to the Downloads area for the BlackBerry 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 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: <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. 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. If the computer that hosts BlackBerry Domain Search uses a 64-bit operating system, in the Microsoft IIS Manager, enable 32-bit applications for the application pool that you want BlackBerry Domain Search to use. 1. On the computer that hosts BlackBerry Domain Search, in a text editor, open the web.config file for BlackBerry Domain Search. 2. 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. 3. In the <realmconfig> section, complete the instructions to specify the BlackBerry Administration Service instances that you want BlackBerry Domain Search to access. 18

21 Install BlackBerry Domain Search 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 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. 5. 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. 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"/> 19

22 Install BlackBerry Domain Search <add name="domain3" hostname="bas3.company.net" port="8443"/> </domains> </realmconfig> <appsettings> <add key="defaultlogindomain" value="domain"/> <add key="maxresultsperdomain" value="450"/> </appsettings> </configuration> 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. 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 configured the BlackBerry Administration Service to use for single sign-on authentication. 3. If the computer that hosts BlackBerry Domain Search uses a 64-bit operating system, enable 32-bit applications for the new application pool. 4. In the virtual directory properties for the bbsearch web site, select the application pool that you created in step 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. 6. Save the changes that you made to the bbsearch web site. 7. Verify that the single sign-on user account is a member of the IIS_WPG group. 8. Verify that the IIS_WPG group has write and modify permissions for the bbsearch virtual directory folder. 9. In the bbsearch virtual directory folder, navigate to the web.config file. 10. In a text editor, open the web.config file. 11. In the <realmauthconfig> section, type the following: <realmauthconfig usebassso="true"/>. 12. Save the web.config file. 20

23 Install the BlackBerry Directory Sync Tool Install the BlackBerry Directory Sync Tool The BlackBerry Directory Sync Tool is packaged with the BlackBerry Analysis, Monitoring, and Troubleshooting Tools. 1. Visit and navigate to the Downloads area for the BlackBerry 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 to install the BlackBerry Directory Sync Tool only. Configure the BlackBerry Directory Sync Tool to search for groups in Microsoft Active Directory 1. On the computer that hosts the BlackBerry Directory Sync Tool, on the taskbar, click Start > All Programs > BlackBerry Enterprise Server Resource Kit > BlackBerry Analysis Monitoring and Troubleshooting Tools > BlackBerry Directory Sync Tool. 2. In the Directory Group Search section, click Configure. 3. In the Server Discovery drop-down list, perform one of the following actions: If you want the tool to search for Microsoft Active Directory groups in the domain that you are currently logged in to, click Automatic. The Windows account that you are currently using must have read permissions for Microsoft Active Directory. If you want the tool to search for Microsoft Active Directory groups in a specific domain or server, click Manual. 4. If necessary, in the Domain or Server field, type the name of the domain or server that hosts Microsoft Active Directory. 5. If necessary, in the Port field, type the port number that you want the tool to use to connect to Microsoft Active Directory. The default port number is If you want the tool to limit the search to a specific DN, in the Search Path DN field, type the path of the DN (for example, OU=Groups,DC=sample,DC=net). 7. In the Maximum Results field, type the maximum number of Microsoft Active Directory groups that you want the tool to find and display. 8. Click Save. Configure the BlackBerry Directory Sync Tool to search for groups in a BlackBerry Domain 1. On the computer that hosts the BlackBerry Directory Sync Tool, on the taskbar, click Start > All Programs > BlackBerry Enterprise Server Resource Kit > BlackBerry Analysis Monitoring and Troubleshooting Tools > BlackBerry Directory Sync Tool. 2. In the BlackBerry Group Search section, click Configure. 21

24 Install the BlackBerry Directory Sync Tool 3. In the Auth Type drop-down list, click the type of authentication that you use for the BlackBerry Administration Service. 4. In the Username field, type the user name of the BlackBerry Administration Service administrator account that you want to use to connect to each BlackBerry Domain. The administrator account must exist in and have the required permissions in every BlackBerry Domain that you want the tool to connect to. 5. In the Password field, type the password of the BlackBerry Administration Service administrator account. 6. If necessary, in the Domain field, type the Microsoft Active Directory domain. 7. In the Add BlackBerry Domain section, in the Label field, type a label for a BlackBerry Domain. 8. In the BAS Host field, type the full path name of the computer that hosts the BlackBerry Administration Service for the BlackBerry Domain (for example, BAS-HOST1.company.com). 9. If necessary, in the Port field, type the port number that you want the tool to use to connect to the BlackBerry Administration Service. The default value is 443. To connect to the BlackBerry Administration Service for a BlackBerry Enterprise Server Express, use port number Click Add. 11. Repeat steps 7 to 10 for each BlackBerry Domain that you want the tool to connect to. 12. Click Save. Change the performance and configuration settings for the BlackBerry Directory Sync Tool The BlackBerry Directory Sync Tool retrieves information from Microsoft Active Directory by reading standard property names for group names, addresses, and user display names. If your organization uses property names for group names, addresses, or display names that are not standard, you can specify the property names using the configuration file. You can change the performance settings for the BlackBerry Directory Sync Tool if you want to change how the tool completes the synchronization process. It is a best practice to use the default performance settings for the tool. Changing the settings might have a performance impact on your organization's BlackBerry Enterprise Server environment. 1. On the computer that hosts the BlackBerry Directory Sync Tool, navigate to <drive>:\program Files\Research In Motion\BlackBerry Enterprise Server Resource Kit\BlackBerry AMT Tools. 2. In a text editor, open the DirectorySync.exe.Config file. 3. If your organization uses a property name for group names in Microsoft Active Directory that is not standard, in the <appsettings> section, type <add key="groupnameproperty" value="<group_property_name>"/>, where <group_property_name> is the required property name. The default value is "name". 4. If your organization uses a property name for addresses in Microsoft Active Directory that is not standard, in the <appsettings> section, type <add key=" addressproperty" value="< _property_name>"/>, where < _property_name> is the required property name. The default value is "mail". 22

25 Install the BlackBerry Directory Sync Tool 5. If your organization uses a property name for user display names in Microsoft Active Directory that is not standard, in the <appsettings> section, type <add key="displaynameproperty" value="<display_property_name>"/>, where <display_property_name> is the required property name. The default value is "displayname". 6. To specify the maximum number of changes that you want the tool to synchronize each time you run the tool, in the <appsettings> section, type <add key="maxnumberofchanges" value="<max_changes_value>"/>, where <max_changes> is a value greater than zero. The default value is 0 (no limit). 7. To specify the maximum size of a BlackBerry Enterprise Server group that the tool can synchronize changes to, in the <appsettings> section, change the value of <add key="maxnumberofusersinbasgroup" value="<max_users_group>"/>, where <max_users_group> is the maximum number of user accounts in a group. The tool does not synchronize changes to BlackBerry Enterprise Server groups with more user accounts than the value that you specify. The default value is Note: If you want to synchronize changes to BlackBerry Enterprise Server groups that have more than 2000 members, you must upgrade to BlackBerry Enterprise Server 5.0 SP3 MR3 or later. 8. To specify how long you want the tool to wait before synchronizing each change (for example, assigning a user account to a group), in the <appsettings> section, change the value of <add key="changedelay" value="<change_delay>"/>, where <change_delay> is a value greater than zero, in seconds. The default value is 1 second. 9. To specify the maximum level of nested groups that the tool can synchronize, in the <appsettings> section, type <add key="maxnestinglevel" value="<max_nesting_level>"/>, where <max_nesting_level> is a value of 0 or greater. The default value is -1 (no limit). 10. Save and close the DirectorySync.exe.Config file. Example appsettings section <appsettings> <add key="groupnameproperty" value="groupexample"/> <add key=" addressproperty" value=" example"/> <add key="displaynameproperty" value="displaynameexample"/> <add key="maxnumberofchanges" value="1000"/> <add key="maxnumberofusersinbasgroup" value="1000"/> <add key="changedelay" value="2"/> <add key="maxnestinglevel" value="5"/> </appsettings> 23

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