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 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 used to connect AgilePoint NX apps to external data sources. AgilePoint NX can be used for access tokens, but it can also be used as an authentication provider for AgilePoint NX Portal. Access tokens cannot be used to authenticate to the Portal.
For more information about configuring authentication providers, refer to Authentication.
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.

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 app 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.
In Manage Center, 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.

App Level (Modern Add an App Experience)

Create an access token to use in any process activity or form control in an app you create in the Modern Add an App Experience.

In App Builder, in the Modern Add an App Experience, create an app.
For more information, refer to:
- Modern Add An App Experience (Process-Based App)
- Modern Add An App Experience (Form-Based App)
On the Anything else right now? screen, in the Access Tokens field, click Create.
On the What service do you want your app to access? screen, select AgilePoint NX.
Click Next.

App Level (App Builder)

Create an access token to use in any process activity or form control in a specified app.

Click App Builder.
On the App Builder Home screen, click All Apps.
On the All Apps screen, on an app, click Edit .
On the App Details screen, click Add New > Access Token.
On the What service do you want your app to access? 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 apps. The App Builder shows shortcut buttons in any place you can create an access token.

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

Process Builder
- Any activity on the AgilePoint NX tab

Fields

Field Name	Definition
Token Name	Description: Specifies the unique name for your connection to AgilePoint NX. 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.
User Account	Description: Specifies the user account to connect to AgilePoint NX. Allowed 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	Description: 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. Allowed Values: A valid AgilePoint service URL. Default Value: None
User Name	Description: Specifies the user name for AgilePoint NX authentication. Allowed Values: A valid user name. Default Value: None Accepts Variables: No
Password	Description: The password for the authentication account. To Open this Field: On the SFTP Access Token screen, click Password Authentication. Allowed Values: An alphanumeric string that represents a password. Default Value: None Accepts Variables: No
Authorization	Description: Specifies an authorization value to connect to AgilePoint NX. Allowed 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.
Enable Password Expiry Notification	Description: Specifies whether to send an email notification when the password is due to expire. 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: AgilePoint NX OnDemand (public cloud) AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.0 or higher
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. 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: AgilePoint NX OnDemand (public cloud) AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.0 or higher
Email	Description: Specifies the email address of the user to whom to send the notification about the password expiration. Allowed Values: One line of text (a string) in email address format. Default Value: None Limitations: This field is available in these releases: AgilePoint NX OnDemand (public cloud) AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.0 or higher
Encrypt	Description: 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. Allowed 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 Private Cloud 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.