File Level Analytics 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 File Level Analytics Report displays a list of all files on the selected subclient and MediaAgent or the specified backup job at the current time. There must be a MediaAgent installed on the CommServe in order run this report. Information for the selected subclient includes files that were included in the latest backup cycle. Information for the specified job ID includes all files that were backed up during the job.

When to use this Report

You can use the File Level Analytics Report to review all files on a subclient. 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 This table provides information about files on the subclient that match the filter criteria. For more information about filter criteria, see Filters. Information displayed in the table includes:
  • Total number of files on the subclient.
  • Total size of all files on the subclient.
Details This table provides information about each file on the subclient. The information that appears in this table depends on the filter criteria that you configure and the columns that you select on the Output tab. Information displayed in the table can include:
  • The name and location of each file.
  • The size of each file.
  • The time at which the file was last modified.
  • The name of each file.
  • The time at which the file was last accessed.
  • The time at which the file was created.
  • The name of the user who owns the file.
  • The name of the user group to which the user belongs.

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 File Level Analytics, and then 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 On this tab, you can select the subclient and MediaAgent for which information is included in the report or enter a job ID. Options include the following:
  • Select the subclient for which to report data
  • Enter the individual Job ID
  • Select the MediaAgent for which to report data

    You must select a MediaAgent for the selected subclient. If you do not select a MediaAgent, then the first MediaAgent in the list is used. You cannot select a MediaAgent for the job ID option.

Filters On this tab, you can configure filters that determine the information that appears in the report. To make Access Time and Creation Time appear in the report, you must also set the Access Time and Creation Time columns to appear in the report on the Output tab. Options on this tab include the following:
  • When you set the Modification time option, only files that were last modified during the specified time appear in the report.

    Select greater than or equal to, or lesser than or equal to, and then enter the number of years, months, and/or days.

  • When you set the File Size option, only files that match the size criteria appear in the report.

    Select greater than or equal to, or lesser than or equal to, and then enter a file size.

  • When you set the Access Time option, only files that were last accessed during the specified time appear in the report.

    Select greater than or equal to, or lesser than or equal to, and then enter the number of years, months, and/or days.

  • When you select Creation Time, only files that were created during the specified time appear in the report.

    Select greater than or equal to, or lesser than or equal to, and then enter the number of years, months, and/or days.
Output

You can set the report output to appear in one of several  formats and save it to a variety of locations. Set any of the following options:

  • Select additional columns to include in the details table.
  • Generate the report in one of the following formats:
    • HTML

      To specify the number of rows that appear on each page of the report, enter a number in the Row Limit box.

    • Text separated by commas or tabs.
  • 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.
  It is recommended that you schedule this report, rather than running the report on demand. For instructions, see Scheduling the Report.

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.