Online Help for Workflows

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

Options

Use this dialog box to select the workflow inputs and the workflow engine to use to run the workflow.

Run workflow on

The engine to use to execute the workflow. If you select Any, the workflow engine with the latest deployed version of the workflow is used.

Workflow Inputs

The inputs defined at the workflow level (Workflow Properties). Inputs change depending on the workflow that you run.

Version History

Use this dialog box to view how many times the workflow was saved. Right-click any row to edit a version, edit a comment, or perform a "diff" between two versions of a workflow.

Version

The version number of the workflow. The workflow is assigned a new version number each time it is saved.

Deployments

The workflow engine the workflow was deployed on. Not Deployed is displayed if the workflow was saved but not deployed.

User

The user who saved the workflow.

Date

The date the workflow was saved.

Comment

Comments entered for the version. To enter comments as a workflow is saved or deployed, select Show comment dialog on save or Show comment dialog on deploy from the Settings dialog box. For information on workflow settings, see Configure the Workflow Window Settings.

Email Approval Properties

Enable Email Approval

Allows users to interact with a workflow by responding to an email. To configure the UserInput activity to allow email responses, see Available Built-In Activities: UserInput.

Email Server

The name of the email server, for example: smtp.companymailserver.com.

Mailbox

The email address of the administrator who should receive the reply emails sent by the users.

Password

The password for the email account in the Mailbox box.

Folder

The name of the email folder used to hold the reply emails sent by the users, for example, Inbox.

Tip: Create a new email folder specifically to hold the reply emails, and then create a rule in your email program to direct the reply emails to that folder.

Bulk Export

Use this dialog box to export multiple workflows at once. For more information, see Workflow Operations - Export Multiple Workflows.

Folder

Displays the destination location of the exported workflows. You can change the destination location.

  • Export

    Select the check box to include a workflow in the bulk export.

  • Workflow Name

    Displays the name of the workflow.

  • Version

    Displays the version of the workflow.

  • File Name

    Displays the file name used for the exported workflow. You can edit the file name.

  • Status

    Displays the export status of the workflow.

Version 10

Exports the workflows in a format that works with version 10 of the Commvault software.

Bulk Deployment

Use this dialog box to deploy multiple workflows at once.

Select the workflows you want to deploy

  • Workflow Name

    Displays the name of the workflow.

  • Version

    Displays the version of the workflow.

  • Description

    Displays information about the workflow, such as purpose and usage.

Select the workflow engines where you want to deploy

  • Workflow Engine

    The engine to use to deploy the workflow.

For more information, see Deploying a Workflow.

Bulk Import

Use this dialog box to import workflows to the CommCell .

  • Workflow Name

    Displays the name of the workflow.

  • File name

    Displays the name of the imported file.

  • Size

    Displays the size of the workflow.

  • Activities

    Specifies the number of activities used in the workflow.

  • Status

    Displays the import status of the workflow.

For more information, see Workflow Operations - Import a Workflow.

Activity Packages

Use this dialog box to view the imported activity packages.

  • Package

    Displays the name of the imported activity package.

  • Imported

    Displays the date and time the activity package was imported.

For more information, see Creating an Activity Package Using External Tools.

Web Services

Use this dialog box to view the imported web services.

  • URL

    Displays the address of the imported web service.

  • Last Refreshed

    Displays the date and time the web service was imported or was reimported.

For more information, see Managing Web Services.

Web Services (Import Web Service)

Use this dialog box to import a web service using the web service URL.

WSDL Location

Enter the URL of the web service.

Go

Click to find the web services associated with the URL in the WSDL Location box.

Service URL

Enter a service URL if the workflow engine should not use the service URL found in the WSDL to send the web service request.

Execute On

Displays the names of the workflow engine that will parse the WSDL and import the web service as an activity.

Properties (General)

Use this dialog box to view or change the general configuration properties of the workflow.

Workflow

Displays the name of the workflow.

Version

Displays the number of times that the workflow has been deployed.

Owner

Displays the name of the CommCell user that created the workflow.

Auto deploy when a new workflow engine is installed

Select this option to make the workflow deploy automatically after a new engine is installed on the CommCell.

Disabled

Select this option to disable the workflow.

Description

Displays information about the workflow, such as purpose and usage. Use this space to enter or edit the description for the workflow.

Properties (Configuration)

Configuration values act as variables or hold information users need to understand the workflow. If you change a configuration value, you do not need to redeploy the workflow. For information on setting configuration values, see Setting Configuration Values.

Name

Displays the name of the configuration.

Value

The value for the configuration.

Type

The data type of the configuration value.

Properties (Security)

Use this dialog box to:

  • Identify the user and user groups to which this workflow is associated.

  • Associate this workflow with a user/user group.

  • Disassociate this workflow from a user/user group.

User and Group Names

Displays the names of the users/user groups that are associated with this workflow.

Add

Click to add the users/user groups that you want to associate with this workflow.

Remove

Click to remove the selected user or user group.

Capability

Displays the capabilities that you can provide to the selected user or user group.

Add workflow input

Use this dialog box to add a new input to the workflow.

Variable Name

Displays the name of the input variable.

Variable Type

Displays the type of input variable.

Create as list

Select this option to store multiple variable values in a list.

New Command Activity (General)

Use this dialog box to specify the general properties of a custom command-based activity.

  • Name

    Specify the name of the activity.

  • Description

    Specify a brief description of the activity.

  • Group

    Allows you to select the activity group where you want to associate the command-based activity.

For more information, see Workflow Activities - Creating a Command-based Activity.

New Command Activity (Inputs)

Use this dialog box to specify the inputs of a custom command-based activity.

Add

Click to define a new input for the activity.

Reset All

Click to reset all input values to their default values.

  • Name

    Displays the input names.

  • Value

    Displays the value for the corresponding input.

  • Type

    Displays the input types.

New Command Activity (Definition)

Use this dialog box to specify the details of the command that the activity will run.

Insert Variable

Click to insert a workflow variable in any of the fields provided in this dialog box.

Start Up Path

Specify the location from where the command is run.

Command

Specify the command (or executable file name).

Arguments

Specify the arguments required for the command to run.

Host (Optional)

Allows you to select the client computer where you want to run the command.

Impersonation (Optional)

  • Username

    Specify a user account with sufficient privileges to run the command. For example, if you are running a SQL query command, you might need to be an administrator to query the database.

  • Password

    Specify the password for the user account provided above.

New Command Activity (Outputs)

Use this dialog box to view and learn the default output variables for the command-based activity.

New Script Activity (General)

Use this dialog box to specify the general properties of a custom script-based activity.

  • Name

    Specify the name of the activity.

  • Description

    Specify a brief description of the activity.

  • Group

    Allows you to select the activity group where you want to associate the script-based activity.

For more information, see Workflow Activities - Creating a Script-based Activity.

New Script Activity (Inputs)

Use this dialog box to specify the inputs of a custom script-based activity.

Add

Click to define a new input for the activity.

Reset All

Click to reset all input values to their default values.

  • Name

    Displays the input names.

  • Value

    Displays the value for the corresponding input.

  • Type

    Displays the input types.

New Script Activity (Script)

Use this dialog box to specify the script that the activity will run. Java and JavaScript are supported.

Insert Variable

Click to insert a workflow variable in the script area.

Select Language

Select the programming language to define the script: Java or JavaScript.

Output Variable

Specify the name of the output variable. Defining an output variable gives you the ability to store the result of your script in a variable, which you can later recall in another activity.

Output Type

Allows you to select the type of variable. For example, integer.

  • Output as list

    When selected, stores the script output as a list. This is useful if the script outputs a list of items which you need to later iterate in a different activity.

New Script Activity (Outputs)

Use this dialog box to view the output variables that you defined in the Script tab.

Loading...