4.5 Retain’s Reports

The following sections detail the content of each R&M report.

4.5.1 Audit User Activity

Report Contents: A summary of all specified auditable actions by each user.

See Table 2-20 for instructions on specifying which actions are logged and therefore available for reporting.

Path: Retain Reporting and Monitoring Server > Report or Schedule Report > Audit User Activity

Table 4-10 Configuring an Audit User Activity Report

Section or Item

Information or Action

Report Parameters

There are no report-specific parameters to set for this report.

For help with setting standard report parameters, such as email delivery and schedule settings, see Defining, Scheduling, and Managing Retain Reports.

Figure 4-2 Sample Audit User Activity Report

4.5.2 Export Audit Table

Report Contents: A customized view of the Audit Log, showing the users and events that you specify, with report contents organized by the column that you specify.

Path: Retain Reporting and Monitoring Server > Report or Schedule Report > Export Audit Table

Table 4-11 Configuring an Audit Table Report

Section or Item

Information or Action

Report Parameters

For help with setting standard report parameters, such as email delivery and schedule settings, see Defining, Scheduling, and Managing Retain Reports.

 

Sort Rows by Column

  1. Choose which column you want the report to be sorted by:

    • Date

    • Info

    • User

    • Mailbox

    • Job Name

    • Action

  2. Specify whether you want it sorted in ascending or descending order.

 

Action

  1. Select the Actions that you want included in the report.

    NOTE:Of course, if an action is not logged, it cannot appear in the exported table.

Run Report on

  1. Choose either All Users, or choose Select Users and pick those you want included from the list that displays.

  2. Click Generate.

Figure 4-3 Sample Export Audit Table Report

This report is also available on systems without a Retain Reporting and Monitoring Server installed. For help, see Auditing Option (Overview).

4.5.3 Job Run Averages

Report Contents: A.chart for one or more selected jobs, showing and comparing the jobs’ effectiveness, overall load, and performance.

Path: Retain Reporting and Monitoring Server > Report or Schedule Report > Job Run Averages

Table 4-12 Configuring a Job Run Averages Report

Section or Item

Information or Action

Report Parameters

For help with setting standard report parameters, such as email delivery and schedule settings, see Defining, Scheduling, and Managing Retain Reports.

 

Jobs

  1. Select one (or more) of the listed jobs that you want to view trends for (and optionally compare).

  2. Click Generate.

Figure 4-4 Sample Job Run Averages

You can see performance trends when you compare run time with message counts over a time period. The averages used to create the graph are listed above the graph; the legend is below.

4.5.4 Job Run Summary

The Job Run Summary report covers one job run in detail.

Path: Retain Reporting and Monitoring Server > Report > Job Run Summary

Table 4-13 Configuring a Job Run Summary Report

Section or Item

Information or Action

Report Parameters

For help with setting standard report parameters, such as email delivery and schedule settings, see Defining, Scheduling, and Managing Retain Reports.

Job Run Summary

 

Job Name > Select a Value drop-down

  1. Click the drop-down and select one of the listed job names to filter the Job list.

  2. Select one of the listed jobs.

  3. Click Generate.

Figure 4-5 A Sample Job Run Summary Report

The summary displays the total mailboxes, messages, data store, errors, and running time of the job. Afterwards, this information is broken down by each mailbox the job covers.

4.5.5 Job Summary

The Job Summary reports on the same statistics as the Job Run Summary report, but it summarizes the complete history for all runs of a given job rather than a single run.

Path: Retain Reporting and Monitoring Server > Report or Schedule Report > Job Summary

Table 4-14 Configuring a Job Summary Report

Section or Item

Information or Action

Report Parameters

For help with setting standard report parameters, such as email delivery and schedule settings, see Defining, Scheduling, and Managing Retain Reports.

Job Summary

 

 

Job Name

  1. Select one of the listed jobs.

    All of the jobs with that name are selected in the background.

  2. Click Generate.

Figure 4-6 A Sample Job Summary Report

4.5.6 Archive Summary by User

This report summarizes the archive history for selected users, including pertinent information for each mailbox over the previous 3 months.

While the report cannot be sorted after it is generated, it may be sorted at generation through the ‘Sort Rows by Column’ feature. The columns may be sorted by either descending or ascending order. Select ‘Generate’ to create the report.

Path: Retain Reporting and Monitoring Server > Report or Schedule Report > Archive Summary by User

Table 4-15 Configuring an Archive Summary by User Report

Section or Item

Information or Action

Report Parameters

For help with setting standard report parameters, such as email delivery and schedule settings, see Defining, Scheduling, and Managing Retain Reports.

Sort Rows by Column

  1. Choose which column you want the report to be sorted by:

    • User Name

    • Messages Processed

    • Messages Archived

    • Disk Space Used

    • Retention Flag

    • Purge Flag

    • Last Archive Flag

  2. Specify whether you want it sorted in ascending or descending order.

 

Maximum Returned Rows

  1. Use this to limit the size of the report.

 

Run Report On

  1. Choose either All Users, or choose Select Users to specify a subset from the list that displays.

The report displays the total information for every mailbox selected, including: User name, the time stamps and their advanced dates, and the message store for the associated user.

Figure 4-7 A Sample Archive Summary by User Report

Administrators often use this report to monitor disk space usage and messages processed and stored on a user-by-user basis.

4.5.7 Archive Summary by Module

Administrators find this report especially useful for monitoring archiving by push-based messaging systems that don’t have admin-created Jobs.

Push-based modules include:

  • Mobile

  • AT&T

  • Celltrust

  • GBS Notes

  • BBM

  • Ionlake

  • Tele Messages

  • UM Labs

Path: Retain Reporting and Monitoring Server > Report or Schedule Report > Archive Summary by Module

Table 4-16 Configuring an Archive Summary by Module Report

Section or Item

Information or Action

Report Parameters

For help with setting standard report parameters, such as email delivery and schedule settings, see Defining, Scheduling, and Managing Retain Reports.

Module

  1. Select one or more modules from the list.

  2. Click Generate.

4.5.8 Server Utilization

The Server Utilization report shows the memory, CPU utilization, archive size, thread usage, index size, heap memory, and non-heap memory usage for the Retain server.

Path: Retain Reporting and Monitoring Server > Report or Schedule Report > Server Utilization

Table 4-17 Configuring an Archive Summary by Module Report

Section or Item

Information or Action

Report Parameters

For help with setting standard report parameters, such as email delivery and schedule settings, see Defining, Scheduling, and Managing Retain Reports.

Module

  1. Specify the date range you want to examine.

  2. Click Generate.

Figure 4-8 A Sample Server Utilization Report

4.5.9 Job Run Mailbox Summary

The report shows the user name, messages archived, disk space used, and archiving time for each mailbox as well as for the total job run.

Path: Retain Reporting and Monitoring Server > Report > Job Run Mailbox Summary

Table 4-18 Configuring a Job Run Mailbox Summary Report

Section or Item

Information or Action

Report Parameters

For help with setting standard report parameters, such as email delivery and schedule settings, see Defining, Scheduling, and Managing Retain Reports.

Job Runs List

 

Job Name > Select a Value drop-down

  1. Click the drop-down and select one of the listed job names to filter the Job list.

  2. Select one of the listed jobs.

Run Report on

  1. Choose either All Users, or choose Select Users and pick those you want included from the list that displays.

  2. Click Generate.

Figure 4-9 A Sample Job Run Mailbox Summary Report

This report cannot be scheduled.

4.5.10 Job Mailbox Summary

The Job Mailbox Summary report displays the number of messages archived, the disk space used, and the time the job took, by individual, specified mailboxes (users).

Path: Retain Reporting and Monitoring Server > Report or Schedule Report > Job Mailbox Summary

Table 4-19 Configuring a Job Mailbox Summary Report

Section or Item

Information or Action

Report Parameters

For help with setting standard report parameters, such as email delivery and schedule settings, see Defining, Scheduling, and Managing Retain Reports.

Jobs List

 

Sort Rows by Column

  1. Choose which column you want the report to be sorted by:

    • User Name

    • Messages Archived

    • Disk Space Used

    • Archiving Time

  2. Specify whether you want it sorted in ascending or descending order.

Job Name > Select a Value drop-down

  1. Select one of the listed Job Names.

    All of the Job Name entries are selected in the background

Run Report on

  1. Choose either All Users, or choose Select Users, select a Mail Server from the drop-down list, specify the users that you want included.

  2. Click Generate.

Figure 4-10 A Sample Job Mailbox Summary Report

4.5.11 Device Management

The device management report generates the device registration details by user, generation time, registration time.

Path: Retain Reporting and Monitoring Server > Report or Schedule Report > Device Management

Table 4-20 Configuring a Device Management Report

Section or Item

Information or Action

Report Parameters

For help with setting standard report parameters, such as email delivery and schedule settings, see Defining, Scheduling, and Managing Retain Reports.

Sort Rows by Column

  1. Choose which column you want the report to be sorted by:

    • Registration Date (date the user was officially registered)

    • Generation Date (when the registration process began)

    • User Name

    • Email

  2. Specify whether you want it sorted in ascending or descending order.

Actions

  1. Select the user types you want included (Registered, Non-registered, or both)

Email Details

  1. You must specify a valid SMTP configuration.

    Browser delivery is not available.

Report Schedule

  1. Specify when and how often you want the report generated and sent.

  2. Click Schedule.

Figure 4-11 A Sample Device Management Report