Run Task Bot activity

An activity that runs a task bot on the specified device in Automation Anywhere.


Deploy Bot activity

Configure the Run Task Bot activity

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In the Process Builder, in the Activity Library, open the Automation Anywhere tab.

    Open Automation Anywhere tab
  3. On the Automation Anywhere tab, drag the Run Task Bot activity onto your process.

    Drag Deploy Bot activity

General Configuration

Specifies the basic settings for the Run Task Bot activity.

Figure: General Configuration screen

General Configuration screen

Good to Know

  • Documentation for this screen is provided for completeness. The fields are mostly self-explanatory.

Fields

Field Name Definition

Display Name

Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description

Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Run Task Bot Configuration > Basic Information tab

Configures the basic information to run a task bot.

Figure: Run Task Bot Configuration > Basic Information tab

Run Task Bot Configuration Basic Information tab

Fields

Field Name Definition

Automation Anywhere

Function:
Specifies the access token that connects to your Automation Anywhere service.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon

Opens this Screen:
Access Token for Automation Anywhere
Function of this Screen:
Configure an access token to connect to Automation Anywhere.

Bot Name Or ID

Function:
Specifies the name or ID of the task bot to run in Automation Anywhere.

The bot name or ID comes from Automation Anywhere.

Accepted Values:
A bot name from the list.

When you select the access token from the Automation Anywhere field, this field shows the bot names associated with the access token.

Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Bot Instance Name

Function:
Specifies a unique instance name for a task bot.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
Yes

Run As User

Function:
Specifies bot runner users in which to run the task bot.

This field shows a list of users who has the Unattended Bot Runner permission in Automation Anywhere Control Room.

Accepted Values:
One or more bot runner users, separated by semicolons (;).

When you select the access token from the Automation Anywhere field, this field shows bot runner users associated with the access token.

Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Device Pools

Function:
Specifies device pool names where the task bot runs.

To run the task bot on the device you specified in this field, you must select the Override Default Device option. If you do not select the Override Default Device option, the task bot runs on the default device.

If you enter more than one device, the task bot runs on the available device. If none of the devices is available to run the task bot, the task is put in a queue.

Accepted Values:
One or more device pool names, separated by semicolons (;).

When you select the access token from the Automation Anywhere field, this field shows device pool names associated with the access token.

Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Number of Bot Runners to Use

Function:
Specifies the number of bot runner users to use from the list of Run As User field.
Accepted Values:
An integer.
Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Override Default Device

Function:
Specifies whether to run the task bot on the default device.

The user with bot runner permission has a default device assigned to their account.

Accepted Values:
  • Selected - Runs the task bot on the device you specified in the Device Pools field.
  • Deselected - Runs the task bot on the default device.
Default Value:
Deselected
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Run Task Bot Configuration > Input Variables tab

Specifies variables that store the values from the AgilePoint NX app.

Figure: Run Task Bot Configuration > Input Variables tab

Run Task Bot Configuration Input Variables tab

Fields

Field Name Definition

Automation Anywhere

Function:
Specifies the access token that connects to your Automation Anywhere service.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon

Opens this Screen:
Access Token for Automation Anywhere
Function of this Screen:
Configure an access token to connect to Automation Anywhere.

Name

Function:
Specifies the variable that you created for your task bot in Automation Anywhere.
Accepted Values:
One line of text with no spaces.

The variable name you enter must match the variable name associated with the task bot in Automation Anywhere.

Default Value:
None
Accepts Process Data Variables:
Yes

Value

Function:
Specifies the value for the variable.
Accepted Values:
One line of text with no spaces

This value comes from the AgilePoint NX app.

Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Data Type

Function:
Specifies the data type of your input variable.
Accepted Values:
A data type from the list.
Default Value:
String

Add Add icon

Function:
Adds an input variable row.

Delete Delete icon

Function:
Deletes the row.

Run Task Bot Configuration > Response tab

Specifies the process data variable to store the Bot Instance ID from Automation Anywhere.

Figure: Run Task Bot Configuration > Response tab

Run Task Bot Configuration Response tab

Fields

Field Name Definition

Automation Anywhere

Function:
Specifies the access token that connects to your Automation Anywhere service.
Accepted Values:
A list of access tokens configured for your environment.
Default Value:
None

Create Add Token icon

Opens this Screen:
Access Token for Automation Anywhere
Function of this Screen:
Configure an access token to connect to Automation Anywhere.

Store Response Bot Instance ID in this Variable

Function:
Specifies the variable that stores the Bot Instance ID from Automation Anywhere.
Accepted Values:
A process data variable that accepts an alphanumeric string with no spaces or special characters.
Default Value:
None
Accepts Process Data Variables:
Yes
Limitations:

Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation. It is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business use cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, or other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?