Previous Topic

Next Topic

Book Contents

Book Index

Add a Task Process

In a task, a process runs a single built-in script or custom script. The script must exist before you can add it to a process. For more information, see Scripts. A task can have more than one process.

To access this dialog box:

  1. Select TASKS. Create a new Traditional or Advanced task, or select an existing one. You can filter the list.
  2. On the task properties page, click Step > Process.

    If the task has existing steps:

  3. Make your selections in the Add Process dialog box.

    Add Process field

    Description

    Script

    • Script: Select a script from the drop-down list.
    • Description: The available parameters are listed and described. For more information, see Scripts.

    Edit Task Parameters

    • Required parameter: To configure a required parameter, click Edit task parameters > add icon MICEN91_Icon_Enabled. Enter the Parameter Value and click Save.
    • Add a parameter: To add a parameter, click Edit task parameters > Add Parameter. Enter the Parameter Name and Parameter Value and click Save.
    • Edit a parameter: To edit a parameter, click Edit task parameters. Click the Edit Parameter icon MICEN91_Icon_Enabled, edit the parameter values and click Save.

      Note: Parameter values are applied to the task that you are configuring. If another task uses the same script, the parameter values for that task are set when a process is added. You can also specify a global parameter. For more information, see Global Parameters.

    Run script

    • Per File: Process runs one time for each file that is downloaded from all sources, before the file is sent to any destination hosts. If there are no sources, the process is run one time. This is the typical setting for most processes.
      • Use process as a destination: Sets the process as a destination so that even If a previous run of the task has already sent files to all destinations, or if a task has no destinations, the task will run. For more information, see Use Process as a Destination.
    • Once After All Downloads: Process runs only one time after all source files have been downloaded, and before any files are uploaded to any destination hosts.

      This setting is useful for tasks such as zipping multiple files into a single archive.

      The process runs even if no files have been downloaded. Such a process can determine whether any files were downloaded by checking to see whether the MICacheFiles() function returns an empty string.

      Note: If a download error is encountered by a traditional task that is configured to run Once After All Downloads, an error is generated and the script will not run. The task finishes with a failure status and does not continue.