Access Token for Box

Configure an access token to connect to Box.

Figure: Box Access Token Configuration screen

Box Access Token Configuration screen

Background and Setup

Examples

The configuration details AgilePoint NX Product Documentation can provide for third-party integrations is limited, especially related to specific business use cases and examples. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

Prerequisites

  • One of these account types:
    • Box Business account
    • Box Enterprise account
    • Box Personal account

Good to Know

  • In most cases, you can use a global access token or an application level access token:
    • Global access tokens are shared across all users and applications. If you want all process designers and form 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 form 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 application level access tokens apply to all versions of an application, 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?.

  • OAuth 2.0 access tokens require a 2-way exchange of credentials between AgilePoint NX and the external service. This means that you must get the credentials from the third-party service to paste in the AgilePoint NX access token, and get the redirect URI from AgilePoint NX to paste in the external service. This requires you to open both the AgilePoint NX access token and the third-party service at the same time, so you can copy and paste from one screen to the other.

    This topic shows the suggested procedure for Box. The exact procedure for your access token depends on whether you already have a connection (usually called an app) configured in the external service.

    How To Get the Access Token Credentials from Box.

  • Documentation for Integrations with Third-Party, External, or Open Source Technologies

    For examples of use case implementations or configuration field input values for third-party products, AgilePoint recommends these resources.For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

    • AgilePoint Community Forums - An AgilePoint-moderated, crowd-sourcing user forum where you can ask questions about specific techniques, the solutions to use cases, workarounds, or other topics that may not be covered in the Product Documentation.
    • Professional Services - If you can not find the information you need for your specific business problem, mentoring is available through AgilePoint Professional Services.
    • Personalized Training - AgilePoint can provide personalized training for your organization. To request personalized training, contact AgilePoint Sales.
    • Third-Party Vendor Documentation - Whenever feasible, AgilePoint provides links to third-party vendor documentation.

      This does not include technology standards or protocols, such as JavaScript, REST, or FTP. Resources for these technical standards are publicly available on the Internet.

Fields

Field Name Definition

Access Token Name

Function:
Specifies the unique name for your connection to Box.
Accepted Values:
A text string that can have letters, numbers, and spaces
Default Value:
None
Example:
Refer to:

Client ID

Function:
Specifies the client ID of the app you created or added in Box.
Accepted Values:
A string with letters and numbers.
Default Value:
None
Example:
Refer to:

Client Secret ID

Function:
Specifies your client secret ID of the app you made or added in Box.
Accepted Values:
A string with letters and numbers.
Default Value:
None
Example:
Refer to:

Redirect URL

Function:
Specifies the callback URL from the connected application.
Accepted Values:
A string in URL format.
Default Value:
https://mysite.com/manage/shared/success.html
Example:
Refer to:

Description

Function:
A description for your access token.
Accepted Values:
More than one line of text.
Default Value:
None
Example:
Refer to:

Box OAuth 2.0 EndPoint URL

Function:
Specifies the endpoint URL for the Box OAuth 2.0 access token.
Accepted Values:
A valid endpoint URL for the Box OAuth 2.0 access token.
Default Value:
https://www.box.com
Accepts Process Data Variables:
No

Box Content API EndPoint URL

Function:
Specifies the endpoint URL for the API used for Box content.
Accepted Values:
A valid endpoint URL for the API used for Box content.
Default Value:
https://api.box.com
Accepts Process Data Variables:
No

Box Upload API EndPoint URL

Function:
Specifies the endpoint URL for the Box API used for file upload.
Accepted Values:
A valid endpoint URL for the Box API used for file upload.
Default Value:
https://upload.box.com
Accepts Process Data Variables:
No

Get OAuth2 Access Token

Function:
Sends a request to the Box application service to get the access token.

To complete this process, you must sign in to Box, and specify your consent when prompted.

OAuth2 Access Token

Function:
Specifies an access token, or code, from Box.com.
Accepted Values:
A valid access token

This value comes from Box.com.

Default Value:
An unique access token.
Example:
Refer to:

Renewal Rate

Function:
Specifies how frequently to renew your application's access token.
Accepted Values:
  • Disabled
  • Every 15 minutes
  • Every half an hour
  • Every hour
Default Value:
Every hour

Encrypt

Function:
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.
Accepted 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 PrivateCloud 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.