Add a Microsoft Exchange data source - OAuth2

Requirements

You have installed the Intrexx MediaGateway.

For detailed information, please refer to the section MediaGateway installation.

Step-by-step guide

To add a Microsoft Exchange data source in the Intrexx Portal Manager and set up authentication via OAuth2, please proceed as follows:

Open the "Integration" menu.
Select "Connector for Microsoft Exchange" under "Consume data".
Right-click on the item and select "New data source" from the context menu.

The "New data source - General" dialog will open.

Configure MediaGateway connection
Field descriptions
Connection name

This name will be used to select the connection later in applications.

Host, Port, Time zone

Enter the Host, Port and Time zone for the MediaGateway server.

Generally, the MediaGateway will use port 8087 for connections as well as port 9087 for SSL encrypted connections.

Use gRPC instead of COBRA (classic)

If you select this checkbox, the gRPC framework is used. The INTREXX GmbH recommends the use of this option.

If you do not select this checkbox, the CORBA framework will (continue to) be used.

More information
- https://grpc.io/
- https://www.corba.org/
Use SSL

If you select this checkbox, communication between the Media Gateway server and the Exchange server is encrypted.

SSL port

Enter the port on the media gateway server to be used for the encrypted connection.

Password/Change password

When creating a new Microsoft Exchange data source, you must enter the password for the Intrexx MediaGateway here. During the installation, you assigned the password to the Intrexx MediaGateway.

You should change the default password. You can do this here after the data source has been created.

More information

Configure MediaGateway connection
Click on "Next".

The "New data source - Exchange version" dialog will open.

Select Microsoft Exchange version

Field descriptions

Microsoft Exchange Server version

Select the version of your Exchange Server here. Microsoft Exchange Server 2003 or 2007 and Microsoft Exchange Server 2010 or higher are supported by the Intrexx MediaGateway.

Select the "Microsoft Exchange Server 2010-2019 or 365" option if you are using Microsoft Exchange Online.
Click on "Next".

The "New data source - Authentication" dialog will open.

Select OAuth2 as authentication type
Select "OAuth2 (only with MS365)".

Field descriptions

Exchange username / mailbox / server URL

Click on one of the entries to specify which information should be pre-populated when logging on to Microsoft Exchange and which information the user must enter manually.

(Screenshot shows the Exchange username configuration dialog)

Value from web query

Uses the user name that a user enters to the login box of an Intrexx Exchange application.

Static value

Here, a fixed value can be entered that will be automatically entered into the login box when a user wants to log in.

Value from User Manager

You can select a field from the "User" module here, and enter its value in the login box. In this process, Intrexx determines the currently logged-in user and delivers the corresponding data.

Show value on the web

This setting is selectable if the option "Static value" or "Value from user manager" has been selected. This will cause the corresponding value to be shown in the login box on the web when the user logs in.

Administration

Overview of known users

Opens a dialog which contains a list of the users in the MediaGateway. This link is clickable if MediaGateway accounts have already been created because users have logged in.

Overview of known users

Opens a dialog which contains a list of the users in the MediaGateway. This link is clickable if MediaGateway accounts have already been created because users have logged in.

Query login data session-based on the web

This checkbox is not relevant for the authentication type "OAuth2 (only with MS365)".
Click on "Next".

The "New data source - Exchange account" dialog will open.

Enter access data and OAuth2 data
Field descriptions
User name / Password

Enter the login details to a user inbox created on the Microsoft Exchange server. The account requires no special permissions. The Connector for Microsoft Exchange will use this account to query meta-information from the Exchange server, which will then be available when creating applications, and delivers information about data fields, field types, and existing tables.

Email

Enter the name of the Exchange inbox or the email address. Make sure to use the primary inbox address. If you use an alias address, the functions of the Connector may be limited in some cases.

Server (URL)

Enter the URL of the Microsoft Exchange server here that assumes the Client Access role (e.g. the OWA server).

The Exchange Server can be a server that you host yourself or on Microsoft Exchange Online.

Example
- Self-hosted Exchange Server from Exchange 2010 onwards
  
  https://mailserver.mycompany.org/ews/Exchange.asmx
  
  Usually, the URL begins with the protocol https followed by the fully qualified server name and "/ews/Exchange.asmx " (Exchange 2010 or later).
- Microsoft Exchange Online
  
  https://outlook.office365.com/ews/Exchange.asmx
MS365 OAuth2 configuration

You must enter the details from Microsoft Azure in this area.

Tenant ID

Enter the Tenant ID here. You can find this in Microsoft Azure in the "Directory-ID (tenant)" field ().

Client ID

Enter the application ID (client ID) here. You can find this in Microsoft Azure in the "Application ID (client ID)" field ().

Client secret

Enter the value (!) of the client secret here. You can find this in Microsoft Azure under the "Certificates & secrets" menu item. More detailed information is available in the section Create client secret.

Redirect URI

The redirect URI is composed as follows:

<Base URL>/oauth2/token/msexchange

The redirect URL for the base URL "https:/exampleportal.com/" looks as follows:

https:/exampleportal.com/oauth2/token/msexchange

Note You can find the base URL via the "Portal" menu -> "Portal properties".

Request MS365 refresh token

To log on to Microsoft Exchange, you need an access token. This is automatically generated when logging on to Microsoft Exchange. For security reasons, access tokens are only valid for approx. 1 hour. After that, a new access token is generated automatically. This is done by the refresh token. You must request this manually in the Connector for Microsoft Exchange on the Exchange Account tab. You must do this for the user you use when creating the data source ().

You also need to request it for the additional users you use in applications and processes ().

The refresh token is stored in the MediaGateway. It is valid for three months. The token must then be manually requested again.

Detailed step-by-step instructions for requesting an MS365 Refresh Token can be found in section Request MS365 refresh token (update token).
Click on "Next".

The "New data source - Additional users" dialog will open.

Assign additional users

In this dialog, you can assign Intrexx users to an Exchange user.
Step-by-step instructions
Step-by-step guide

To assign an Intrexx user to an Exchange user, proceed as follows:
1. Click on (Add)
  
  The "User assignment" dialog box will open.
2. Click on (select user).
3. Select the desired user in the subsequent dialog.
4. Specify the required information. (See the "New data source - Exchange account" dialog box above)
5. Request an MS365 refresh token.
  
  Detailed step-by-step instructions for requesting an MS365 Refresh Token can be found in section Request MS365 refresh token (update token).
6. Click on "OK".
  
  You return to the "New data source - Additional users" dialog box.
Click on "Next".

The "New data source - Connection test" dialog will open.

Perform connection test
Click on the individual connection tests.

If the connection tests are successful, the dialog box looks like this.
Click on "OK".

You will return to the "Design" module.

The newly created data source is displayed.