Access Token for SFTP

Configure an access token to connect to an SFTP service.

Figure: SFTP Access Token Configuration screen

SFTP 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 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 SFTP.
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.

Authentication Types
Description:
Specifies the authentication type to connect to your SFTP server.
Allowed Values:
  • Password Authentication - Uses the specified user credentials to connect to SFTP server.
  • SSH Key Authentication - Uses the public key authentication to connect to SFTP server.
Default Value:
Password Authentication
Limitations:
The SSH Key Authentication option is available in these releases:

Port Number
Description:
Specifies the port number to connect to the SFTP server.
Allowed Values:
A port number.
Default Value:
22
Accepts Variables:
No

Host / IP Address
Description:
Specifies the host name or IP address of your SFTP server.
Allowed Values:
A valid host name or IP address of your SFTP server.
Default Value:
None
Example:
  • 192.168.112.139
  • ftp.example.com

User Name
Description:
Specifies the user name for SFTP 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:
  1. On the SFTP Access Token screen, click Password Authentication.
Allowed Values:
An alphanumeric string that represents a password.
Default Value:
None
Accepts Variables:
No

Private Key Password
Description:
Specifies the password for the private key file.
To Open this Field:
  1. On the SFTP Access Token screen, click SSH Key Authentication.
Allowed Values:
An alphanumeric string that represents a password.
Default Value:
None
Limitations:

This field is available in these releases:

Upload Private Key
Description:
Specifies a private key file to connect to SFTP.
To Open this Field:
  1. On the SFTP Access Token screen, click SSH Key Authentication.
Allowed Values:
A file that stores a private key.

Click the Private Key button to select a file from your machine.

Default Value:
None
Limitations:

This field is available in these releases:

Enable PGP Encryption / Decryption
Description:
Specifies whether to use Pretty Good Privacy (PGP) to encrypt or decrypt the content when a file is uploaded or downloaded with SFTP.

PGP uses a key pair that consists of a public key and a private key to encrypt and decrypt the file content.

Allowed Values:
  • Selected - Uses PGP to encrypt or decrypt the content when a file is uploaded or downloaded.
  • Deselected - The content does not encrypt or decrypt when a file is uploaded or downloaded.
Default Value:
Deselected
Limitations:

This field is available in these releases:

Upload PGP Public Key
Description:
Specifies a PGP public key file to encrypt the content when a file is uploaded with SFTP.
To Open this Field:
  1. On the SFTP Access Token screen, select Enable PGP Encryption / Decryption.
Allowed Values:
A PGP public key file in .asc format.

Click the PGP Public Key button to select a file from your machine.

Default Value:
None
Limitations:

This field is available in these releases:

Upload PGP Private Key
Description:
Specifies a PGP private key file to decrypt the content when a file is downloaded with SFTP.
To Open this Field:
  1. On the SFTP Access Token screen, select Enable PGP Encryption / Decryption.
Allowed Values:
A PGP private key file in .asc format.

Click the PGP Private Key button to select a file from your machine.

Default Value:
None
Limitations:

This field is available in these releases:

PGP Private Key Password
Description:
Specifies the password for the PGP private key.
To Open this Field:
  1. On the SFTP Access Token screen, select Enable PGP Encryption / Decryption.
Allowed Values:
An alphanumeric string that represents a password.
Default Value:
None
Limitations:

This field is available in these releases:

Test Connection
Function:
Makes sure that the specified SFTP credentials are 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:

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:

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:

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.