Access Token for Exchange Server

Configure an access token to connect to Exchange Server.

Figure: Exchange Server 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?

How to Start

There are several ways to create an access token for Exchange Server. How to create the access token depends on where you want to use it.

Global (Manage Center)

You can use a global access token in any app in your AgilePoint NX tenant. Use a global access token if you want any user in your environment to be able to connect to the same external system.

Click Manage.
In Manage Center, click App Builder > Global Access Tokens.
On the Global Access Tokens screen, click Add Token.
On the Add Global Access Tokens screen, select Exchange Server.
Click Next.

App Level (Modern Add an App Experience)

Create an access token to use in any process activity or form control in an app you create in the Modern Add an App Experience.

In App Builder, in the Modern Add an App Experience, create an app.
For more information, refer to:
- Modern Add An App Experience (Process-Based App)
- Modern Add An App Experience (Form-Based App)
On the Anything else right now? screen, in the Access Tokens field, click Create.
On the What service do you want your app to access? screen, select Exchange Server.
Click Next.

App Level (App Builder)

Create an access token to use in any process activity or form control in a specified app.

Click App Builder.
On the App Builder Home screen, click All Apps.
On the All Apps screen, on an app, click Edit .
On the App Details screen, click Add New > Access Token.
On the What service do you want your app to access? screen, select Exchange Server.
Click Next.

Process Activities and Form Controls

Different access token types can be created in context and used in different process activities, form controls, or apps. The App Builder shows shortcut buttons in any place you can create an access token.

You can create an app level access token for Exchange Server here:

Process Builder
- Any activity on the Exchange Server tab

Fields

Field Name	Definition
Token Name	Description: Specifies the unique name for your connection to Exchange Server. 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.
E-mail Server	Description: Specifies the version of your Microsoft Exchange or e-mail server. Allowed 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	Description: Specifies the Exchange Server URL. Allowed 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: The Basic option is available in AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher.
Domain	Description: 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. Allowed Values: One line of text (a string). Not Accepted: Spaces Default Value: None
User Name	Description: 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. Allowed Values: A valid user name. Default Value: None Limitations: The Basic option is available in AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher.
Password	Description: 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. Allowed Values: An alphanumeric string that represents a password. Default Value: None Limitations: The Basic option is available in AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher.
Application ID	Description: Specifies the Microsoft application ID of the app you created or added in Microsoft Azure Active Directory. To Open this Field: Click Microsoft 365 > OAuth2 Allowed Values: One line of text (a string). Accepted: Letters Numbers Default Value: None Limitations: AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher.
Key	Description: Specifies the key of the app you created or added in Microsoft Azure Active Directory. To Open this Field: Click Microsoft 365 > OAuth2 Allowed Values: One line of text (a string). Accepted: Letters Numbers Default Value: None Limitations: AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher.
Reply URL	Description: Specifies the callback URL from the connected application. Allowed Values: One line of text (a string) in URL format. To Open this Field: Click Microsoft 365 > OAuth2 Default Value: https://mysite.com/manage/shared/success.html Limitations: AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher.
EWS URL	Description: Specifies the Exchange Web Service URL for Microsoft 365. To Open this Field: Click Microsoft 365 > OAuth2 Allowed 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 PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher.
OAuth2 Access Token	Description: Specifies an OAuth 2.0 access token from Microsoft Azure Active Directory. To Open this Field: Click Microsoft 365 > OAuth2 Allowed 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 PrivateCloud 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: Click Microsoft 365 > OAuth2 Limitations: AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher.
Renewal Rate	Description: Specifies how frequently to renew your application's access token. To Open this Field: Click Microsoft 365 > OAuth2 Allowed Values: Disabled Every 15 minutes Every half an hour Every hour Default Value: Every hour Limitations: AgilePoint NX OnDemand (public cloud), or AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v7.0 Software Update 1 or higher.
Test Connection	Function: Makes sure the specified Exchange Server account is correct.
Enable Password Expiry Notification	Description: Specifies whether to send an email notification when the password is due to expire. To Open this Field: On the Access Token Configuration screen, do one of these: Click Exchange Server 2007 > Custom User. Click Exchange Server 2010/2013 > Custom User. Click Microsoft 365 > Basic. 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: AgilePoint NX OnDemand (public cloud) AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.0 or higher
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. To Open this Field: On the Access Token Configuration screen, do one of these: Click Exchange Server 2007 > Custom User. Click Exchange Server 2010/2013 > Custom User. Click Microsoft 365 > Basic. Select Enable Password Expiry Notification. 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: AgilePoint NX OnDemand (public cloud) AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.0 or higher
Email	Description: Specifies the email address of the user to whom to send the notification about the password expiration. To Open this Field: On the Access Token Configuration screen, do one of these: Click Exchange Server 2007 > Custom User. Click Exchange Server 2010/2013 > Custom User. Click Microsoft 365 > Basic. Select Enable Password Expiry Notification. Allowed Values: One line of text (a string) in email address format. Default Value: None Limitations: This field is available in these releases: AgilePoint NX OnDemand (public cloud) AgilePoint NX PrivateCloud or AgilePoint NX OnPremises v9.0 or higher
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.