Run the BlackBerry Message Flow Reporting Tool from the command prompt

  • See Prepare to run the log analysis tools.
  • Copy the log files for the BlackBerry Messaging Agent, BlackBerry Dispatcher, and BlackBerry Router to the computer that hosts the BlackBerry Message Flow Reporting Tool and BlackBerry Enterprise Server Log Analysis Tool.
  1. On the computer that hosts the BlackBerry Message Flow Reporting Tool, on the taskbar, click Start > All Programs > BlackBerry Enterprise Server Resource Kit > BlackBerry Analysis Monitoring and Troubleshooting Tools > BlackBerry Message Flow Reporting Tool.
  2. In the command prompt window, type MessageFlow 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 list of user accounts that you want to monitor.

    Use the appropriate format as described for the -u parameter.

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

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

    -multiday <start_date>-<end_date>

    This parameter specifies the dates that the tool checks log files for.

    To check message flow across multiple days, type a date value to specify the subfolders in the log file that the tool checks. The tool checks subfolders from the current date.

    Use the format <yyyymmdd>-<yyyymmdd > for a date range or <yyyymmdd> for a single date that is used as the start date.

    When you use this parameter with two dates, the tool creates an output file that is named MessageFlow_<user_name>_<start_date>-<end_date>.<#>.csv.

    When you use this parameter with one date, the tool uses the date as the start date and creates an output file that is named MessageFlowEnding_<end_date>.<#>.csv, where the <end_date> is the last date that was logged.

    If you do not type a date value, the tool cannot check the subfolders.

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

    -L <path>

    This parameter specifies the location of the debug log files that you want to query if they 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 ( " " ).

    -agent <abbreviation>

    This parameter specifies the abbreviation for the BlackBerry Messaging Agent log files. If you do not specify an abbreviation, the BlackBerry Message Flow Reporting 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.

    -router <abbreviation>

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

    -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 all user accounts in a Microsoft Exchange environment using the log files that are in a specified location

MessageFlow -p E -u all -L C:\logs

  • If you want to view the help information for the tool, including the list of available parameters, in the command window, type MessageFlow -? or MessageFlow -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.


Was this information helpful? Send us your comments.