Backup Job Summary Report

About Example

Table of Contents

About this Report

When to use this Report

What this Report Contains

How to Generate the Report

Scheduling the Report

Customizations That You Can Perform With This Report

Additional Options

About this Report

The Backup Job Summary Report displays information about backup jobs for each agent and each client in the CommCell.

When to use this Report

You can use the Backup Job Summary Report to review information related to all backup jobs. This report is useful if you need to know:

What this Report Contains

This report presents the data in the following sections:

Sections Description
Summary (Agent) This table provides information about backup jobs per agent. Information displayed in the table includes:
  • Total number of jobs for each agent
  • Total number of jobs in each status that you selected
  • The size of the job, compression rate, and the amount of data written
  • Start time and end time of all jobs for each agent
  • Total number of failed objects and folders
Summary (Client) This table provides information about backup jobs per client computer. Information displayed in the table includes:
  • Name of the client and its associated agent and backup set
  • Type of backup jobs
  • Start time and end time for writing data in all jobs
  • Transfer time of data for all jobs
  • Throughput rate for jobs on each computer
  • Total number of failed objects and folders for each computer
  • Error reason and description, if applicable

How to Generate the Report

1.

On the CommCell Console toolbar, click the Reports button.

The Report Selection dialog box appears.

2. From the Reports pane, select Job Summary.

On the General tab, select Data Management, and then select Backup.

Click Run.

The report appears in your default Web browser.

Scheduling the Report

1.
  • From the CommCell Browser, click the Tools menu and click Reports.
  • In the Report Selection pane, click a report and click Schedule.
 

 

2.
  • Type a name in the Schedule Name box.
  • Select Daily.
  • Type the Start Time to start the schedule.
  • Click Ok.

Customizations That You Can Perform With This Report

You can further customize the report by using the tabs that are available in the Report Selection dialog box. The following table describes the available report options for this report.

Options Description
General You can generate any of the Job Summary reports from this tab, including the Backup Job Summary Report. You can also filter the jobs that appear in the report by entering a job description.
Computers On this tab, you can set the report to run at the client and agent level or at the subclient level.

You can set the report to display information for all computers from the CommCell or select individual clients with the Modify option. You can set the report to include all agent types in the CommCell, or select individual agent types with the Modify option.

Alternatively, you can set the report to display information for all subclients or select individual subclients on the View and Edit tabs.

Selection On this tab, you can set the report to include information regarding diagnostics, contents, storage, and other job details. Set any of the following options:
  • Include failure reason, job attempts, and associated events
  • Include subclient content and filters, protected objects, failed objects, content indexing failures, and stubbed files
  • Include associated media, drive, storage policies, and MediaAgents
  • Include job options, job description, user information and client description
  • Include aged data, media-deleted jobs, backup files, backup copy jobs, and snap backup jobs
  • Allow dynamic content for associated events and job options
  • Filter the report to show only coverage or the last job for each subclient
Options On this tab, you can set the report to include information regarding backup types, job status, throughput unit, and job retention settings, set the job time, and set the data size display. Set any of the following options:
  • Include differential, full, synthetic full, and incremental backup types in the report
  • Include jobs that are in active, completed, delayed, failed, killed, completed with errors, completed with warnings status and jobs that were not scheduled, and not run
  • Show throughput unit in GB/hour or MB/second
  • Show data size in GB or MB
  • Display job times in the time that is set for the CommServe or the Client computer
  • Display increases or decreases in data size
  • Display jobs that are set to basic retention and extended retention
Time Range

You can choose to include information from a specific time range in the report.

  • Choose a number of hours, days, or weeks from the list. The report information ends at the time that you generate the report.
  • Select a time zone, and then enter a range of time from a specific date and time to another specific date and time.
  • Set the report to start at the first job that occurred in the CommCell, or enter a specific date and time in the Jobs On section.
  • Set the report to end at the last job that occurs in the CommCell before you run the report, or enter a specific date and time in the Jobs On section.
Output

You can set the report output to appear in one of several  formats and save it to a variety of locations. All options for the output format are not available for all report types. Set any of the following options:

  • Generate the report in an available format.

    • HTML: Full version or the shorter Summary version, if available

    • Text separated by commas or tabs: Full version or Short version for output to pagers, if available

      Reports that consist of multiple tables contain each table in a separate text file. Therefore, the text output for one report might consist of multiple text files.

    • PDF

    • XML

  • Enter a location to save the report in one of these locations:

    • On your local computer
    • On a shared network drive
    • An FTP location to which you can upload.

      When the text output consists of multiple files, they are compressed into a CAB file and sent as an attachment. Text output that consists of a single file is sent according to your settings.

  • Choose a language from the Choose Locale list to set the report to appear in that language.

Additional Options

The following table describes additional operations that you can perform with the reports feature:

Option Description Related topics
Saving the Report Output

You can save the report output to a specified location.

  1. On the CommCell Console toolbar, click the Reports button.

    The Report Selection dialog box appears.

  2. From the Reports pane, select the report that you want to generate.
  3. From the Output Format section, select a file format.
    • HTML
    • Text
    • PDF
  4. Select Output To, and then enter the location to which you want to save the report.
    • To save the report to your local computer, select Use Local Drive On, and then in the Report Copy Location box, enter a location.
    • To save the report to a shared network drive, select Use Network Share, and then in the Report Copy Location box, enter a location.
    • To upload the report to an FTP site, select FTP Upload, and then click Settings to enter the FTP location and your credentials.
  5. From the Choose Locale list, select the language in which you want the report to appear.
  6. At the bottom of the Report Selection dialog box, click Run.

    The report opens in the file format that you specified and a copy of the report is saved to the location that you entered.

 
Saving a Report as a Template

You can save the report settings as a template in the CommCell Console, and then run the report at any time.

  1. On the CommCell Console toolbar, click the Reports button.

    The Report Selection dialog box appears.

  2. From the Reports pane, select the report that you want to save.
  3. At the bottom of the Report Selection dialog box, click Save As.

    The Save As dialog box appears.

  4. Select Save a Report, and then enter a name for the report template in the box.
  5. Click OK.

    The report template appears under Reports > My Reports on the General tab.

 
Generating a Report from a Template

You can generate a report from a template at any time.

  1. From the CommCell Browser, expand Reports > My Reports, and then click General.

    The General tab appears in the CommCell Console.

  2. In the General tab, right-click the name of the report that you want to generate, and then select Run Immediately.

    The report opens in the format that is specified in the template.

 
Modifying a Report Template
  1. From the CommCell Browser, expand Reports > My Reports, and then click General.

    The General tab appears in the CommCell Console.

  2. In the General tab, right-click the name of the report that you want to change, and then select Edit.

    The Saved Reports dialog box appears.

  3. Select the Report Details tab, and then make changes on any of the available tabs.
  4. Click OK to save your settings.
 
Cloning a Report Template
  1. From the CommCell Browser, expand Reports > My Reports, and then click General.

    The General tab appears in the CommCell Console.

  2. In the General tab, right-click the name of the report that you want to clone, and then select Edit.

    The Saved Reports dialog box appears.

  3. Select the Job Initiation tab, and then select Saved Report.
  4. Select Clone this report as, and then enter a name in the box.
  5. Click OK.

    The cloned report appears in the General tab.

 
Deleting a Report Template
  1. From the CommCell Browser, expand Reports > My Reports, and then click General.

    The General tab appears in the CommCell Console.

  2. In the General tab, right-click the name of the report that you want to delete, and then select Delete.

    A message appears that asks if you are sure that you want to delete the selected Report Template.

  3. Click Yes.

    The report is removed from the General tab.

 
Setting a Report Alert This option allows users or user groups to get an automatic notification when a report is created. If the report output consists of multiple text files, they are compressed into a CAB file and sent as an attachment. Text output that consists of a single file is sent according to your settings.

Follow the steps given below to set up the criteria to raise notifications/alerts:

  1. From the CommCell Console toolbar, click the Reports button.

    The Report Selection dialog box appears.

  2. From the Reports pane, select a report, and then click Schedule.

    The Schedule Details dialog box appears.

  3. Select the Notification tab, and then click Add Alert.
  4. From the Add Alert Wizard dialog box, select the types of notifications that you want to send, and then click Next.
  5. Add recipients to the selected list.
    • To add a recipient that is a user in the CommCell, from the Available list, select a user, and then click Add.
    • To add a recipient that is not a user in the CommCell, in the Email to Recipients box, enter an e-mail address.
  6. Click Next, and then click Finish.
  7. Click OK to save your settings.
Refer to Alerts.
Saving a Report as a Script

The Command Line Interface allows you to generate reports from the command line. The commands can be executed from the command line or can be integrated into scripts. You can generate command line scripts for specific operations in the CommCell Console by using the Save As Script option.

To create an XML script that generates a report:

  1. From the CommCell Browser, expand Reports > My Reports, and then click General.

    The General tab appears in the CommCell Console.

  2. In the General tab, right-click the name of the report that you want to save as a script, and then select Edit.

    The Saved Reports dialog box appears.

  3. Select the Job Initiation tab, and then click Save As Script

    The Save As Script dialog box appears.

  4. Enter the appropriate settings to generate a script file.
    1. From the Client list, select the name of the client where you want to save the script.
    2. In the Path box, enter the file path where you want to save the script, and then enter a name for the script file at the end of the path.

      Ensure that the name of the file contains the .xml extension

    3. Click OK to create the script.

      A message appears that says that the script saved successfully

    4. Click OK.

    The Save As Script and the Saved Reports dialog boxes close.

Refer to Command Line Interface.