Run API Tasks

API Tasks are API-based cloud automation solutions that leverage the scalability, security, and reliability of managed Cloud infrastructure from Automation Anywhere.

Unlike Task Bots, API Tasks benefit from running entirely in the Cloud managed by Automation Anywhere. This eliminates the need for local Bot Runner devices.

Instead of using an API Tasks editor, you can use the Run now wizard to run any of the available API Tasks in the public repository.

Note: Running API Tasks in Control Room requires Enterprise Platform license. Contact your Automation Anywhere account representative for more information about this license.

Procedure

  1. Log in to Control Room.
  2. On the left pane in the public workspace, click Automation.
    A list of available bots and forms is displayed.
  3. In the top right corner, click Run > Run now.
    The Automation and dependencies screen is displayed.
  4. Click Choose.
    A list of available API Tasks is displayed where you can select the one that you want to run. You can also click the Browse button at the top to find the specific API Task and select it.
  5. Click Choose.
    The Run now screen with various tabs is displayed.
  6. Use the Automation and dependencies tab to review and update the following fields:
    • Automation file: Displays the filepath of the selected API task. If you want to select a different API Task, click Choose and select it.
    • Run automation and dependencies using: Enables you to select one of the following versions of the API Task to run:
      • Latest version: To run the selected API Task and the dependencies using the most recent version.
      • Production version: To run the selected API Task and the dependencies using the production version.

      By default, the latest version of the API Task is selected. If the production label option is selected for the parent task, the corresponding dependent tasks with the production label are also automatically selected.

    • File information: Review the details of the API Task such as name, folder path, label and so on.
    • Dependencies: Review the list of dependencies for the selected API Task.
  7. Click Next.
  8. Use the Run-as users tab for the following:
    • Select the users from the list of Available run-as users field and click the right arrow (→) to add your selection.

      Automation Anywhere creates a user called apitaskrunner to establish the Run as user context for API Task. The apitaskrunner user is associated with the AAE_API Task Runner role.

    • In the Define number of run-as users to use field, select one of the following:
      • All run-as users: To select all the available run-as users.
      • Custom number of run-as users: Enter the number of run-as users that you want to select.
  9. Optional: Use the General tab to change the default settings for the following options:
    • Name: Edit or rename the API Task.
    • Automation priority: Click the drop-down menu to set the automation priority.

      While Medium is the default automation priority, you can change it so that automations are processed for deployment accordingly.

  10. Click Run now.
    The API Task is deployed and the status of the same can be viewed on the In progress activity page.