Access Token for Amazon Redshift

Configure an access token to connect to Amazon Redshift.

Figure: Amazon Redshift Access Token Configuration screen

Amazon Redshift Access Token Configuration screen

Background and Setup

Examples

Prerequisites

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 Amazon Redshift.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None

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.

Connection Type
Description:
Specifies the authentication type to connect to Amazon Redshift.
Allowed Values:
  • Data API - Uses an API access key ID and secret key to conect to Amazon Redshift.
  • ODBC - Uses an Open Database Connectivity (ODBC) connection to connect to the Amazon Redshift cluster.
Default Value:
Data API
Limitations:

Access Key ID
Description:
Specifies an access key ID from Amazon Redshift.
To Open this Field:
  1. On the Amazon Redshift Access Token screen, in the Connection Type field, select Data API.
Allowed Values:
A valid access key ID.
Default Value:
None
Limitations:

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?

Secret Access Key
Description:
Specifies a secret access key from Amazon Redshift.
To Open this Field:
  1. On the Amazon Redshift Access Token screen, in the Connection Type field, select Data API.
Allowed Values:
A valid secret access key.
Default Value:
None
Limitations:

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?

Region
Description:
Specifies the geographic region of the user.
To Open this Field:
  1. On the Amazon Redshift Access Token screen, in the Connection Type field, select Data API.
Allowed Values:
A geographic region from the list.
Default Value:
None

Cluster Identifier
Description:
Specifies the unique identifier of the Amazon Redshift cluster.
To Open this Field:
  1. On the Amazon Redshift Access Token screen, in the Connection Type field, select Data API.
Allowed Values:
A cluster identifier from Amazon Redshift.
Default Value:
None
Example:
redshift-cluster-1-john

User Name
Description:
Specifies the user name for Amazon Redshift authentication.
Allowed Values:
The user name for your Amazon Redshift account.
Default Value:
None

Database Name
Description:
Specifies the name of the database to which to connect in Amazon Redshift.
To Open this Field:
  1. On the Amazon Redshift Access Token screen, in the Connection Type field, select Data API.
Allowed Values:
The name of a database in your Amazon Redshift environment.
Default Value:
None
Limitations:

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?

Quick Config / Manual
Description:
Specifies the type of configuration for Amazon Redshift.
To Open this Field:
  1. On the Amazon Redshift Access Token screen, in the Connection Type field, select ODBC
Allowed Values:
  • Quick Config - Uses the access token configuration UI to configure the connection to Amazon Redshift.
  • Manual - Uses the cluster connection string to connect to Amazon Redshift.
Default Value:
Quick Config
Limitations:

This field is available in these releases:

Endpoint
Description:
Specifies the endpoint URL for Amazon Redshift.
To Open this Field:
  1. On the Amazon Redshift Access Token screen, in the Connection Type field, select ODBC
  2. Select Quick Config.
Allowed Values:
A URL that represents an endpoint for Amazon Redshift.
Example:
examplecluster.abc123xyz789.us-west-2.redshift.amazonaws.com;Database=dev;
Limitations:

This field is available in these releases:

Password
Description:
The password for the authentication account.
To Open this Field:
  1. On the Amazon Redshift Access Token screen, in the Connection Type field, select ODBC
  2. Select Quick Config.
Allowed Values:
An alphanumeric string that represents a password.
Default Value:
None
Limitations:

This field is available in these releases:

Timeout (Seconds)
Description:
Specifies the maximum time in seconds to connect to the Amazon Redshift.
To Open this Field:
  1. On the Amazon Redshift Access Token screen, in the Connection Type field, select ODBC
  2. Select Quick Config.
Allowed Values:
An integer.
Default Value:
600
Limitations:

This field is available in these releases:

Connection String
Description:
Specifies the connection string to authenticate to Amazon Redshift.

The connection string comes from Amazon Redshift.

To Open this Field:
  1. On the Amazon Redshift Access Token screen, in the Connection Type field, select ODBC
  2. Select Manual.
Allowed Values:
One line of text (a string) that can have letters, numbers, spaces, and special characters.
Default Value:
None
Example:
Driver={Amazon Redshift (x64)}; Server=examplecluster.abc123xyz789.us-west-2.redshift.amazonaws.com; Database=dev; UID=adminuser; PWD=insert_your_admin_user_password_here; Port=5439
Limitations:

This field is available in these releases:

Bypass Test
Function:
Specifies whether to verify the Amazon Redshift configuration.
Allowed Values:
  • Selected - Amazon Redshift verification is bypassed, and the configuration is assumed to be valid.
  • Deselected - Amazon Redshift verification is required.
Default Value:
Deselected

Test Connection
Function:
Makes sure the specified Amazon Redshift credentials are correct.