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 Actions palette, double-click or drag the Create a Request action from the AARI Web package.
In the Public Process field, browse and select the public process. The initial form fields from the process are displayed in the Input values field. These fields are from supported interactive form elements.

In the Input values field, enter the values or variables to complete the required information to the initial form.

Note: For passing the values through variables, create a custom variable of any type: String, Number, Datetime, Boolean, Dictionary, Table, or File. Use the Dictionary variable for completing the check box information in the initial form. Enter the variable information in the Type, Subtype, Key, and Value fields. In the Subtype field, choose Boolean. Follow the format convention while creating Dictionary variables.

For example, consider the check box attributes as San Jose, Atlanta, and Sacramento, and we want to select the value Atlanta in the initial form field. Create a Dictionary variable of subtype Boolean in the format as follows:

Name: CheckBoxGroup0

Attributes	Key	Value
San Jose	CheckBoxGroup0_0	false
Atlanta	CheckBoxGroup0_1	true
Sacramento	CheckBoxGroup0_2	false

Optional: In the Assign the Request ID to field, assign a variable to store as output. This returns the ID of the created request.
Optional: In the Assign the Request Reference to field, assign a variable to store as output. This returns the ID of the request that was created.
Click Save.

Get Storage file

Download the storage file to a bot device.

Important: The Get Storage file action requires the matching of versions between the process version and the package version. Processes created before Automation 360 v.25 must be used with package versions from before Automation 360 v.25. Similarly, processes created after Automation 360 v.25 must be used with package versions after Automation 360 v.25.

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, team name, 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, team name, 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.
  You can choose from the request reference and task 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 Supply team reference to query its members field, specify a value.
For the supply team reference, you can select a value from the Variable or Global value options. With the variable option, you can add predefined variables ranging from time (minute, hour, day, month, year, and so on) 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.