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.

Note: Running API Tasks in Control Room requires Enterprise Platform license. For more information about supported version for this feature, see Enterprise Platform.
Unlike Task Bots, API Tasks benefit from running entirely in the Cloud eliminating 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.

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 table and click the down arrow to add your selection.

      The users that you have selected are listed in the Selected table. You can use the up arrow to remove any of the selected users.

      Note: System generates a user called apitaskrunner who is associated with the AAE_API Task Runner role to establish the run-as user context for API Tasks.
    • In the Define number of run-as users to use field, choose one of the following:
      • All run-as users: Select this option to specify all the users available in the Selected table as run-as users while executing the API Task.
      • Custom number of run-as users: Select this option to provide a certain number of users from the Selected table that you want to use as run-as users.

        For example, if you have 5 users in the Selected table, and you only want to use 3 as run-as users, enter 3. The 3 users listed at the top of the table are used as run-as users while executing the API Task.

  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 priority, you can change it so that API Tasks 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.
Additional resource: Go to this learning course to learn more about API Tasks: Run API Tasks outside of forms and processes.