Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

AARI Web package

  • Updated: 9/21/2021
    • Automation 360 v.x
    • Build
    • RPA Workspace
    • Process flow

AARI Web package

The AARI on the web package contains actions that enable Control Room users to configure their bots to work on requests, tasks, and team members.

Before you start

Ensure you have met one of the following conditions in order to run this package:

Condition 1
  • Access to a process in an assigned team.
  • Access to an AARI User license.
  • A system-created AAE_Robotic_Interface User role for the AARI user.
Condition 2
  • Access to a Bot Runner license (Attended or Unattended) or Bot Creator license.
  • A user-created role with the View My Bots and Run My Bots permissions.

Actions in the AARI on the web package

The AARI on the web package includes the following actions:

Action Description
Assign Task Assigns options to a task.
  • In the Task ID to be assigned field, specify a value.
  • In the User ID to assign to task field, specify a value.

    For the task and user ID, you can select a value from the Variable or Global value options. The variable option enables you to add predefined variables ranging from time (minute, hour, day, month, year, etc) or system usages (CPU and RAM).

  • Optional: In the Assign the result to variable field, assign a variable to store as an output.

    The output is stored as a string value.

Cancel Task Cancels a task.
  • In the Task ID to cancel field, specify a value.

    For the task, you can select a value from the Variable or Global value options. The variable option enables you to add predefined variables ranging from time (minute, hour, day, month, year, etc) or system usages (CPU and RAM).

  • Optional: In the Assign the result to variable field, assign a variable to store as an output.

    The output is stored as a string value.

Create a Request Creates a request.
  • In the Public Process field, specify the uniform resource identifier (URI).
    Important: The public repository URI is of the following pattern:repository:///Automation%20Anywhere/Bots/My%20Folder/My%20Process%20File where the whitespace characters are replaced with %20. The AARI admin can use the Copy process to uri to clipboard feature in the Process setup page in the web interface to obtain the URI data.
  • In the Input values field, specify the variable input.
    • Variable: Enter your custom variable.
    • Dictionary: Enter the variable information in the Type, Key, and Value fields.

      In the Type field, choose from Any, String, Number, Datetime, or Boolean.

    • Optional: In the Add field, add more dictionary variables.
  • Optional: In the Assign the Request ID to field, assign a variable to store as an output.

    The output is stored as an ID value.

Get Storage file Download the storage file to a bot device.
  • Specify the storage file URI in the Variable field.
    Enter your file input variable.
    Attention: You must only use the Variable option and the variable must be a file input that is populated from the process (Select File in Human Task). Do not use the Control Room file and Desktop file options.
  • In the Full path of file in local device to be saved to, specify the path to store your file.

    You can select from Variable or Global value option. The variable option enables you to add a user-defined value, clipboard, string (enter, newline, separate, etc), system (task name, control room URL, etc), predefined variable package (date, minute, day, time, IP address, operating system, etc), or table analytic value.

  • Optional In the Result field, choose a variable.

    The output is stored as a variable.

Query Requests Enables the user to query requests with custom filters.
  • Select a filter.
    Note: The filters for process and request titles, tags, IDs, and PII tags have the same list of options.
  • Specify the string value in the List or Variable field.
    • Specify your type in the List or Variable field.
    • List: Input your value information in the Type and Value at 0 fields.
    • Optional: In the Add field, add more values.
    • Variable: Enter your custom variable.
  • In the Request Status field, select a status.

    You can choose OPENED, SUCCESS, ERROR, and CANCELLED

  • In the Page field, specify a value.
    • In the Table start at offset of data field, enter a value.
    • In the Number of rows per page field, enter a value.

      The default value is set 200 for number of rows.

  • In the Sort field, specify the option.
    • In the Direction field, select Descending or Ascending.

      The default value is set to Descending for the direction.

    • In the Select sort column field, select an option.

      You can choose between process title or the request creation, ID, title, status, or PII tag.

    • Select the Enable 2nd degree sort and specify the Direction and Select sort column fields.
  • In the Assign the result to variable field, assign a variable to store as an output.

    The output is stored as a table value.

Query Tasks Enables a user to query tasks with custom filters.
  • Select a filter.
    Note: The filter for process and request titles, tags, IDs, status, and PII tags provide the same list of options.
  • Specify the string value in the List or Variable field.
    • Specify your type in the List or Variable field.
    • List: Input the value information in the Type and Value at 0 fields.
    • Optional: In the Add field, add more values.
    • Variable: Enter your custom variable.
  • In the Request Status field, select a status.

    You can choose OPENED, SUCCESS, ERROR, and CANCELLED

  • In the Task State field, select a status.

    You can choose IN_PROGRESS and COMPLETED.

  • In the Page field, specify a value.
    • In the Table start at offset of data field, enter a value.
    • In the Number of rows per page field, update the value.

      The default value is set to 200 for number of rows.

  • In the Sort field, specify the following options.
    • In the Direction field, select Descending or Ascending.

      The default is Descending for the direction.

    • In the Select sort column field, select an option.

      You can choose from the request and tasks IDs, titles, creation, status, or PII tags.

    • Select the Enable 2nd degree sort and specify the Direction and Select sort column fields.
  • In the Assign the result to variable field, assign a variable to store as an output.

    The output is stored as a table value.

Team Members Retrieves the list of members of a team.
  • In the Supply team ID to query it's members field, specify a value.

    For the supply team ID, you can select a value from the Variable or Global value options. The variable option enables you to add predefined variables ranging from time (minute, hour, day, month, year, etc) or system usages (CPU and RAM).

  • In the Assign the result to variable field, assign a variable to store as an output.

    The output is stored as a table value.

Send Feedback