Tools - Advanced Options

Table of Contents

Configuring the Parameters Needed for an Application to Run

Some applications require parameters to execute. These parameters can be permanent, variable or both. See the following example which uses both permanent and variable parameters:

-u $user_name$

where -u is a permanent parameter and $user_name$ is a variable parameter. Variable parameters are defined using the $ character which prompts the user to enter the required value during the execution of the application. The image below shows a parameter prompt example for the Remote Desktop application.

Configure a Parameter Using Tokens

You can provide a tokenized parameter to skip the parameter prompt during the execution of an application or workflow. Tokens are automatically replaced by the SnapProtect software with the correct value.

The following table lists the tokens you can use:

Tokens Description
%CLIENT_INSTALL_DIR% Retrieves the installation directory of the SnapProtect software.
%CLIENT_NET_HOSTNAME% Retrieves the hostname of the CommServe, MediaAgent or client computer you are trying to access. For example, you can use this token when configuring the Remote Desktop connection option.
%CLIENT_NAME% Retrieves the name of the MediaAgent or client computer you are trying to access. For example, you can use this token when configuring an application option to display all agents installed on a client (using the qlist dataagent command)

Configuring Credentials Required for an Application to Access Restricted Drives or Directories

Some application tools require user accounts with sufficient permissions to access mapped/shared network drives or directories in the client computer they are running. This configuration is necessary for applications whose executables are located in restricted drives or directories.

Use the following steps when configuring a tool that requires a user with sufficient privileges:

  1. On the CommCell Console ribbon, click the Home tab, and then click Control Panel.
  2. Under the Others section, click Quick Access Tools.
  3. In the Quick Access Tools dialog box, click Add.
  4. In the Create Tool dialog box, provide the application tool details such as name, parameter, associations and the computer where it is run.
  5. To specify the credentials of the user with sufficient privileges to execute the application, click User Name/Password and do the following in the Change User Account dialog box:
    1. Select the Use This Account check box.
    2. In the User Name box, type the name of the user account with the required permissions.
    3. In the Password and Confirm Password boxes, type the password.
    4. Click OK.
  6. Select the Show Output on CommCell Console check box.
  7. Click OK.

Configuring a Tool to Be Available for Other Users

By default, tools are only visible to the user that created them. You can configure a tool to be available for all users in the CommCell or for selected group of users.

  1. Right-click the client associated with the tool and click Tools > Customize Tools.
  2. In the Quick Access Tools dialog box, click the tool that you want to configure and then click Edit.
  3. In the Edit Tool dialog box, click the Security tab.
  4. Select Public.

    By default all user groups are associated with the application tool. If you do not want all groups to be selected, select the user groups you want to remove and click the left arrow <.

  5. Click OK.

Restricting Execution of Tools on Specific Clients

Use the following steps to allow execution of tools on specific computers by restricting others:

  1. From the CommCell Browser, right-click the <CommServe> node and then click Properties.
  2. Click the Additional Settings tab.
  3. Click Add.
  4. In the Name box, type allowToolsToExecuteOnServerOrClient. The Category and Type details will be automatically populated.

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

  5. In the Value box, type the number that represents the computer where the tool should run:
    • 1 = CommCell Console computer.
    • 2 = CommServe computer.
    • 3 = CommCell Console and CommServe computer.
    • 4 = client computer.
    • 5 = CommCell Console and client computer.
    • 6 = CommServe and client computer.
    • 7 = CommCell Console, CommServe, and client computer.
  6. Click OK to save the additional setting configuration.
  7. Click OK.