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

Examples

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 Google Drive 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 the 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 Name Definition

Token Name

Function:
Specifies the unique name for your connection to the database.
Accepted Values:
A text string that can have letters, numbers, and 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

Function:
A description for your database access token.
Accepted 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

Function:
Specifies the database technology to store your data.
Accepted Values:
  • SQL Server
  • MySQL
  • Oracle
Default Value:
None
Example:
Refer to:
Limitations:
MySQL and Oracle database support is available in these releases:

Database Server Name

Function:
Specifies the database server name, where your database is installed.
Accepted Values:
A valid database server name.
Default Value:
None
Accepts Process Data Variables:
No
Example:
Refer to:

Database Name

Function:
Specifies the name of your database.
Accepted Values:
The name of your database.

If you select the Enter Database Name check box, the Database Name list becomes unavailable to select a database name. Type a database name in the box.

Default Value:
None
Example:
Refer to:

Port

Function:
Specifies the port number to connect to the database server.
Accepted Values:
A valid port number.
Default Value:
None
Accepts Process Data Variables:
No

Timeout(seconds)

Function:
Specifies the maximum time in seconds to connect to the database.
Accepted Values:
An integer.
Default Value:
600

SSPI (Integrated Security)

Function:
Determines whether the SSPI integrated security is to be activated.
Accepted Values:
  • Deselected - Specifies not to activate the SSPI integrated security.
  • Selected - Specifies to activate the SSPI integrated security.
Default Value:
Deselected

User Name

Function:
Specifies the user name for database 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

Connection Lifetime (Seconds)

Function:
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.
Accepted Values:
An integer, representing a number of seconds.
Default Value:
30
Limitations:
This field is available in these releases:

Enable Pooling

Function:
Specifies whether to use pooling to connect to Microsoft SQL Server.
To Open this Field:
  1. In the Database Type field, select SQL Server.
Accepted 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 ID

Function:
Specifies the ID of the proxy user for Oracle Database authentication.
To Open this Field:
  1. In the Database Type field, select Oracle.
Accepted Values:
A proxy user ID.

The proxy user ID comes from Oracle database.

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

Proxy Password

Function:
Specifies a password for the Oracle Database proxy user authentication account.
To Open this Field:
  1. In the Database Type field, select Oracle.
Accepted Values:
A valid password for the authentication account.
Default Value:
None
Limitations:
This field is available in these releases:

Test Connection

Function:
Makes sure the specified database account is correct.