Loading...

Data Analytics - Running an Analytics Job

Table of Contents

Analytics Job

If you need to analyze the data in a CommCell group on a regular basis, run analytics at the job level. Running analytics as a job offers more job-related options, such as the ability to schedule analytics jobs.

Supported Data Types

The following data types are supported by running analytics at the job level:

  • File system
  • Microsoft Exchange Mailbox
  • Mac
  • File system for Virtual Server (only supported by running Analytics at the client group level)

    Compliance Archiver jobs are not supported by Data Analytics.

Prerequisites

Ensure the following prerequisites are met before running an analytics job:

Run Analytics on a Client

You can perform Data Analytics on a client computer from the CommCell Console to collect analytics information about a single client.

Before You Begin

  • To collect information about file system data on a client, the client must have a supported file system agent installed.
  • To collect information about email data on a client, the client must have a supported email agent installed.
  • Data on the client must have been backed up at least once.
  • Note: You can only run analytics from the client level on non-virtual clients. To run analytics on VM clients, you must run analytics on a Client Computer Group that contains only the VM clients you want to analyze (see Running Data Analytics on a Client Computer Group).

Procedure

  1. Open the CommCell Console.
  2. In the CommCell Browser, click Client Computers.
  3. Right-click the client computer name that you want to use, point to All Tasks, and then click Run Analytics.
  4. In Data Analytics Options: client computer name, configure the options for the analytics operation:
    • To collect file system information on the client, click Files.
    • To collect analytics information for email data on the client, click Emails.
    • Click the Select Analytics Engine on MediaAgent list and select the MediaAgent name where you want to store the analytics data for this operation.
    • Under Number of Readers, configure the number of data streams that you want to use on the MediaAgent for this operation.
    • If you have previously run Data Analytics on the client with the same MediaAgent and want to delete the existing analytics data on the MediaAgent, select Clean Up Analyzed Data (if any).

      To keep any existing analytics data for the client, do not select the check box.

      Note: Selecting this option will permanently delete the analytics data for the client from the Analytics Engine index directory on the selected MediaAgent. Even if the analytics job fails, you will not be able to retrieve prior analytics data for the client from the Data Analytics reports.

  5. If you want to schedule the analytics operation, click Job Initiation and configure the scheduling options. For more information, see Scheduling Data Analytics Operations.
  6. To configure advanced options for the Data Analytics operation, click Advanced and configure the advanced options. For more information, see Configuring Advanced Options for Data Analytics Operations.
  7. When finished, click OK to run the operation as scheduled.

Run Analytics on a Client Group

You can perform Data Analytics on a client computer group from the CommCell Console to collect analytics information about one or more clients in a client computer group.

Running Analytics on Virtual Machines in a Client Group

Running analytics on VM clients is only supported at the client group level. When configuring the analytics job, you cannot exclude VM clients from the client group. Therefore, if you want to run analytics on groups of different VM clients, you must create separate client groups and run analytics on each group separately.

Before You Begin

  • To collect information about file system data on a client, the client must have a supported file system agent installed.
  • To collect information about email data on a client, the client must have a supported email agent installed.
  • Data on the clients must have been backed up at least once.

Procedure

  1. Open the CommCell Console.
  2. In the CommCell Browser, click Client Computer Groups.
  3. Right-click the client computer group name that you want to use, point to All Tasks, and then click Run Analytics.
  4. In Data Analytics Options: client computer group name, configure the options for the analytics operation:
    • To collect file system information on the selected clients, click Files.
    • To collect analytics information for email data on the selected client, click Emails.
    • Click the Select Analytics Engine on MediaAgent list and select the MediaAgent name where you want to store the analytics data for this operation.
    • To exclude clients from the analytics operation, under Client Computers in the Include list, select the clients that you want to remove and then click the left-arrow (<) button.

      The selected clients appear under the Exclude list. These clients will not be analyzed for this operation.

    • Under Number of Readers, configure the number of data streams that you want to use on the MediaAgent for this operation.
    • If you have previously run Data Analytics on the client with the same MediaAgent and want to delete the existing analytics data on the MediaAgent, select Clean Up Analyzed Data (if any).

      To keep any existing analytics data for the client, do not select the check box.

      Note: Selecting this option will permanently delete the analytics data for the client from the Analytics Engine index directory on the selected MediaAgent. Even if the analytics job fails, you will not be able to retrieve prior analytics data for the client from the Data Analytics reports.

  5. If you want to schedule the analytics operation, click Job Initiation and configure the scheduling options. For more information, see Scheduling Data Analytics Operations.
  6. To configure advanced options for the Data Analytics operation, click Advanced and configure the advanced options. For more information, see Configuring Advanced Options for Data Analytics Operations.
  7. When finished, click OK to run the operation as scheduled.

Run Analytics on a Storage Policy

Run analytics on a storage policy to collect information for the Data Analytics reports.

Consider the following before running analytics:

  • The MediaAgent associated with the storage policy must have the Analytics Engine configured, or the storage policy must be connected by a data path to another MediaAgent that has the Analytics Engine configured .
  • Only data from the most recent full, incremental, or synthetic full backup jobs are included in the analytics job. Information from differential backup jobs are not included in analytics.
  • Only clients and email servers with subclient data associated with in the storage policy will be available in the reports from the Web Console.
  • For a list of supported data types, refer to the list of supported data types.

  1. Open the CommCell Console, and then in the CommCell Browser click Policies > Storage Policies.
  2. Right-click the <storage policy> on which you want to run analytics, point to All Tasks, and click Run Analytics.
  3. In the Analytics Options: <Storage Policy> dialog box, select the analytics job options as follows:
    1. Select which type of analytics you want to perform as follows:
      To collect the metadata of... Then...
      only files
      • Select the Files check box.
      only emails
      • Select the Emails check box.
      both files and email
      • Select the Files and Emails check boxes.
    2. In the Select Analytics Engine on MediaAgent list, click the MediaAgent associated with the storage policy or connected to the storage policy by a data path.

      Only MediaAgents that are associated with the selected storage policy or connected by a data path are available in the Select Analytics Engine on MediaAgent list.

    3. In Client Computers under the Exclude list, click the clients or email servers that you want to analyze.
    4. Click Include to move the selected clients to the Include list.
    5. If you want to include all the clients in the list, click Include All.
    6. Under Number of Readers, select the number of data streams to be used by the analytics operation or select Allow Maximum to use the maximum amount of data streams available for the storage policy.
  4. Start the analytics job as follows:
    1. Click the Job Initiation tab.
    2. Select when the analytics job should be run as follows:
    3. To Run Analytics... Then...
      immediately
      1. Click Immediate.
      2. Click OK.
      on a regular schedule (daily, weekly, monthly, or annually)
      1. Click Schedule.
      2. Click Configure.
      3. The Schedule Details dialog box appears.
      4. Select the options to specify a schedule for analytics jobs.

        For detailed instructions, refer to Schedule Analytics Jobs.

      5. On the Schedule Details dialog box, click OK.
      6. In the Analytics Options: <Storage Policy> dialog box, click OK.
      repeatedly after at a specific interval of time
      1. Click Automatic Analytics.
      2. In the Interval <n> min(s) box, type or select how often you want to run analytics.

        For example, the default value will automatically run analytics every 30 minutes.

      3. Click OK.

        The first job will begin after the specified interval.

Schedule Analytics Jobs

Create a schedule for Data Analytics jobs with the options in the Schedule Details dialog box.

  1. In the Schedule Details dialog box, enter a name for the schedule in the Schedule Name box.
  2. Proceed as follows:
    To run an analytics job... Then... And...
    at a later date and time
    • Click One Time
    1. In the Select date and time of one time job section:
      1. Type or click the down arrow button to select a date to run analytics.
      2. Type or select a time of day to run analytics.
    2. Click Options.

      The Advanced Schedule Options dialog box appears.

    3. Proceed to step 5.
    • every day
    • every two days
    • every nth day
    • Click Daily
    1. In the Start Time box, type or select the time of day to run analytics.
    2. In the Every <n> Day(s) box, type or select the number of days between jobs.

      For example, select 1 to run analytics every day.

    3. Click Options.

      The Advanced Schedule Options dialog box appears.

    4. Proceed to step 3.
    on a specific day or days of
    • every week
    • every two weeks
    • every nth week
    • Click Weekly
    1. In the Start Time box, type or select the time of day to run analytics.
    2. In the On these days section, select the day or days of the week to run analytics.
    3. In the Every <n> Week(s) box, type or select the number of weeks between jobs.

      For example, select 1 to run analytics every week.

    4. Click Options.

      The Advanced Schedule Options dialog box appears.

    5. Proceed to step 3.
    on a specific day or occurrence of
    • every month
    • every two months
    • every nth month
    • Click Monthly
    1. In the Start Time box, type or select the time of day to run analytics.
    2. To run analytics on a specific day of the month:
      1. Click On day.
      2. Type or select the number day of the month.

      -or-

      To run analytics on a specific occurrence (for example, the First Sunday of the month):

      1. Click On the.
      2. Click the first list to select the occurrence.
      3. Click the second list to select the day of the week.
    3. In the Every <n> Month(s) box, type or select the number of months between jobs.

      For example, select 1 to run analytics every month.

    4. Click Options.

      The Advanced Schedule Options dialog box appears.

    5. Proceed to step 3.
    on a specific day or occurrence every year
    • Click Yearly
    1. In the Start Time box, type or select the time of day to run analytics.
    2. To run analytics on a specific date:
      1. Click On day.
      2. Type or select the number day of the month.
      3. In the Of Month list, select the month.

      -or-

      To run analytics on a specific occurrence (for example, the First Sunday of January):

      1. Click On the.
      2. Click the first list to select the occurrence.
      3. Click the second list to select the day of the week.
      4. In the Of Month list, select the month.
    3. In the Every <n> Month(s) box, type or select the number of months between jobs.

      For example, select 1 to run analytics every month.

    4. Click Options.

      The Advanced Schedule Options dialog box appears.

    5. Proceed to step 3.
  3. In the Start box, type or click the down arrow button to select a date to begin the schedule.
  4. Select an end to the schedule as follows:
    To... Then...
    continue the schedule indefinitely
    1. Select Never End.
    2. Proceed to step 5.
    end the schedule on a specific date
    1. Select End by.
    2. Type or click the down arrow to select a date when the schedule will end.
    3. Proceed to step 5.
    end the schedule after a specific number of occurrences
    1. Select End After.
    2. Type or select the number of times you want the schedule to run.
    3. Proceed to step 5.
  5. In the Time Zone list, select the time zone you want to use.
  6. Click OK.
  7. If you want to prevent analytics from running on certain days:
    1. Click Exceptions.

      The Exceptions dialog box appears.

    2. Click Add.

      The New Exception dialog box appears.

    3. Proceed as follows:
      To exclude... Then...
      a specific day or days of the month
      1. Click the Days list.
      2. Select the day or days of the month when the job should not run.
      3. Proceed to step d.
      • a specific day or days of the week
      • weekdays
      • weekends
      • occurrences (for example, the First Sunday of every month)
      1. Click On.
      2. Click the first list to select the occurrence or occurrences to exclude.

        For example, select First to exclude the first occurrence.

      3. Click the second list to select the day or days to exclude.

        For example, select Weekend Day to exclude the specified weekend.

      4. Proceed to step d.
    4. In the New Exception dialog box, click OK.

      The exception appears in the Exceptions dialog box.

    5. In the Exceptions dialog box, click OK.
  8. If you want to automatically run analytics jobs at regular intervals on days when analytics are scheduled to run:
    1. Select the Repeat every check box.
    2. In the Hr(s) and Min(s) boxes, type or select how often you want to repeat the analytics job.
    3. In the Until box, type or select the time to stop running jobs that day.
  9. In the Schedule Details dialog box, click OK.
  10. In the Analytics Options: <Storage Policy> dialog box, click OK to run analytics as scheduled.

Additional Options for Analytics Jobs

Configure additional options for an analytics job in the Advanced Analytics Options dialog box. These settings can be applied to either immediately run jobs or scheduled jobs.

  1. From the Analytics Options: <Storage Policy> dialog box, click Advanced.

    The Advanced Analytics Options dialog box appears.

  2. Select the additional analytics job options as follows:
    If you want to... Then...
    modify the job priority
    1. In the Startup tab, click Change Priority.
    2. Enter or select a priority number between 0 (highest priority) and 999 (lowest priority).
    manually start the job at a later time
    • In the Startup tab, select Startup in suspended state.

      The job appears in the CommCell console's Job Controller tab in a Suspended state.

    When you want to start the analytics job, open the Job Controller tab in the CommCell console, right-click the analytics job, and click Resume.

    provide a description for the job
    • In the Startup tab, type a description for the job in the Description box.
    set time limits for the job
    1. In the Job Retry tab, select Enable Total Running Time.
    2. Enter or select hours and minutes in the hr(s) and min(s) boxes.

      At the end of the specified time, if the job status is Running, the job will continue. If the job status is anything else, the job will be killed.

    3. If you want to automatically kill the job after the specified total running time has expired, select Kill Running Job When Total Running Time Expires.
    set the maximum number of times the job will be restarted until it starts successfully
    1. In the Job Retry tab tab, select Enable Number of Retries.
    2. Enter or select the maximum number of times the job will be restarted until it starts successfully.

      This setting will not be valid if Restartability has been turned off in the Job Management Control Panel.

    create an alert for the job
    1. In the Alert tab, click Add Alert.

      The Add Alert Wizard appears.

    2. Follow the wizard to create the alert.

      For detailed instructions, refer to Setting Up Alerts for a Job.

  3. In the Advanced Analytics Options dialog box, click OK.

View Reports from the Web Console

After running analytics on a storage policy, view the reports by logging in to the Web Console.