Get Bot Status activity

An activity that retrieves information about the status of an Automation Anywhere task bot you run with the Run Task Bot activity.


Get Running Bot Status activity

Configure the Get Bot Status 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 Get Bot Status activity onto your process.

    Drag Get Running Bot Status activity

General Configuration

Specifies the basic settings for the Get Bot Status 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

Get Bot Status Configuration

Specifies task bot whose status to retrieve.

Figure: Get Bot Status Configuration screen

Get Bot Status Configuration screen

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 Instance ID

Function:
Specifies the variable that stores the Bot Instance ID to retrieve the status of the task bot.
Accepted Values:
A process data variable.

You must specify the variable that you configured in the Store Bot Instance ID In This Variable field on the Run Task Bot Configuration > Response tab.

Default Value:
None
Accepts Process Data Variables:
Yes

Store Bot Status in this Variable

Function:
Specifies the process data variable to store the deployment status, such as Completed, Unknown, Deployed, and Running from the Automation Anywhere task bot in the AgilePoint NX app.
Accepted Values:
A process data variable.

This value comes from the AgilePoint NX app

.
Default Value:
None
Accepts Process Data Variables:
Yes