Access Token for Database

Configure an access token to connect to a database.

Figure: Database Access Token Configuration screen

Database Access Token Configuration screen

Background and Setup

Video: Configure Access Token for Trial SQL Server Database

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 the database.
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 database 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.

Database Type
Description:
Specifies the database technology to store your data.
Allowed Values:
  • SQL Server
  • MySQL
  • Oracle
Default Value:
None
Limitations:
MySQL and Oracle database support is available in these releases:

Quick Config / Manual
Description:
Specifies the type of configuration for the database server.
Allowed Values:
  • Quick Config - Uses the access token configuration UI to configure the connection to the database server.
  • Manual - Uses a connection string to connect to the database server.
Default Value:
Quick Config

Database Server Name
Description:
Specifies the database server name, where your database is installed.
To Open this Field:
  1. On the Database Access Token screen, select Quick Config.
Allowed Values:
A valid database server name.
Default Value:
None
Accepts Variables:
No

Database Name
Description:
Specifies the name of your database.
To Open this Field:
  1. On the Database Access Token screen, select Quick Config.
Allowed Values:
The name of your database.
Default Value:
None

Port
Description:
Specifies the port number to connect to the database server.
To Open this Field:
  1. On the Database Access Token screen, select Quick Config.
Allowed Values:
A port number.
Default Value:
None
Accepts Variables:
No

Timeout (Sec)
Description:
Specifies the maximum time in seconds to connect to the database.
To Open this Field:
  1. On the Database Access Token screen, select Quick Config.
Allowed Values:
An integer.
Default Value:
600

SSPI (Integrated Security)
Description:
Determines whether the SSPI integrated security is to be activated.
To Open this Field:
  1. On the Database Access Token screen, select Quick Config.
Allowed Values:
  • Deselected - Specifies not to activate the SSPI integrated security.
  • Selected - Specifies to activate the SSPI integrated security.
Default Value:
Deselected

User Name
Description:
Specifies the user name for database authentication.
To Open this Field:
  1. On the Database Access Token screen, select Quick Config.
Allowed Values:
A valid user name.
Default Value:
None
Accepts Variables:
No

Password
Description:
The password for the authentication account.
To Open this Field:
  1. On the Database Access Token screen, select Quick Config.
Allowed Values:
An alphanumeric string that represents a password.
Default Value:
None

Connection Lifetime (Seconds)
Description:
Specifies the maximum amount of time, in seconds, permitted to open the connection before it closes.
To Open this Field:
  1. In the Database Type field, select SQL Server.
  2. Select Quick Config.
Allowed Values:
An integer.

Represents

  • A number of seconds
Default Value:
30
Limitations:
This field is available in these releases:

Enable Pooling
Description:
Specifies whether to use pooling to connect to Microsoft SQL Server.
To Open this Field:
  1. In the Database Type field, select one of these:
    • SQL Server
    • MySQL
    • Oracle
  2. Select Quick Config.
Allowed Values:
  • Selected - Enables pooling to connect to Microsoft SQL Server.
  • Deselected - Disables pooling to connect to the Microsoft SQL Server.
Default Value:
Selected
Limitations:
This field is available in these releases:

Proxy User Name
Description:
Specifies the user name of the proxy user for Oracle Database authentication.
To Open this Field:
  1. In the Database Type field, select Oracle.
  2. Select Quick Config.
Allowed Values:
A proxy user name.

The proxy user name comes from Oracle database.

Default Value:
None
Limitations:
This field is available in these releases:

Proxy Password
Description:
Specifies a password for the Oracle Database proxy user authentication account.
To Open this Field:
  1. In the Database Type field, select Oracle.
  2. Select Quick Config.
Allowed Values:
A valid password for the authentication account.
Default Value:
None
Limitations:
This field is available in these releases:

Save Without Testing
Function:
Specifies whether to verify the database configuration.
Allowed Values:
  • Selected - The database verification is bypassed, and the configuration is assumed to be valid.
  • Deselected - The database verification is required.
Default Value:
Deselected

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 Database Access Token screen, select Quick Config.
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 Database Access Token screen, select Quick Config.
  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 Database Access Token screen, select Quick Config.
  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:

Connection String
Description:
Specifies the connection string to authenticate to the database server.

The connection string comes from your database server.

To Open this Field:
  1. On the Database Access Token screen, select Manual.
Allowed Values:
One line of text (a string) that can have letters, numbers, spaces, and special characters.
Default Value:
None
Example:
Server=myServerAddress;Database=sales;Port=5432;User ID=admin;Password=mypassword;

Test Connection
Function:
Makes sure the specified database account is correct.