Creating a robot task to run a script

Once you have created a robot and added script automation to the robot, you create and schedule a robot task to run the script automation. The task runs according to the settings that you configure. Each task has its own settings, independent from other tasks. In addition to scheduling a task, you can also run it ad hoc (manually).

Professional Edition limitations

The Professional Edition of ACL Robotics applies limitations to tasks, listed below. The Enterprise Edition of ACL Robotics does not have these limitations. For detailed information about editions of ACL Robotics, see Robots specifications and limits.

Create and schedule a task

You can create and schedule robot tasks in both development mode and production mode. Development and production tasks in the same robot are completely separate from each other with no functional association.

You create and schedule a task in the Task Designer.

Note

Workflow robots have tasks in production mode only.

Open a robot

  1. Open the Robots app.
  2. From the dashboard in Robots, select the tab for the appropriate robot type.
  3. Click the robot that you want to contain the task.
  4. In the top right corner of the robot, use the Dev mode toggle to select the environment for running the task.

    For more information, see Development mode and production mode in Robots.

    If necessary, activate a script version from development mode to production mode. For more information, see Activate a script version.

  5. On the Tasks tab, click Create task.

    The Task Designer opens and you can begin configuring the task settings.

  6. Type a name for the task, and click Save.

Select the scripts to run and enter parameter values for the task

  1. Depending on the type of robot, do one of the following:
    • ACL robot

      From the list of scripts in the robot, select the script or scripts that you want to include in the task. To use all the scripts, select Activate all. Otherwise, select the specific scripts that you want to include.

      Scripts are organized by the TYPE that is specified in the ANALYTIC tag in a script's analytic header. They run in the order that they appear on the page.

      Only analytic scripts are available for selection. Auxiliary scripts are not available. To run, an auxiliary script must be called from an analytic script.

    • HighBond robot or Workflow robot

      Select Activate all, or the script, to include the script in the task.

  2. For each selected script that requires parameter input, click the down arrow to expand the parameter section and enter the values for the task.

    Note

    The values you enter for the parameters are unique to this task and are not shared across tasks.

    If you are not the author of the script and you have questions about the parameters, contact the script author for more information.

  3. If you entered one or more passwords, click Share passwords if you want to allow other users to run, disable, or enable the task.
    • Share passwords is on any user with access to the robot can run, disable, or enable the task
    • Share passwords is off only you can run, disable, or enable the task

    The Share passwords setting applies to all the scripts in a task. Regardless of the setting, other users can edit the task to enter their own passwords.

    Whether shared or unshared, passwords remain masked in the Task Designer.

    For more information, see Scripts with passwords.

  4. At the bottom of the page, click Continue.

Schedule the task

If you only want to run the task ad hoc, click Continue to skip this page. To run a task ad hoc, on the Tasks tab, select the task and click > Run now.

Note

The maximum number of ACL robot or HighBond robot tasks that can run simultaneously is 5. Tasks that exceed the maximum are queued.

  1. At the top of the page, select Put your task on a schedule.
  2. Specify the schedule details:
    • Frequency the interval at which the task is repeatedly run
    • Starting at the time of day to start running the task, and the time zone to use

      Use your own time zone unless you want the start time to represent a different time zone.

    • Beginning on the date to start running the task
  3. At the bottom of the page, click Continue.

Notify users on failure

If you do not want to send any notifications, click Continue to skip this page.

  1. Select Send notifications on failure to notify one or more specific users if the task fails.
  2. Select one or more users from the list.

    Only users with sufficient permissions for the robot are available to select.

  3. At the bottom of the page, click Continue.

Review the settings and create the task

  1. Review the settings that you have configured for the task.
  2. Optional. To update a setting, click Edit and make the required changes.
  3. When you are satisfied with the task configuration settings, click Confirm and create task.

    Result The task is created using the settings that you specified.

    Note

    (Professional Edition only)

    If the task is flagged as Disabled, another robot already contains enabled tasks. Tasks can be enabled in only one robot at a time.

    If the other robot is owned by someone else, and you are not a collaborator, you are not able to see the other robot.

Run a task ad hoc

Run a task in Robots ad hoc to start the task immediately, regardless of schedule. Once the task completes, you can view the results.

Tip

(ACL robot with an on-premise Robots Agent only)

If tasks are remaining queued for a long time in Robots, and then failing, check that the Robots Agent service is running on the server where the Robots Agent is installed. Start the service if it is stopped.

Restrictions

Disabled task You cannot run a disabled task.

To enable a task, select the task and click > Enable.

Note

The Professional Edition of ACL Robotics allows only one robot at a time to contain enabled tasks. Keep in mind that a robot with an enabled task may not be visible to you because you are not a collaborator.

Task with a password

If Share passwords is off, you cannot enable or run a task that contains a password entered by another user.

For more information, see Scripts with passwords.

You can edit the task to enter your password, or create a new task.

Steps

  1. Open the Robots app.
  2. From the dashboard in Robots, select the tab for the appropriate robot type.
  3. Click the robot that contains the task you want to run.
  4. In the top right corner of the robot, use the Dev mode toggle to select the environment to use.

    For more information, see Development mode and production mode in Robots.

  5. On the Tasks tab, select the task that you want to run and click > Run now.

    Result the task starts and you can monitor its progress and view results in either the Tasks tab or the Task runs tab.

View task run status and history

You can view the status of current or completed task runs in the Task runs tab. The tab contains an entry for each task run, and an icon indicating the task run status. The entries also indicate whether a task was run manually (ad hoc) or scheduled.

Icon Status
Queued
In progress
Success
Failed
Skipped
  1. Open the Robots app.
  2. From the dashboard in Robots, select the tab for the appropriate robot type.
  3. Click the robot with the task run that you want to view.
  4. In the top right corner of the robot, use the Dev mode toggle to select the environment to use.

    For more information, see Development mode and production mode in Robots.

  5. Select the Task runs tab.

    The tab opens and you can view the status of tasks that the robot is currently running, or has previously run.

    Tip

    Hover over an icon to see the status name.

  6. Locate a task run with details that you want to view.
  7. Click the task run entry.

    Result the Task run details side panel opens and displays detailed information about the specific task run, including a list of any output tables and files.

    For information about viewing the output of a task run, see Viewing the tables, files, and logs in an ACL robot.