Access Token for AgilePoint NX

Configure an access token to connect to AgilePoint NX.

Figure: AgilePoint NX Access Token Configuration screen

Background and Setup

Good to Know

In most cases, you can use a global access token or an application level access token:
- Global access tokens are shared across all users and applications. 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 Google Drive account that is only used to share files within a small team.
Access tokens are used to connect AgilePoint NX applications to external data sources. AgilePoint NX can be used for access tokens, but it can also be used as an authentication provider for NX Portal. Access tokens cannot be used to authenticate to the Portal.
For more information about configuring authentication providers, refer to Add an Authentication Type.
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 the App Builder or Manage Center, the access token changes immediately everywhere the access token is used. Changes to application level access tokens apply to all versions of an application, 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?

How to Start

There are several ways to create an access token for AgilePoint NX. How to create the access token depends on where you want to use it.

Global (Manage Center)

You can use a global access token in any application in your AgilePoint NX tenant. Use a global access token if you want any user in your environment to be able to connect to the same external system.

Click Manage .
Click App Builder > Global Access Tokens.
On the Global Access Tokens screen, click Add Token .
On the Add Global Access Tokens screen, select AgilePoint NX .
Click Next.

Application Level (App Builder)

Create an access token to use in any process activity or form control in an application.

Click Build Apps .
In the Application Explorer, on the My Applications pane, click [Application Name] > Shared Resources > Access Tokens.
Click New .
On the New App Token screen, select AgilePoint NX .
Click Next.

Process Activities and Form Controls

Different access token types can be created in context and used in different process activities, form controls, or applications. The App Builder shows shortcut buttons in any place you can create an access token.

You can create an application level access token for AgilePoint NX here:

Process Builder
- Any activity on the AgilePoint NX tab

Fields

Field Name	Definition
Token Name	Function: Specifies the unique name for your connection to AgilePoint NX. Accepted Values: A text string that can have letters, numbers, and spaces Default Value: None
Description	Function: A description for your access token. Accepted Values: More than one line of text. Default Value: None Example: Refer to: (Example) Use Anonymous Authentication in a Form-Based App (Example) Use Anonymous Authentication in a Process-Based App
User Account	Function: Specifies the user account to connect to AgilePoint NX. Accepted Values: Connect to Other AgilePoint Server - Uses REST service authentication credentials. Custom User - Uses credentials you specify. User System Admin Account - Uses the AgilePoint Service Account. Default Value: Custom User
REST Service URL	Function: Specifies the REST AgilePoint Service URL for your tenant. For more information, refer to Find Your AgilePoint Service URL in AgilePoint NX. To Open this Field: Click Connect to Other AgilePoint Server. Accepted Values: A valid AgilePoint service URL. Default Value: None
User Name	Function: Specifies the user name for AgilePoint NX authentication. Accepted Values: A valid user name. Default Value: None Accepts Process Data Variables: No
Password	Function: The password for the authentication account. Accepted Values: An alphanumeric string that represents a password. Default Value: None Accepts Process Data Variables: No
Authorization	Function: Specifies an authorization value to connect to AgilePoint NX. Accepted Values: A valid authorization value. When you click Generate button, this field completes. Default Value: None
Test Connection	Function: Makes sure the specified Active Directory account is correct.
Encrypt	Function: Stores the access token in the AgilePoint database as encrypted data. Note: AgilePoint recommends you to store this access token in the database in encrypted format. Accepted Values: Deselected - The access token is in plain text in the database. Selected - The access token is encrypted in the database. Default Value: Selected Limitations: This field was removed from the UI in AgilePoint NX OnPremises and PrivateCloud v7.0 Software Update 2. Access token credentials are encrypted by default. If you want to store credentials in unencrypted format, contact AgilePoint Customer Support.