Access Token for Automation Anywhere

Configure an access token to connect to Automation Anywhere.

Figure: Automation Anywhere Access Token Configuration screen

Automation Anywhere Access Token Configuration screen

Background and Setup

Good to Know

  • In most cases, you can use a global access token or an app level access token:
    • Global access tokens are shared across all users and apps. If you want all process designers and runtime app users in your AgilePoint NX tenant to be able to connect to an external data source, use a global access token. An example is a SharePoint site on an intranet that all employees in a company can access.
    • Application level access tokens are shared with all processes in a process-based app, or restricted to use within a form-based app. Use application level access tokens if only process designers or runtime app users for a particular application should access an external system — for example, a Box account that is only used to share files within a small team.
  • Access tokens are collections of credentials that are used to authenticate communication directly between AgilePoint NX and an external system. Because it is the AgilePoint NX system that uses these credentials, rather than an app, there is no difference between design time and runtime access tokens. Access tokens are never checked in or published, and they do not use version control. If you change an access token in App Builder or Manage Center, the access token changes immediately everywhere the access token is used. Changes to app level access tokens apply to all versions of an app, including running application instances. Changes to global access tokens apply everywhere they are used in AgilePoint NX. You can not roll back an access token to a previous version.

    For more information, refer to What Data Is Deleted When I Delete an App or Application Resource?

  • This screen may look different in different places. The UI varies for this screen depending upon how you open it. However, the fields for this screen are the same in all places.
  • 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?

Fields

Field NameDefinition

Token Name
Description:
Specifies the unique name for your connection to Automation Anywhere.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
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
Description:
A description for your access token.
Allowed Values:
More than one line of text.
Default Value:
None
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.

Control Room URL
Description:
Specifies the base URL for Automation Anywhere Control Room.
Allowed Values:
The Control Room URL comes from Automation Anywhere.
Default Value:
None
Example:
https://trial.cloud.automationanywhere.digital

API Key/Password
Description:
Specifies whether to use an API key to connect to Automation Anywhere Control Room.
Allowed Values:
  • API Key - Uses an API key to connect to Automation Anywhere Control Room.
  • Password - Uses user credentials authentication to connect Automation Anywhere Control Room.
Default Value:
API Key

User Name
Description:
Specifies the user name for Automation Anywhere authentication account.
Allowed Values:
The user name for your Automation Anywhere account.
Default Value:
None
Accepts Variables:
No

API Key
Description:
Specifies the API key to call the Automation Anywhere service.

The API-Key is a 40-character string generated in Automation Anywhere Control Room.

To Open this Field:
  1. On the Automation Anywhere Access Token screen, click API Key .
Allowed Values:
An API key from Automation Anywhere.
Default Value:
None

Password
Description:
The password for the authentication account.
To Open this Field:
  1. On the Automation Anywhere Access Token screen, click Password.
Allowed Values:
An alphanumeric string that represents a password.
Default Value:
None
Accepts Variables:
No

OAuth 2.0 Access Token
Description:
Specifies an OAuth 2.0 access token fromAutomation Anywhere.
Allowed Values:
An OAuth 2.0 access token

This value comes from Automation Anywhere.

Default Value:
None.

Get OAuth 2.0 Access Token
Function:
Sends a request to the Automation Anywhere service to get the access token.

Renewal Rate
Description:
Specifies how frequently to renew your application's access token.
Allowed Values:
  • Disabled
  • Every 10 minutes
  • Every 15 minutes
Default Value:
Disabled

Enable Password Expiry Notification
Description:
Specifies whether to send an email notification when the password is due to expire.
To Open this Field:
  1. On the Automation Anywhere Access Token screen, click Password.
Allowed Values:
  • Selected - Sends an email notification before the password expires.

    By default, this notification is sent 15 days before expiration.

  • Deselected - Does not send an email notification for the password expiration.
Default Value:
Deselected
Limitations:

This field is available in these releases:

Date
Description:
Specifies the date the authentication credentials for the access token expire.

AgilePoint NX sends the notification 15 days before the date specified in the Date field.

To Open this Field:
  1. On the Automation Anywhere Access Token screen, click Password.
  2. Select Enable Password Expiry Notification.
Allowed Values:
A date from the calendar.
  • MM/dd/yyyy - Shows the date in the format Month/day/year.
Default Value:
None
Limitations:

This field is available in these releases:

Email
Description:
Specifies the email address of the user to whom to send the notification about the password expiration.
To Open this Field:
  1. On the Automation Anywhere Access Token screen, click Password.
  2. Select Enable Password Expiry Notification.
Allowed Values:
One line of text (a string) in email address format.
Default Value:
None
Limitations:

This field is available in these releases: