Administration Guide

BlackBerry Manuals & Help  >  Administrator Documentation  >  BlackBerry Enterprise Server 5  >  BlackBerry Enterprise Server Resource Kit  >  Administration Guide BlackBerry Analysis, Monitoring, and Troubleshooting Tools - BlackBerry Enterprise Server Resource Kit - 5.0.4

Run the BlackBerry Historical Statistics Tool from the command prompt

  • See Prepare to run the log analysis tools.
  • Copy the log files for the BlackBerry Messaging Agent and BlackBerry Dispatcher to the computer that hosts the BlackBerry Historical Statistics Tool and BlackBerry Enterprise Server Log Analysis Tool.
  • If necessary, change the logging level to 4 for the following fields in the DISP log files: CICAL FROM (in bytes), CMIME FROM (in bytes), and MDS FROM (in bytes).
  1. On the computer that hosts the BlackBerry Historical Statistics Tool, on the taskbar, click Start > All Programs > BlackBerry Enterprise Server Resource Kit > BlackBerry Analysis Monitoring and Troubleshooting Tools > BlackBerry Historical Statistics Tool.
  2. In the command prompt window, type HistoricalStats and the following parameters:

    Parameter

    Description

    -p E[xchange]

    -p D[omino]

    -p G[roupWise]

    This parameter specifies the messaging platform.

    -u <account>

    -u all

    This parameter specifies the user account.

    To query all user accounts in the log files, type -u all.

    To query a specific user account, type the user name in one of the following formats:

    • Microsoft Exchange: SMTP email address (for example, jpalmer@<domain>.net)
    • IBM Lotus Domino: canonical name (for example, Julie Palmer/Organization)
    • Novell GroupWise: first name and last name (for example, Julie Palmer)
  3. Type any of the following optional parameters:

    Parameter

    Description

    -input <filename.txt>

    This parameter specifies the name of the file that contains the SMTP email addresses of the user accounts that you want to monitor.

    Use a carriage return to separate each entry in the file.

    This parameter overrides the value that is specified with the -u parameter.

    -L <path>

    This parameter specifies the location of the debug log files that you want to query if the files are not in the same folder as the tool. If the path contains spaces, enclose the path in quotation marks ( " " ).

    -OL <path>

    This parameter specifies the folder where the tool writes the output files. If the path contains spaces, enclose the path in quotation marks ( " " ).

    -output user

    -output all

    This parameter specifies how to organize the data in output files.

    To create one file for each user account, type -output user.

    To create one file for all user accounts, type -output all. This is the default value.

    -agent <abbreviation>

    This parameter specifies the abbreviation for the BlackBerry Messaging Agent log files. If you do not specify an abbreviation, the BlackBerry Historical Statistics Tool uses MAGT.

    -dispatcher <abbreviation>

    This parameter specifies the abbreviation for the BlackBerry Dispatcher log files. If you do not specify a name, the tool uses DISP.

    -debug <filename.txt>

    This parameter specifies that the tool creates a more detailed output file for debugging purposes, and it specifies the name of the debugging file.

    If you do not specify a file name, the tool displays the debugging information on the screen.

Example: Querying historical statistics for a BlackBerry Enterprise Server for Microsoft Exchange

HistoricalStats -p E -u all -L C:\BRK -output all

  • If you want to view the help information for the tool, including the list of available parameters, in the command window, type HistoricalStats -? or HistoricalStats -help.
  • If you configured the tool to use a UAC-compliant file path, the output file is located at <drive>:\Users\<user_name>\AppData\Roaming\Research In Motion\AMT\ or <drive>:\Documents and Settings\user_name\Application Data\Research In Motion\AMT\. If you did not configure the tool to use a UAC-compliant file path, the output file is located in a file path relative to the current working directory, for example, <drive>:\Program Files\Research In Motion\BlackBerry Enterprise Server Resource Kit \BlackBerry AMT Tools.

Next topic: Results of a BlackBerry Historical Statistics Tool query
Previous topic: Run the BlackBerry Historical Statistics Tool using the BlackBerry Enterprise Server Log Analysis Tool

Was this information helpful? Send us your comments.