Skip to main content
Mitratech Success Center
Client Support Center

Need help? Click a product group below to select your application and get access to knowledge articles, webinars, training content, and release notes or to contact our support team.

Authorized users - log in to create a ticket, view tickets status and check your success plan details.

 

Installation Guide for O365 5.0

  1. Last updated
  2. Save as PDF

Overview

TeamConnect O365 Add-in 5.0 is a newly developed product utilizing Microsoft’s latest Add-in technology to integrate TeamConnect with Outlook.

This document is a guide that details the prerequisites, system requirements, step-by-step installation instructions, and troubleshooting for the TeamConnect O365 Add-in 5.0. These details are the instructions to generate a manifest and deploy the Add-in. Once the manifest is generated and the Add-in is deployed, the final TeamConnect O365 Add-in 5.0 configuration is automatically available for the end users within the duration mentioned by Microsoft post-deployment.

Introduction

TeamConnect O365 Add-in 5.0 introduces a different way to integrate with Microsoft Outlook, leveraging the Microsoft Add-in technology. Its purpose is to empower attorneys and users by allowing them to conveniently access commonly used TeamConnect features through Outlook 365, rather than TeamConnect.  To locate and determine the user’s TeamConnect Version, refer to the Add-in Installation section below.

The TeamConnect O365 Add-in 5.0 is deployed to the end users using the admin center of Microsoft 365 and needs to be handled by the client's IT, irrespective of the fact whether they are a hosted TeamConnect client or deploy TC on-premise. 

System Requirements 

The following are the essential system requirements to implement TeamConnect O365 Add-in 5.0:

  1. Users must have an active Outlook 365 license and a TeamConnect user account.
  2. TeamConnect O365 Add-in 5.0 requires a TeamConnect Enterprise 8.0 version or higher.
  3. Installation of TeamConnect O365 5.x module via Available Updates in Admin Settings → About.
  4. Compatible web browsers are Google Chrome, Microsoft Edge, Mozilla Firefox, and Safari (version 17.2.1 or above).
  5. As Safari is not supported, we suggest you utilize an alternative web browser on your Mac.
  6. Compatible Desktop versions are Windows and Mac. 
  7. TeamConnect Add-in should be installed in the Microsoft 365 Admin Center.
  8. The TeamConnect O365 Add-in is not supported on Outlook 2019 or earlier versions on the desktop.
Outlook Plug-in Support
  1. The legacy Office plug-in is not supported with TeamConnect 8.0 and above.
  2. Only the Outlook Add-in 5.0 is compatible, as it includes the JDK 21 upgrade and mobile compatibility changes.
  3. Users attempting to connect via the plug-in will see the following message:
    “The Office plug-in is not supported with TeamConnect 8.0 and above. Please contact Mitratech Support to install the web add-in and access the latest features.”

Administrator Responsibilities

The following table outlines the specific responsibilities of the TeamConnect Administrator and Microsoft 365 Administrator.

Task/Activity Responsible Admin
Azure Keys for Graph API Configuration Microsoft Admin
Register Application in Azure Microsoft Admin
Managing Permission Type Settings in TeamConnect TeamConnect Admin
Configure Client Secret and IDs Microsoft Admin
Generate the Manifest File TeamConnect Admin
Add-in Deployment and Redeployment (after updates) Microsoft Admin
Add-in Configuration TeamConnect Admin
Mobile Add-in Enablement TeamConnect Admin
Migration from Plugin to Add-in TeamConnect Admin
Webhook / Notifications Configuration Microsoft Admin

Outlook Integration with TeamConnect

Prior to initiating the integration process, it is advisable to examine the Admin guide accessible through the following link:  Admin Guide 

Add-in Installation

Prerequisites

  1. To install the Add-in on Windows desktops, ensure that Modern Authentication is enabled in the Microsoft 365 Admin Center under Settings. In the Microsoft 365 admin center, go to Settings → Org Settings → Modern Authentication. Select the checkbox to enable Modern Authentication.
  2. For newly installed TeamConnect 7.1, along with the Office Suite plugin, clients will be required to perform an upgrade to the TeamConnect O365 Add-in 3.X version. 

License Setup and Updates

Before you initiate the license setup process, you need to verify the license file:

  • If you are an existing Outlook Plug-in user, your TeamConnect license file should already include the Office Add-in license.
  • If you are setting up the Office Add-in for the first time, ensure that the license file you are using includes the Office Add-in license.
  • If the license is not included, contact Mitratech Support to obtain the correct license file.
Important:

New Users – Make sure your TeamConnect license file includes the Office Add-in license before setting up the Add-in. Contact Mitratech Support if it is missing.
Existing Plug-in Users – Your current license file already contains the Office Add-in license. You can directly upgrade without requesting a new license.

 

Instructions to Follow Screenshot for Reference

Step 1: Upload License File (if required)

  1. Navigate to Admin Settings → About in TeamConnect.
  2. Scroll to the License section.
  3. Click Upload License.
  4. In the pop-up window, click Choose File and select your license file.
  5. Click Upload to apply the license.

Step 2: Check for Available Updates  

  1. In the Installed Products section, scroll to the Available Updates area.
  2. If you are upgrading from a plug-in, the new Add-in will appear here.
  3. For new users, once the license is verified, the Add-in will also be visible in this section.
  4. The version you wish to upgrade/install will either:
  5. Show Install Now → proceed with installation directly 
  6. Show Available upon request → contact Mitratech Support to obtain this version.

Step 3: Verify Installed Products

  1. Go to Admin Settings → Installed Products. 
  2. The latest installed version is displayed:
    • In the header section.
    • In the description of each line item (these descriptions will match the header). The installed product is visible in the Installed products section.
Note: After you install the product, restart the server. Then install the module, configure the required group-level permissions, and enable the module so that users can access it.

Add-in Limitations

  1. We do not support using the previous Office Suite Plug-in (for Outlook) and the new Add-in simultaneously. It is highly recommended to uninstall the previous Plug-in before proceeding with the installation of the new Add-in.
  2. The legacy Office plug-in is not supported with TeamConnect 8.0 and above.
  3. File check-in/check-out is supported in the Outlook Add-in, rather than in Word, PowerPoint, and Excel. Users can efficiently manage files through the Outlook Add-in or directly through TeamConnect for seamless file handling.

Azure Keys for Graph API Configuration

TeamConnect utilizes the Microsoft Graph API to communicate with the Microsoft Exchange server. Below are comprehensive, step-by-step instructions on configuring Azure keys for the Graph API.

Register Application in Azure

  1. Go to the Azure Active Directory.
    (Note: This website is external and managed by Microsoft, not under the Mitratech domain.)
  2. Sign in with your Azure admin account that has administrative privileges to the organization’s M365 domain.

Azure Homepage

  1. Navigate to App Registrations → New Registration.
  2. Enter a name for the registration.
  3. Select the Single Tenant option for Supported Account Types.
  4. Click Register.

Managing Permission Type Settings in TeamConnect

In TeamConnect → Admin → Office Suite, admins can select or change the Permission Type at any time. The available options are provided as radio buttons:

  • Delegated Permissions
  • Application Permissions
  • None
Important: To access the Tasks functionality, select the permission type as ‘Delegated permissions’.

Based on the permission type selected, you can follow the instructions provided below:

Click here if the Permission Type is Application Permissions

Configuration:

  1. Navigate to TeamConnect → Admin → Office Suite and select Application Permissions.
  2. Populate all fields under the Graph API Keys section.

Default Behavior:

  • By default, the option is set to None for both Plug-in Clients and Add-in Clients.
  • Admins must manually switch from None to Application Permissions when required.

Migration Requirement:

  • During migration, admins must manually set the Permission Type to Application Permissions to ensure proper configuration.

Admin Options:

  • When Application Permissions are selected, the process works as it does in TCE 7.2 and below. 

Configure API Permissions in Azure

Instructions Screenshot for Reference
  1. In the Azure portal, remove existing API permissions.
  1. Go to the API Permissions tab on the left task pane.
 APP Registrations
  1. Click Add a Permission.
  2. Select Microsoft Graph → Application Permissions.
  3. Click Add Permissions.
  4. Search for User Permissions and add User.Read.All.
  1. Search for Calendars and add Calendars.ReadWrite.

Permissions Required for Mobile Add-in

  1. In addition to existing user permissions, uploading documents to a matter via the mobile Add-in requires the Mail.Read permission.
  2. Ensure that users who need to upload documents from mobile devices have this permission assigned. 
  1. The added permissions are displayed. You need to grant admin consent for all the permissions added.

Reauthentication:

  • If a user has been inactive for a while, they will be prompted to log in again.

Switching Away from Application Permissions:

  • If changed to Delegated Permissions or None, previously stored tokens remain unused but stay in the database.

  • These can be cleared manually by an admin using an SQL query (optional).

 

Click here if the Permission Type is Delegated Permissions

Configuration

  1. Navigate to TeamConnect → Admin → Office Suite and select Delegated Permissions.
  2. Populate all fields under the Graph API Keys section.

Configure API Permissions in Azure

Instructions  Screenshot for Reference
  1. In the Azure portal, remove existing API permissions.
  1. Go to the API Permissions tab on the left task pane.
 APP Registrations
  1. Click Add a Permission.
  2. Select Microsoft Graph → Delegated Permissions.
  3. Click Add Permissions.
  4. Search for User Permissions and add User.Read.All.
  1. Search for Calendars and add Calendars.ReadWrite.
  2. Search for Tasks and add Tasks.ReadWrite.All.

Note: This applies only to delegated permissions.

  1. In addition to existing user permissions, uploading documents to a matter via the mobile Add-in requires the Mail.Read permission.
  2. Ensure that users who need to upload documents from mobile devices have this permission assigned.

 
  1. The added permissions are displayed. You need to grant admin consent for all the permissions added.

Configure Azure Keys

  1. Navigate to Azure portal → App Registrations.
  2. Under Manage, go to Authentication to configure Redirect URIs.

Add or Update Redirect URI

  1. In the Redirect URIs section:

    1. Click Add a platform or edit an existing platform (e.g., Web).
    2. Use the following format for the Redirect URI:
    3. https://<YourServerInstance>/officeAuthentication.htm
    4. Replace <YourServerInstance> with your specific server instance address.
    5. Click Save.

  2. Ensure Notifications API Access

    1. Confirm that the Notifications API of TeamConnect is accessible to Microsoft’s Graph API to enable Web Hook synchronization.
    2. If whitelisting Microsoft’s IPs, refer to Microsoft’s documentation: Additional Office 365 IP Addresses and URLs ↗.
    3. For more information on Webhook Notifications, refer to the Admin guide ↗.

  3. Finalize Configuration

    1. Click the Update button in the Azure portal.
    2. Azure Keys for Graph API are now configured.

Default Behavior:

  • By default, the option is set to None for both Plug-in Clients and Add-in Clients.
  • Admins must manually switch from None to Delegated Permissions when required.

Consent and Revocation:

  1. Admins can revoke user-granted consent for delegated permissions at any time.
  2. To fully revoke access, tokens must be invalidated via the Graph API.

Refer to Microsoft documentation:

  1. Revoke permissions using Microsoft Graph PowerShell ↗
  2. Revoke permissions using Microsoft Graph ↗

Reauthentication:

  • Users inactive for a long period will be prompted to log in again.

Switching Away from Delegated Permissions:

  • If changed to Application Permissions or None, stored access and refresh tokens remain in the TeamConnect database but become unused.
  • These tokens remain valid in Microsoft but can be removed manually by an admin using an SQL query (optional).

 

Settings in Microsoft Admin Center

 

Use the Settings in Microsoft Admin Center to configure and validate Microsoft Graph API credentials, ensuring seamless integration with the Outlook 365 Add-in.

 

Configure Client Secret and IDs 

 

Instructions Screenshot for Reference
  1. To grant permissions, go to the Certificates & Secrets tab in Azure → New Client Secret → Add a description.
  2. Once the new client secret is added, copy the Client Secret Value (it disappears if you navigate away).
  3. Navigate to the TeamConnect → Admin → Admin Settings → Office Suite → Graph API Config Keys, paste the copied value in Client Secret.
  1. From Azure Overview, copy the Application (Client) ID → paste it at Graph API Config Keys in TeamConnect under Application ID. 
  1. From Azure Overview, copy the Directory (Tenant) ID → paste it at Graph API Config Keys (in TeamConnect) → Tenant ID.
  1. Click the Update button.
  2. The Azure Keys for Graph API are now configured.