• All Files

Reveille Analytics Reports

The Generate Reports page enables you to generate a variety of reports in the format of your choosing. These reports can be exported, saved, or e-mailed. You can access your saved reports from the Saved Reports Page.

To generate a report:

  1. Select whether you want to generate a report for Protocols or Applications.
  2. Select the protocol or application from the list of currently licensed items.
  3. Select the report type.

    Protocol Types:

    • Average Number of Messages
    • Message Counts
    • Message Details
    • Message Response Time Summary
    • Packet Summary

     

     

    Application Types:

    • Application Details
    • Average Number of Transactions
    • Average Number of Users
    • Document Exceptions
    • Response Times
    • Top Documents
    • Top Documents by Size
    • Top Errors
    • Top Most Common Transactions
    • Top Search Terms
    • Top Searches by User
    • Top Users
    • Transaction Response Time Summary
    • Transaction Summary
    • User Activity
    • User Exceptions
    • User Transaction Counts
  4. Use the Calendar control to select the From (start) date. The current time is used by default.
  5. Use the Calendar control to select the To (end) date. The current time is used by default.
  6. Select any Additional Report Filters. Additional filters vary depending on report type. The following filters are available:
    • Client IP. Enter the client IP addresses that you want to include in the report. The default is all addresses (text box is empty).
    • Count Threshold. Enter the maximum number of user transaction counts to include in the report. The default is 100.
    • Group Transactions by Server. When selected, the report contains a section for each server. When not select, the report groups all transactions together with no indication of the server.
    • Include Message Data. Select to include any data associated with the messages in the report. The default is to not include message data.
    • Include Transactions in Error. Select to include any transaction currently in error status in the report. The default is to not include transactions in error.
    • Message Type. Select the type of protocol messages you want included in the report.
    • Minimum Number of Documents Accessed. The threshold for the minimum number of unique documents accessed for a document to be included in the Documents Accessed by User report section.
    • Minimum Number of Failed Logins. The threshold for a failed login to be included in the Users with X or more failed logins report section where X is the threshold value.
    • Number of Items. Enter the number of items to include in the report. Depending on the report type, Items will be replaced with one of the following: Documents, Top Errors, Top Transactions, Top Users, or Response Times. The default is 100.
    • Server. Select a specific server to include in the report. The default is All.
    • Server IP. Select a specific server IP address to include in the report. The default is All.
    • Top Searches. Enter the number of top searches to include in the report.The default is 100.
    • Transaction Type. Select the type of transaction the you want to include in the report. The default is All.
    • User IDs. Enter the user IDs that you want to include in the report. Separate each User ID by a comma. The default is all IDs (text box is empty).
    • User Lists. The file containing a list of users (up to 1000 users) in a CSV (Comma Separated Value) file. The location of the file is [<Reveille Installation Path>]\Reveille\Web\Reveille\App_Data\Reports\ directory. There can be multiple user lists files in the directory for file selection. If no file is selected all users will be included in the report.
  7. Click Generate when you have made all the necessary selections. The generated report appears in the work area. Notice that the caption that appears above the report uses the general form [Report Type] for [Application] From [Start Date] to [End Date].

    The Export, Save, and Email buttons are enabled for the newly generated report.

Exporting a Report

Once a report is generated, you can export it to your local machine by doing the following:

  1. Click Export. The Export panel appears.
  2. Enter the name of the exported file. The name uses this format:
    ReportTypeYYYYMMDDHHMM

  3. Select the format for the exported file:

    • PDF. Produces an export file with the file extension .pdf.
    • Text. Produces an export file with the file extension .txt.
    • Excel. Produces an export file with the file extension .xls.
  4. Click Export to save the report to your local machine. You can choose to open or save the report.
  5. Click Cancel to close the Export panel.

Saving a Report

Once a report is generated, you can save it to the Reveille User Analytics web site by doing the following:

  1. Click Save. The Save panel appears.
  2. Select the file format for the report:
    • PDF. Produces an export file with the file extension .pdf.
    • Text. Produces an export file with the file extension .txt.
    • Excel. Produces an export file with the file extension .xls.
  3. Enter general information to save with the report in the Comments field.
  4. Click Save to save the report. A message appears on the page confirming a successful save. You can access your saved reports through Saved Reports.
  5. Click Cancel to close the Save panel.

E-mailing a Report

Once a report is generated, you can e-mail it by doing the following:

  1. Click Email. The Email panel appears.
  2. Enter the name you want to use for the attached file.
  3. Select the format for the attached report:
    • PDF. Produces an export file with the file extension .pdf.
    • Text. Produces an export file with the file extension .txt.
    • Excel. Produces an export file with the file extension .xls.
  4. Do not change the From address.
  5. Enter the address of the recipient in the To field. You can add multiple recipients.
  6. Enter the subject of the e-mail. The default text is taken from the report settings and can be changed.
  7. Enter the message to be included in the e-mail. The default text is taken from the report settings and can be changed.
  8. Click Email to send the report to the designated recipient(s). A message appears on the page confirming a successful send.
  9. Click Cancel to close the Email panel.