Loading...

Data Analytics - Running the Analytics Workflow

Table of Contents

Analytics Workflow

In addition to running Data Analytics at a job level in a single CommCell environment, you can use the Analytics Workflow to create Data Analytics reports for:

  • Clients in a single current version CommCell environment
  • Clients spread across multiple current or previous version CommCell environments
  • Computers that are not in a CommCell environment with the System Discovery Tool

The Analytics Workflow is especially useful for analyzing client data in a large enterprise with clients in multiple current or previous version CommCell environments.

Supported Data Types

The following data types are supported by Analytics Workflow:

  • File system
  • NAS
  • Microsoft Exchange Mailbox
  • File System for Virtual Server

    Archiver agents are not supported by Data Analytics.

Supported CommCell Versions

Clients in the version 9 to the current version CommCell environments are supported by the Analytics Workflow.

Limitations

When creating File Analytics reports with the Analytics Workflow, the plot duplicates by content option is not available in the Duplicate Files Report. This option is only supported when running analytics as a job.

If you have client computers that are in a CommCell group but have not been backed up, then you must configure the Analytics Workflow with the System Discovery Tool. For more information, see Configure the Analytics Workflow for Computers without a SnapProtect Agent

Prerequisites

Ensure the following prerequisites are met before running the Analytics Workflow:

  • The SnapProtect Workflow software must be deployed in your environment. See Workflow - Getting Started.
  • Disable User Access Control (UAC) on the machine where Workflow Engine is installed. See Microsoft documentation for instructions.
  • The Analytics Engine must be configured on a Windows MediaAgent. See Configure the Analytics Engine.

    If you plan to use the Analytics Workflow with computers that are not in a CommCell environment using the System Discovery Tool or Exchange System Discovery Tool, then the Analytics Engine must be configured on the same machine where the Workflow Engine is installed.

  • The CommCell user running the analytics workflow must be a member of a user group with a role that includes the following workflow capabilities (see Associating Entities and Roles to a User Group):
    • Administrative Management
    • Agent Management
    • Data Protection/Management Operation
    • Storage Policy Management
    • View
  • The CommCell user running the analytics job must also be a member of a user group that is associated to the client computer group that is included in the analytics workflow. See Associating Entities and Roles to a User Group.

Configure Analytics Workflow

Refer to the following chart to determine which configuration procedure you should perform:

To analyze clients that are... Then refer to the steps for configuring the Analytics Workflow...
In a single CommCell environment For Clients in a Single CommCell Environment
Spread across multiple CommCell environments For Clients in Multiple CommCell Environments
Not in a CommCell environment For Computers Without a SnapProtect Agent

For Clients in a Single CommCell Environment

Configure the Analytics Workflow to create Data Analytics reports for the clients in a single CommCell environment.

  1. Log in to the CommCell Console where Workflow Engine is installed.
  2. Create a Client Computer Group that contains the clients that you want to analyze.

    For instructions, refer to Client Computer Groups - Getting Started.

  3. Proceed to Execute the Analytics Workflow.

For Clients in Multiple CommCell Environments

Configure the Analytics Workflow to create Data Analytics reports for the clients that are spread across multiple CommCell environments.

  1. For each remote CommCell environment with clients that you want to analyze, log in to the CommCell Console and create a Client Computer Group that contains the clients that you want to analyze.

    For instructions, refer to Client Computer Groups - Getting Started.

  2. Log in to the CommCell Console where Workflow Engine is installed.
  3. Register all of the remote CommCell environments to the CommCell environment where Workflow Engine is installed.

    For instructions, refer to Registering a Remote CommCell.

  4. In the CommCell environment where Workflow Engine is installed, create a Client Computer Group with the same Group Name as each of the Client Computer Groups created in the remote CommCell environments.

    You do not have to add clients to the duplicate Client Computer Groups in the CommCell environment where Workflow Engine is installed. Client names are automatically added from remote CommCell environments during the Analytics Workflow job.

    For example, if Analytics Group 1, Analytics Group 2, and Analytics Group 3 were created in remote CommCell environments, then create Client Computer Groups named Analytics Group 1, Analytics Group 2, and Analytics Group 3 in the CommCell environment where Workflow Engine is installed.

    For instructions, refer to Client Computer Groups - Getting Started.

  5. On the machine where Workflow Engine is installed, install one instance of the MediaAgent software in restore only mode for each remote CommCell environment.

    For example, if you registered five remote CommCell environments in step 3, install five additional instances of the MediaAgent software in restore only mode on the machine where Workflow Engine is installed.

    For instructions on... Refer to
    Installing the MediaAgent software MediaAgent Installations
    Installing software in restore only mode Installing Restore Only Agents
    Installing multiple software instances on the same computer Enabling Multi-Instance Installations
  6. Proceed to Execute the Analytics Workflow.

For Computers Without a SnapProtect Agent

Configure the Analytics Workflow to create Data Analytics reports for computers that are not in a CommCell environment or client computers that have not been backed up using the System Discovery Tool for file system data and the Exchange System Discovery Tool for Exchange email data. The System Discovery Tool and Exchange System Discovery Tool require input files, which provide information about the clients that you want to analyze for the Analytics Workflow.

  1. On the machine where Workflow Engine is installed, proceed as follows:
    To analyze... Then...
    File system data
    • Download the System Discovery Tool from the Cloud Services site and extract the .exe file into to the <software installation path>\Base folder.

      Refer to Downloading the System Discovery Tool for more information.

    Microsoft Exchange email data
  2. Log in to the CommCell Console where Workflow Engine is installed.
  3. Create at least one Client Computer Group for each type of data that you want to analyze.

    For example, create a Client Computer Group for computers with Microsoft Windows file system data named Analytics Windows, create a separate Client Computer Group for computers with UNIX file system data named Analytics UNIX, and create a separate Client Computer Group for computers with Microsoft Exchange data named Analytics Exchange.

    For instructions, refer to Client Computer Groups - Getting Started.

  4. Create a System Discovery Tool input file as follows:
    To analyze... Then...
    File system data
    1. Download the sample input file for file system data.
    2. Replace the information in the sample input file with the information for the clients in the Client Computer Group that you want to analyze.
    3. Create a separate input file for each file system Client Computer Group that you want to analyze.

      When running Analytics Workflow on NAS data, consider the following:

      • If you want to run the Analytics Workflow on separate folders on the same NAS filer, then you must create a separate input file for each folder and run separate workflow jobs. For example, the NAS shares \\myFiler1\test\share1 and \\myFiler1\test\share2 must be included in separate input files. Also, each share must be run in its own workflow job.
      • You can include separate NAS filers in the same input file. For example, the NAS shares \\myFiler1\test\share1 and \\myFiler2\test\share1 can be in the same input file.

    Microsoft Exchange email data
    1. Download the sample input file for Exchange email data.
    2. Replace the information in the sample input file with the information for the Exchange client that you want to analyze.
    3. Create a separate input file for each Exchange client that you want to analyze.
  5. Proceed to Execute the Analytics Workflow.

Execute the Analytics Workflow

After configuring the Analytics Workflow according to the types of clients, computers, and data that you want to analyze, you can execute the Analytics Workflow.

Consider the following before executing the Analytics Workflow:

If you want to analyze... Then consider the following...
Clients from a local or remote CommCell environment.

-or-

Computers with file system data that do not have a SnapProtect agent installed.

The Analytics Workflow must be executed separately for each Client Computer Group.
Computers with Exchange email data that do not have a SnapProtect  agent installed
  • The Analytics Workflow must be executed separately for each computer using separate input files.
  • Reports appear in the Web Console according to the CommCellClientName parameter. Therefore, if multiple input files have identical CommCellClientName parameters, the mailbox data associated with this files will appear in a single report in the Web Console.
  1. Log in to the CommCell Console where Workflow Engine is installed, and in the CommCell Browser click Workflows.
  2. In the Workflows tab, right click the Analytics workflow, point to All Tasks, and then click Execute.
  3. In the Analytics Options dialog box in the Inputs tab, click the Run workflow on list and select the computer where Workflow Engine is installed.
  4. Click the Client Group list and select the Client Computer Group that you want to analyze.
  5. Click the Application Type list and select the appropriate data type from the list for the selected Client Computer Group.

    -or-

    If you selected a Client Computer Group that contains computers without a SnapProtect agent installed, click the Application Type list select System Discovery.

  6. Click the Analytics Engine MA list and select the MediaAgent configured with the Analytics Engine that you want to use for the Analytics Workflow job.
  7. Proceed as follows:
    If you want to execute Analytics Workflow on... Then...
    Clients associated to the local CommCell environment where the Workflow Engine is installed
    1. Click the CommCell type list and select Local.
    2. Proceed to step 8.
    Clients associated to a remote CommCell environment
    1. In the Inputs tab, select the Perform CommCell Migration check box.
    2. If you selected a Client Computer Group from a 9.0 CommCell environment with file system or NAS data, click the Cross Commcell AppTypeName list and select the appropriate application type name.
    3. Click the CommCell type list and select Remote.
    4. In the Remote CommCell AliasName box, type the name of the remote CommCell environment as it appears in the CommCell Console.
    5. Proceed to step 8.
    Computers that are not associated to a CommCell environment
    1. In the Inputs tab, in the System Discovery Username box, enter a valid username for the computers that you want to analyze.
    2. In the System Discovery Password box, enter the password for the username in the System Discovery Username box.
    3. Click the System Discovery Client Type list and select the appropriate type of data on the computers in the selected Client Computer Group.
    4. In the System Discovery Input File box, enter the relative path of the appropriate System Discovery input file you want to use. The path should be relevant to the Workflow Engine machine.
    5. Proceed to step 8.
  8. Schedule the job as follows:
    If you want to run the Analytics Workflow job... Then...
    Immediately
    • In the Analytics Options dialog box, click OK.

      The Analytics Workflow job starts immediately and appears in the Job Controller tab.

    On a schedule
    1. In the Analytics Options dialog box, click the Job Initiation tab.
    2. Click Schedule and then click Configure.
    3. Configure the options in the Schedule Details dialog box to meet your requirements.

      For information about scheduling jobs, refer to Scheduling - Getting Started.

    4. After configuring a schedule, in the Schedule Details dialog box click OK.
    5. In the Analytics Options dialog box, click OK.

      The Analytics Workflow job will start as scheduled.

View Reports from the Web Console

After running the Analytics Workflow, view the reports by logging in to the Web Console. Refer to the File Analytics Report and Email Analytics Report documentation for detailed instructions.