Access Token for Exchange Server

Configure an access token to connect to Exchange Server.

Figure: Exchange Server Access Token Configuration screen

Exchange Server Access Token Configuration screen

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 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 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 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?

  • 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 Name Definition

Token Name

Function:
Specifies the unique name for your connection to Exchange Server.
Accepted Values:
A text string that can have letters, numbers, and 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

Function:
A description for your access token.
Accepted 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.

E-mail Server

Function:
Specifies the version of your Microsoft Exchange or e-mail server.
Accepted Values:
  • Exchange Server 2007 - Configures this activity to access Exchange Server 2007.
  • Exchange Server 2010/2013 - Configures this activity to access Exchange Server 2010 or 2013.
  • Microsoft 365 - Configures this activity to access e-mail on Microsoft 365.
Default Value:
Exchange Server 2007

URL

Function:
Specifies the Exchange Server URL.
Accepted Values:
  • Exchange Server 2007 - https://[machine name]:[port].
  • Exchange Server 2010/2013 - https://[machine name]:[port]/EWS/Exchange.asmx.
  • Microsoft 365 > Basic - https://outlook.office365.com/EWS/Exchange.asmx
Default Value:
None
Limitations:

Domain

Function:
Specifies the domain name for the Exchange Server.
To Open this Field:
Do one of these:
  • Click Exchange Server 2007 > Custom User.
  • Click Exchange Server 2010/2013 > Custom User.
Accepted Values:
One line of text with no spaces.
Default Value:
None

User Name

Function:
The user name for an Exchange Server administrator.
To Open this Field:
Do one of these:
  • Click Exchange Server 2007 > Custom User.
  • Click Exchange Server 2010/2013 > Custom User.
  • Click Microsoft 365 > Basic.
Accepted Values:
A valid user name.
Default Value:
None
Limitations:

Password

Function:
The password for the authentication account.
To Open this Field:
Do one of these:
  • Click Exchange Server 2007 > Custom User.
  • Click Exchange Server 2010/2013 > Custom User.
  • Click Microsoft 365 > Basic.
Accepted Values:
An alphanumeric string that represents a password.
Default Value:
None
Limitations:

Application ID

Function:
Specifies the Microsoft application ID of the app you created or added in Microsoft Azure Active Directory.
To Open this Field:
  1. Click Microsoft 365 > OAuth2
Accepted Values:
A string with letters and numbers.
Default Value:
None
Limitations:

AgilePoint NX OnDemand (public cloud), or AgilePoint NX Private Cloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher.

Key

Function:
Specifies the key of the app you created or added in Microsoft Azure Active Directory.
To Open this Field:
  1. Click Microsoft 365 > OAuth2
Accepted Values:
A string with letters and numbers.
Default Value:
None
Limitations:

AgilePoint NX OnDemand (public cloud), or AgilePoint NX Private Cloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher.

Reply URL

Function:
Specifies the callback URL from the connected application.
Accepted Values:
A string in URL format.
To Open this Field:
  1. Click Microsoft 365 > OAuth2
Default Value:
https://mysite.com/manage/shared/success.html
Limitations:

AgilePoint NX OnDemand (public cloud), or AgilePoint NX Private Cloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher.

EWS URL

Function:
Specifies the Exchange Web Service URL for Microsoft 365.
To Open this Field:
  1. Click Microsoft 365 > OAuth2
Accepted Values:
https://outlook.office365.com/EWS/Exchange.asmx
Default Value:
https://outlook.office365.com/EWS/Exchange.asmx

AgilePoint recommends that you do not change this value.

Limitations:

AgilePoint NX OnDemand (public cloud), or AgilePoint NX Private Cloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher.

OAuth2 Access Token

Function:
Specifies an OAuth 2.0 access token from Microsoft Azure Active Directory.
To Open this Field:
  1. Click Microsoft 365 > OAuth2
Accepted Values:
An OAuth 2.0 access token

This value comes from Microsoft Azure Active Directory.

Default Value:
None.
Limitations:

AgilePoint NX OnDemand (public cloud), or AgilePoint NX Private Cloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher.

Get OAuth2 Access Token

Function:
Sends a request to the Microsoft Azure Active Directory service to get the access token.

To complete this process, you must sign in to Microsoft Azure Active Directory, and specify your consent when prompted.

To Open this Field:
  1. Click Microsoft 365 > OAuth2
Limitations:

AgilePoint NX OnDemand (public cloud), or AgilePoint NX Private Cloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher.

Renewal Rate

Function:
Specifies how frequently to renew your application's access token.
To Open this Field:
  1. Click Microsoft 365 > OAuth2
Accepted Values:
  • Disabled
  • Every 15 minutes
  • Every half an hour
  • Every hour
Default Value:
Every hour
Limitations:

AgilePoint NX OnDemand (public cloud), or AgilePoint NX Private Cloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher.

Test Connection

Function:
Makes sure the specified Exchange Server account is correct.

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