Configuring the Verba Unified IM Recorder Service for Microsoft Teams chat and channel archiving with Export API

This configuration guide described how to configure the Verba Unified IM Recorder service on a Recording Server in the case of a single-recorder environment, or in the case of a highly-available environment where the Recoding Director and the Media Recorder roles are co-located.

In order to complete the steps below, you must have the System Administrator role in Verba.

The configuration consists of the following steps:

Enabling the service

Step 1 - Log in to the Verba web interface and go to System \ Servers menu.

Step 2 - Select your Recording Server from the list, then click on the Service Activation tab.

Step 3 - Activate the Verba Unified IM Recorder Service by clicking on the  icon.

Configuring the Verba Unified IM Recorder Service

Step 4 - Click on the Change Configuration Settings tab.

Step 5 - Expand the Unified IM Recorder \ General node.

Step 6 - Set the Role setting to Director + Recorder.

Step 7 - Expand the Processing Queues node.

Step 8 - Provide the Number of Processing Queues Owned by Recorder Role and the Number of Receiving Queues Owned by Director Role settings. In the case of the single-recorder setup, the values of these two settings have to be the same.

  • The Number of Processing Queues Owned by Recorder Role setting determines the number of processing threads on the Recording Server. The value of this setting is equal to the number of cores of the Recording Server multiplied by two. In a highly-available setup, this has to be the same on all Recording Servers.
  • In the case of a highly-available setup, the Number of Receiving Queues Owned by Director Role settings can be calculated the following way:
"Number of Processing Queues Owned by Recorder Role" setting value * Number of Recording servers = "Number of Receiving Queues Owned by Director Role" setting value

Step 9 - Provide the location of the processing queue root folder at the SMB Queues Path setting. The folder is not allowed to be configured under the media folder Audio Path.

In the case of the single-recorder setup, this folder is preferably on the local disk of the server (e.g.: [APPLICATION_FOLDER]\unifiedimrec\processing_queue). In a HA setup, this is an SMB path.

Step 10 (HA) - Provide a windows domain user credential at the SMB Credential, User and the SMB Credential, Password settings. The service will use this user when accessing the folder provided at the SMB Queues Path setting.

Step 11 - Expand the Recording Providers \ Microsoft Teams node.

Step 12 - At the Microsoft Teams Export API Connection setting, click on the  icon to add a new connection.

Step 13 - In the left panel, provide the following settings:

Setting NameDescription
Application (Client) ID

The ID of the App Registration

(Registering an App for Chat Recording in Azure - Step 6 or Registering the Microsoft Teams Bot in Azure - Step 13)

Application (Client) Secret

The secret created for the App Registration

(Registering an App for Chat Recording in Azure - Step 10 or Registering the Microsoft Teams Bot in Azure - Step 17)

Directory (Tenant) ID

The ID of the Microsoft Entra tenant where the App Registration was created

(Registering an App for Chat Recording in Azure - Step 6 or Registering the Microsoft Teams Bot in Azure - Step 29)

Disable P2P/Group Chat SubscriptionSets whether the P2P or group chats should be recorded or not.
Disable Team/Channel Chat SubscriptionSets whether the Team or Channel chats should be recorded or not.
Forward Proxy AddressIf a forward proxy is being used for the outgoing connection, then the proxy address has to be provided here.
Forward Proxy PortThe port of the forward proxy connection.
Forward Proxy UserThe user of the forward proxy connection. Required, if the proxy requires authentication.
Forward Proxy PasswordThe password of the forward proxy connection. Required, if the proxy requires authentication.
Licensing Model
The licensing model that is used for the chat archiving integration. The following licensing models are available:
  • A: Applications performing a security or compliance function, and requires a supported license. This is the default licensing model.

  • B: Applications that do not perform a security or compliance function.

  • Evaluation Mode: enables access to APIs with limited usage per requesting application for evaluation purposes.

More information: Licensing and payment requirements - Microsoft Graph

Message Polling time (seconds)The polling interval for downloading the chats in seconds.
Message batch sizeThe page size used in the API connection.
Initial date importing fromThe date from where the import should start. If empty, then the first messages will be imported only from the point when the service started.

Step 14 - Click Save.

Step 15 - Repeat steps 12-14 for every Microsoft Teams Export API connection.

Step 16 (Optional) - Set the additional Export API query settings:

SettingDescription
Export API Batch Length in HoursThe number of hours of chat queried retroactively.
Export API Query Delay Timer (seconds)The time delay used in the chat queries. This delay is required because the file attachments are usually not available immediately for download.


Step 17 - Save the changes by clicking on the  icon.

Step 18 - A notification banner will appear on the top. Click on the click here link, so you will be redirected to the Configuration Tasks tab. Click on the Execute button in order to execute the changes.

unexecuted_tasks_v9.png

Starting the service

Step 19 - Click on the Service Control tab.

Step 20 - Start the Verba Unified IM Recorder Service by clicking on the  icon.