Advanced Configuration - Web Console

Table of Contents

Configuring End-User Operations on Client Computers

The following sections provide additional configurations for end-users who have access to client computers from the Web Console.

Defining the Capabilities for Laptop Users

As a security method to control CommCell operations, you can assign specific capabilities to client owners. This is useful for laptop clients, as each client has a different owner. By defining specific capabilities to client owners, you can enable or disable specific options in the Web Console. (The client owner capabilities are in addition to any CommCell Console user group capabilities a user may have.)

Notify the client owners when you add or remove capabilities. Client owners need to log off from the Web Console and then log on again for the changes to take effect.

The following table provides the list of CommCell capabilities needed to perform operations from the Web Console:

Page Available Controls CommCell Capability Description
Summary Backup Now button Data Protection Operations Run the incremental backup jobs, but not cancel or suspend the backup job.
Summary Pause, Resume, and Kill links available when a backup job runs Job Management Pause, resume, or kill the backup job.
Summary +Schedule button and links for existing schedules Data Protection Operations and Agent Scheduling Perform the following in the Web Console:
  • Create a new schedule
  • Modify/Delete the existing schedules created by the user
Summary Edit link in the Backup Content section Agent Management Perform the following in the Web Console:
  • Add a new content path
  • Modify/Delete the existing content path created by another user
  • Exclude specific content
Restore Files Restore button Browse, In Place Recover, and Out of Place Recover Perform the following in the Web Console:
  • Restore the backed up data to the same place/different place as the original data protection operation
  • Restore backed up data from a specific date or time range
Restore Files Download button Users can have either of these groups of capabilities:
  • Browse, Compliance Search, and Download
  • End User Access and Download

(For end user access, you must enable the end user access control list option for the client computer)

Download one or more backed up files and folders to a specific location in the computer used for accessing the web console.
Restore Files Upload button Users can have either of these groups of capabilities:
  • Browse and Upload
  • End User Access and Upload

(For end user access, you must enable the end user access control list option for the client computer)

Upload one or more files and folders to a specific location in the client computer from the web console.
Restore Files Share button Sharing Share files and folders with other users.
Restore Files Show live machine data link Users can have either of these groups of capabilities:
  • Browse and Live Browse
  • End User Access and Live Browse

(For end user access, you must enable the end user access control list option for the client computer)

Browse both backed up and non-backed up (live) data on the client computer.
Restore Files Use the search field in the upper right of the page Users can have either of these groups of capabilities:
  • Browse and Compliance Search
  • End User Access

(For end user access, you must enable the end user access control list option for the client computer)

Search the data backed up from the client computer.

The search capability provided in the Web Console also allows users to search through the contents of the backup data.

My Data Restore button For CommCell users: Browse

For domain users: Browse or End User Access

(For end user access, you must enable the end user access control list option for the client computer)

Open the Restore Files page.
My Data Synch tab Users can have either of these groups of capabilities:
  • Browse, In Place Recover, and Out of Place Recover
  • End User Access, In Place Recover, and Out of Place Recover

(For end user access, you must enable the end user access control list option for the client computer)

Synchronize a set of files and folders with up to three computers at once.

You can assign capabilities for all client owners in the CommCell or for only the client owners of a particular client as explained in the following sections:

At the CommCell Level

Assigning capabilities at the CommCell level results in the capabilities assigned universally to all client owners. When clients are installed to this CommCell, they automatically inherit the capabilities set at this level.

Use the following steps to assign capabilities for all client owners in the CommCell:

  1. From the CommCell Console ribbon, click the Home tab, and then click Control Panel.
  2. In the System section of Control Panel, click System Owner Capabilities.
  3. From the Available Capabilities list, select the capabilities that you want to assign as security rights.
  4. Click Include > to move the selected capabilities to the Assigned Capabilities list.
  5. Click OK.

At the Client Group Level

Assigning capabilities at Client Group level results in the capabilities assigned universally to all client owners residing in that particular client group. When clients are installed pointing to this specific client group, they automatically inherit the capabilities defined at this level. Capabilities defined at the CommCell level appear grayed out and cannot be removed at the client group level.

Use the following steps to assign more capabilities for clients at client group level.

  1. From the CommCell Browser, navigate to Client Computers Groups.
  2. Right-click the <Client Group> and then click Properties.
  3. From the Client Group dialog box, click the Security tab.
  4. Click Owner Capabilities.
  5. From the Client Owner Capabilities dialog box, select the capabilities that you want to assign from the Available Capabilities list.
  6. Click Include > to move the selected capabilities to the Assigned Capabilities list.
  7. Click OK.

At the Client Level

You can define capabilities at a more granular level for client owners of a specific client computer. This is useful if you have assigned only a few basic capabilities (such as Browse and View) at the CommCell level and you want to assign more client owner capabilities to specific clients. Capabilities defined at the CommCell and Client Group level appear grayed out and cannot be removed at the client level.

Use the following steps to assign more capabilities for client owners of a specific client.

  1. From the CommCell Browser, navigate to Client Computers.
  2. Right-click the <Client> and then click Properties.
  3. From the Client Computer Properties dialog box, click the Security tab.
  4. Under the Client Owners area, click Client Owner Capabilities.
  5. From the Client Owner Capabilities dialog box, select the capabilities that you want to assign from the Available Capabilities list.
  6. Click Include > to move the selected capabilities to the Assigned Capabilities list.
  7. Click OK.

Configuring Privacy

For the Privacy setting in the Web Console to be functional, the Prevent admin access to user data check box must be selected.

Configuring Alerts for End-Users

By default, the following subscription-based alerts are configured and available for end-users to select:

  • No backup for last 4 days

    This is a Job Management - Data Protection alert, which sends an individual email notification to the end-user when no backup occurs in the last 4 days.

  • Recovery Job failed

    This is a Job Management - Data Recovery alert, which sends an individual email notification to the end-user when a restore operation fails.

You can set up and configure Data Protection and Data Recovery alerts to be used by Web Console users. A CommCell administrator can select which clients to associate with these subscription-based alerts, and client owners of all clients that are part of the entity selection list, are automatically subscribed to the alert notifications as well. Client owners can unsubscribe from these alerts via the Web Console.

Subscription-based alerts are only available to laptop clients and client groups.

Use the following steps to create an alert to monitor backup operations as an example:

  1. From the CommCell Console ribbon, click Alerts.
  2. In the Alerts dialog box, click Add.
  3. On the General Information page, enter a name for the alert in the Display Name box.
  4. Select Job Management and Data Protection from the Category and Alert Type panes, respectively.
  5. Click Subscription based alert and then click Next.
  6. Select the laptop clients or client groups that you want to associate with this alert and click Next.
  7. Select the notification criteria to be used and click Next. For example to monitor failed backup jobs, click Job Failed.
  8. Select the way in which the alert is to be sent to its intended recipient and click Next. For example, you can click Select [Email] for notification to send the alert as an email.

    Only email and console alert notifications are supported for subscription-based alerts.

  9. Review your selections on the Summary page and then click Finish.

Disabling Ability to Track a Client Computer

By default, end-users can track the location of a client computer from a map in the Web Console. The client location is fetched every 24 hours whenever the client is online. In addition, if the client is behind a firewall, another attempt to fetch the location takes place every time the client connects through the firewall.

You can disable the ability to track the location of laptop clients at the following levels:

At the CommCell Level

Use the following steps to configure the CommServe to ignore any update on the clients' geographical location.

  1. From the CommCell Browser, right-click the <CommServe> and then click Properties.
  2. Click the Additional Settings tab.
  3. Click Add.
  4. In the Name box, type DisableGeoLocation.
  5. Select CommServDB.GxGlobalParam from the Category list.
  6. Select INTEGER from the Type list.
  7. In the Value box, type 1.
  8. Click OK to save the global parameter.
  9. Click OK from the CommCell Properties dialog box.
  10. Restart the SnapProtect services.

    The CommServe starts to ignore the geographic location updates sent by the laptop clients. If you want to disable one or more clients from notifying the CommServe about their location, continue to the next section to configure the bDisableGeoLocation additional setting.

At the Client or Client Group Level

Use the following steps to disable the ability to track the location for a client group or for a specific client.

  1. From the CommCell Browser:

    For a Client Group

    Navigate to the Client Computer Groups node, right-click the <Client Group> and then click Properties.

    For a Specific Client

    • For a specific client, navigate to the Client Computers node, right-click the <Client> and then click Properties.
    • On the Client Computer Properties dialog box, click Advanced.
  2. Click the Additional Settings tab, and then click Add.
  3. In the Name box, type bDisableGeoLocation. The Category and Type details are populated automatically.

    Alternatively, you can click Lookup and search for the additional setting using the Find box.

  4. In the Value box, select true.

    The image shown below is an example of how the configuration looks on a client computer.

  5. Click OK to save the additional setting configuration.
  6. Click OK from the CommCell Properties dialog box.

    The client map displayed in the Web Console stops showing the latest location of the client.

Configuring the Display Mode of All Geographical Maps

By default, the Web Console displays the maps that show the geographical location of each client. If you do not wish to display these maps, you can configure a global parameter at the CommServe level to do the following:

  • Hide all maps
  • Substitute each map with a link to Google Maps

Use the following steps to change the display mode of all geographical maps:

  1. From the CommCell Browser, right-click the <CommServe> and then click Properties.
  2. Click the Additional Settings tab.
  3. Click Add.
  4. In the Name box, type Geo Location Display Mode.
  5. Select CommServDB.GxGlobalParam from the Category list.
  6. Select INTEGER from the Type list.
  7. In the Value box, type:
    • 0, if you want to hide all maps and any other client location information.
    • 1, if you want to replace each map with a link to Google Maps which will show the client location.

    If you have already hidden the maps, but you want to display them again in the Web Console, type 2.

  8. Click OK to save the global parameter.
  9. Click OK from the CommCell Properties dialog box.

Browse or Search Based on End-User Access Control

During backups, the metadata information associated with the files is collected, stored in the backup index and is available for search/browse. By default, end-users can browse and search all the data backed up from a common resource like a shared laptop or file server. You can control the end-user access on such common resources by enabling access control on the client data.

When you enable access control on client data, the access control lists (ACLs) for the data are also included in the backup, which in turn, allow users to access only the files and folders for which they have access permissions. Other files and folders for which the user does not have permissions will be filtered and hidden during Find, Browse, Restore, and Erase Data operations.

Remember: This option is only available for users who log in with their Active Directory credentials.

Before You Begin

  • To view the user data, ensure that End User Access capability is configured on the client computer. For instructions, see Configuring End-User Operations on Client Computers.

    Assigning the End User Access capability helps maintain multiple user profiles on the same laptop (or desktop) and ensures that each user has the ability to access only the data for which the user has access permissions.

  • By default, you can access data backed up by the Default subclient on the Web Console. To browse user data backed up by non-default subclients on the Web Console, enable browse for non-default subclients. For instructions, see Enabling Data Browse from Non-Default Subclients.

To enable browse or search based on end-user access control, complete the following steps:

  1. From the CommCell Browser, expand Client Computers > Client > File System > Backup Set.
  2. Right-click the subclient and click Properties.
  3. Click the Advanced Options tab and select  Catalog ACL (end user access control list).
  4. Click OK.

After enabling access control, run a full backup on the subclient to include the ACLs in the backup data. Conversely, if you run a differential or incremental backup, only the newer data will include the ACLs.

Configuring Sync Folder Options

Enabling File Synchronization and Modifying the Synchronization Interval

By default, Sync Folders in the Web Console are configured to synchronize (backup and restore data) every 2 minutes. This synchronization interval, defined in the Laptop schedule policy, does not take effect until the schedule policy is configured to trigger backup jobs when the subclient content is modified. This configuration allows backup and restore jobs to run every 2 minutes whenever a new file is created or modified.

Use the following steps to enable file synchronization and to modify the synchronization interval:

  1. From the CommCell Console, navigate to Policies > Schedule Policies.
  2. Right-click the Laptop_Schedule_Policy and then click Edit.

    The Schedule Policy dialog box appears.

  3. On the General tab, select the task and then click Edit.

    The Backup Task Options dialog box appears.

  4. In the Job Interval section, in the Minimum Sync Interval box, specify the synchronization interval in minutes.
  5. In the File Management section, select the Start job only if there are files to be backed up check box.
  6. Click OK to close the Backup Task Options dialog box.
  7. Click OK to close the Schedule Policy dialog box.

    The synchronization process starts at the specified interval if new files were created or modified.

Disabling Sync Folders for Specific Users or User Groups

You can disable the ability to synchronize files between computers for specific users or user groups. Once disabled, the users can no longer see the Sync Folders section in the Web Console, and any existing Sync Folder configured stops to synchronize the data.

From the command prompt, navigate to software_installation_directory/Base, use the qlogin command to log on to the CommCell, and then run one of the following commands:

Disable Sync Folders for a User

qoperation execscript -sn updateUserGroupUserPropertiesCap -si 'u=username' -si 'Cloud Capabilities' -si SYNC -si 'add'

where username is the name of the user. If you need to enable again Sync Folders for the same user, change 'add' to 'remove' at the end of the command.

Disable Sync Folders for a User Group

qoperation execscript -sn updateUserGroupUserPropertiesCap -si 'ug=usergroupname' -si 'Cloud Capabilities' -si SYNC -si 'add'

where usergroupname is the name of the user group. If you need to enable again Sync Folders for the same user group, change 'add' to 'remove' at the end of the command.

Configuring the Display of Features

Use the following command to list, add, or remove Web Console features:

qoperation execscript -sn WebFeatures -si get/add/remove -si ID/'feature_name'

For a list of feature names and IDs, see the readme file for the WebFeatures QScript located in the Available Scripts table. For information on using QScripts on the command line, see Using QScripts on the Command Line.

Example

The following command returns a list of features enabled on the Web Console:

qoperation execscript -sn WebFeatures -si get

Linking to the Web Console from the CommCell Console

The Web Console button is on the Home tab of the CommCell Console ribbon.

You can update the link to the Web Console from the CommCell Console in the following cases:

  • The Web Console is installed on multiple computers and the link should not be the computer where the Web Console was installed first.
  • Multiple Web Console computers are upgraded to the current release and the link should not be the Web Console computer upgraded first.

Update the URL for the link to the Web Console using the following command:

qoperation execscript -sn SetKeyIntoGlobalParamTbl.sql -si WebConsoleURL -si y -si "http://hostname:port/webconsole/clientDetails/fsDetails.do?clientName=CLIENTNAME"

where:

  • hostname is the hostname of the computer where the Web Console is installed
  • port is the port number used by the Web Console

After you update the URL, restart the CommCell Console.

Linking to the CommCell Console from the Web Console

The My Applications page of the Web Console can be configured to show or hide the CommCell Console GUI link. If the link is configured to appear, the link URL can be updated.

Add the Link

Add the CommCell Console GUI link using the following command:

qoperation execscript -sn updateUserGroupUserPropertiesCap -si 'ug=user_group' -si 'Cloud Capabilities' -si 'COMMCELLCONSOLE' -si 'add'

where user_group is the name of the user group that is updated.

Sign out and then sign back in to the Web Console to see the change.

Remove the Link

Remove the CommCell Console GUI link using the following command:

qoperation execscript -sn updateUserGroupUserPropertiesCap -si 'ug=user_group' -si 'Cloud Capabilities' -si 'COMMCELLCONSOLE' -si 'remove'

where user_group is the name of the user group that is updated.

Sign out and then sign back in to the Web Console to see the change.

Update the Link

Update the URL for the CommCell Console GUI link using the following command:

qoperation execscript -sn SetKeyIntoGlobalParamTbl.sql -si CommcellConsoleUrl -si y -si "http://hostname:port/console"

where:

  • hostname is the hostname of the computer where the CommCell Console is installed
  • port is the port number used by the CommCell Console

Restart the Tomcat service on the computer where the Web Console is installed. For instructions on restarting the Tomcat service, see Restarting a Service.

Changing the Web Server to Handle Search Operations

You can associate a different Web Server to a client or client group in order to offload memory and processing resources from the main Web Server. Also, if you have a Web Server computer with better performance compared to the original, you can associate it to all the clients in the CommCell. After this configuration, search operations of content indexed data will be processed by the selected Web Server.

The following sections describe the steps to associate a different Web Server at the following levels:

If content indexing is not enabled on the clients, the new Web Server association will have no effect.

At the CommCell Level

  1. From the Home tab of the CommCell Console toolbar, click Control Panel.
  2. Double-click Browse/Search/Recovery.
  3. Select the Web Server to be associated to all clients in the CommCell from the Default Web Server for Search list.
  4. Click OK.

At the Client Group Level

  1. From the CommCell Browser, navigate to Client Computer Groups.
  2. Right-click the <Client Group> and then click Properties.
  3. Click the Advanced Settings tab.
  4. Select the Web Server to be associated to this client group from the Web Server list.
  5. Click OK.

At the Client Computer Level

  1. From the CommCell Browser, navigate to Client Computers.
  2. Right-click the <Client> and then click Properties.
  3. Click Advanced.
  4. From the Advanced Client Properties dialog box, click the Web Server URLs tab.
  5. Select the Web Server to be associated to this client from the Web Server list.
  6. Click OK twice.

Enabling Data Browse from Non-Default Subclients

By default, the web console displays data from the default subclient on your client computer.

To view data backed up from non-default, subclients:

  1. On the Web Console computer, go to <installation_directory>/WebConsole/WEB-INF/classes folder and open the Config.properties file.
  2. Add the following parameter and save the file.

    useFsBackupsetLevelBrowse=true

  3. Restart the Tomcat services on the Web Console computer.

Changing Session Timeout Settings

By default, a Web Console session is timed out after 30 minutes. Use the following procedure to change the timeout settings for a Web Console session.

Procedure

  1. Change the session timeout settings in the Web Server database.

    On the Web Server computer, run the UpdateSettingValue qscript using the qoperation execscript qcommand.

    For more information, see Using QScripts on the Command Line.

    qoperation execscript -dbn DM2 -c WebServerClientName -sn UpdateSettingValue -si 'SESSION_TIME_OUT' -si 'n'

    where, n is the timeout value in minutes.

  2. Configure the Web Console to use the same session timeout value (in seconds).
    1. On the Web Console computer, go to <installation_directory>/WebConsole/WEB-INF/classes folder and open the Config.properties file.
    2. Add the following parameter and save the file.

      SessionTimeout=n

      where n, is the timeout value in seconds.
    3. Restart the Tomcat services on the Web Console computer.

Limiting the Data Download Size

You can limit the total size of files and folders users can download from the Web Console. By default, the maximum size limit for data that can be downloaded from the Web Console is 1 GB.

During a download operation, if the total size of the selected files and folders is greater than the download size limit, the following error message is displayed on the Web Console.

Download size is too large. Please use the restore option instead.

Procedure

  1. On the CommServe computer, add the WebconsoleDownloadSizeLimitMB additional setting with the value in megabytes:
    Property Value
    Name WebconsoleDownloadSizeLimitMB
    Category CommServe
    Type Integer
    Value Type the download size limit in megabytes. For example, to set download size limit to 2 GB, set the value to 2048.

    For instructions on adding the additional setting from the CommCell Console, see Add or Modify an Additional Setting.

  2. Restart the Web Console computer.