Tools - Online Help

The following sections provide context-sensitive help information related to this feature.

Quick Access Tools

Use this dialog box to create and manage tools which allow you to execute any application or workflow directly from the CommCell Console.

The properties for each tool are displayed in a table:

  • Alias Name

    Specifies the name of the application or workflow.

  • Workflow/Executable Name

    Indicates the command (or executable file name) used to run the application.

  • Parameters

    Specifies the parameters required for the workflow/application to run.

  • Startup Path

    Specifies the location where the process will be launched.

  • OS Type

    Specifies the operating system of the clients where you want the workflow/application to be available.

  • Visibility

    Specifies if the workflow/application is available for all users (public or private).

  • Creator

    Indicates the name of the user that created the workflow/application tool.

  • Description

    Specifies the usage for the tool.

Add

Click to access the Create Tool dialog box, which allows you to add a new application tool.

Edit

Click to edit the selected application tool from the Edit Tool dialog box.

Delete

Click to delete the selected application tool.

Create/Edit Tool (General)

Use this dialog box to add or modify a tool.

The following tools can be created or modified:

Application

Alias Name

Use this space to specify the name of the application tool.

Executable Name

Use this space to specify the command (or executable file name) used to run the application. You can click Browse to search for the executable file.

Parameters

Use this space to specify the parameters required for the application to run.

For variable parameters, use the $ character. For example,  $enter_parameter$.

Startup Path

Use this space to specify the current working directory (CWD) of the application's process. This is the location where the process will be executed. You can click Browse to search for the directory where the executable file resides.

For example, in a Windows computer, if the path for a executable file is C:/a/b/c/pgrm.exe, then the startup path will be C:/a/b/c.

OS Type

Select the operating system of the clients where you want the application to be available. For example, if you select Windows, the application will be available only for Windows clients.

Associate tool to:

Select the CommServe entity to be associated with the application tool. The application will be visible in the Tools menu for the selected entity.

Run tool on:

Select the computer where you want to run the application from.

  • CommCell Console

    Select this option to run the application from the computer running the CommCell Console.

  • CommServe Machine

    Select this option to run the application from the computer where the CommServe is installed. You should have the necessary user permissions to execute the application on this computer.

  • Client Machine

    Select this option to run the application from any client computer in the CommCell. You should have the necessary user permissions to execute the application on this computer.

Impersonate User

Click User Name/Password to specify a user account with the required permissions to execute the application.

Enable

Click to enable/disable this application tool.

Show Output on CommCell Console

Use this option to display the output of the application's execution in a popup window.

Ask for credentials

This option is available when running the application tool on the CommServe or client computer. Use this option to prompt for the user credentials to access the CommServe or client computer. This option is not available for tools running on the CommCell Console computer (as you are already logged in to the console).

Description

Use this space to specify the usage for the application tool.

Workflow

  • Alias Name

    Specifies the name of the workflow.

  • Tool Type

    Specifies the type of tool created. Select Workflow.

  • Workflow to run

    Specifies the workflow name for which the tool is created.

  • Run workflow on

    Specifies the workflow engine on which the workflow is deployed.

  • Reset All

    Click to revert the input parameter values to the default selection.

  • OS Type

    Specifies the operating system of the clients where you want the workflow tool to be available.

  • Associate Tool to

    Specifies the CommCell components where you want the workflow tool to be available.

  • Enable

    Click to enable/disable the workflow tool.

  • Skip input dialog and execute workflow immediately

    Click to skip the input parameter dialog box when executing the workflow. By default, the dialog box is displayed.

  • Description

    Specifies the usage for the workflow tool.

Create/Edit Tool (Security)

Use this dialog box to make the tool available to you or to more users in the CommCell.

Private

Select this option to make the tool only visible to you.

Public

Use this option to Identify the user groups that you want to associate or disassociate to this tool.

  • Available Groups

    Displays the names of the user groups that are not associated with this tool.

  • Associated Groups

    Displays the names of user groups that are associated with this tool.

Enter inputs for: <tool name>

Use this dialog box to provide one or more input values for the application tool to run.

Executable Name

Indicates the command (or executable file name) used to run the application.

Parameters

Specifies the parameters that require an input value for the application to run.

  • Parameter

    Displays the name of a parameter requesting an input value.

  • Value

    Use this space to specify a valid value for the corresponding parameter.

Enter User credentials for: <tool name>

Use this dialog box to provide the user credentials to access a client computer where the application tool is running.

User Name

Specify the user name of the account with sufficient privileges to access the client computer.

Password

Specify the password for the user account provided above.