Access Token for Salesforce

Configure an access token to connect to Salesforce.

Figure: Salesforce Access Token Configuration screen

Salesforce Access Token Configuration screen

Background and Setup

Video: Set up and Configuration

Examples

Prerequisites

  • A Salesforce user license. There is more than one type of user license.

    For more information, refer to the Salesforce documentation in Third-Party Vendor Documentation.

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 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 used to connect AgilePoint NX applications to external data sources. Salesforce can be used for access tokens, but it can also be used as an authentication provider for NX Portal. Access tokens cannot be used to authenticate to the Portal.

    For more information about configuring authentication providers, refer to Add an Authentication Type.

  • 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 Salesforce. The exact procedure for your access token depends on whether you already have a connection (usually called an app) configured in the external service.

    (Example) How to Get the Access Token Credentials from Salesforce.

  • Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses 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, and 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 Salesforce.
Accepted Values:
A text string that can have letters, numbers, and spaces
Default Value:
None
Example:
Refer to:

Environment
Function:
Specifies if your environment is for development or production.
Accepted Values:
  • Production - The environment uses to contain the production data.
  • Sandbox - The environment uses to create and test your applications.
Default Value:
Production
Example:
Refer to:

Consumer Key
Function:
Specifies the Consumer Key of the app you created or added in Salesforce.
Accepted Values:
A valid consumer key from Salesforce.
Default Value:
None
Example:
Refer to:

Consumer Secret
Function:
Specifies the Consumer Secret of the app you created or added in Salesforce.
Accepted Values:
A valid consumer secret from Salesforce.
Default Value:
None
Example:
Refer to:

Callback 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:

Get OAuth2 Access Token
Function:
Sends a request to the Salesforce application service to get the access token.

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

OAuth2 Access Token
Function:
Specifies an access token, or code, from Salesforce.
Accepted Values:
A valid access token

This value comes from Salesforce.

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.