Access Token for Salesforce

Configure an access token to connect to Salesforce.

Salesforce Access Token Configuration screen


Salesforce Access Token Configuration screen

Video: Set up and Configuration

Background and Setup

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 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 the AgilePoint 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.

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

    The highest priority for AgilePoint NX Product Documentation is accuracy. Whenever feasible, AgilePoint provides input details, business rules, or example values for third-party integrations. These can include any technology that is not native to AgilePoint NX, such as Salesforce, Active Directory, or REST. However this information is subject to change without notice to AgilePoint. Because we can not guarantee the accuracy of this information, the details provided for third-party product input values, as well as examples for third-party product integrations, are limited in the AgilePoint documentation. It is the responsibility of third-party vendors to provide documentation related to these aspects of their software and services.

    For examples of use case implementations or configuration field input values for third-party products, AgilePoint recommends these resources:

    • 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

Token Name

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

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

Consumer Key

Function:
Specifies the Consumer Key of the app you created or added in Salesforce.

For more information, refer to How Do I Find the Consumer Key and Consumer Secret in Salesforce?.

Accepted Values:
A valid consumer key from Salesforce.
Default Value:
None

Consumer Secret

Function:
Specifies the Consumer Secret of the app you created or added in Salesforce.

For more information, refer to How Do I Find the Consumer Key and Consumer Secret in Salesforce?.

Accepted Values:
A valid consumer secret from Salesforce.
Default Value:
None

Callback URL

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

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.

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

Get Your Credentials in Salesforce

To find the Consumer Key and Consumer Secret ID in Salesforce, do the procedure in this topic.

Prerequisites

  • A Salesforce account.

How to Start

  1. Sign in to your Salesforce environment.

Procedure

  1. On the top menu bar, click Setup.


  2. On the Build App section, click Add App.


  3. On the Connected App section, click New.


  4. On the New Connected App screen, enter your Connected App Name, API Name, and Contact E-mail information.


  5. Select Enable OAuth Settings.


  6. In Callback URL field, paste the Redirect URL from your Salesforce access token screen.

    For more information, refer to Access Token for Salesforce.



  7. Add these OAuth scopes from Available OAuth Scopes to Selected OAuth Scopes.
    • Full access (Full)
    • Perform requests on your behalf at any time (refresh_token,offline_access)


  8. Click Save.

    The Consumer Key is created and displayed, and the Consumer Secret is created.