Configuring the Verba Unified IM Recorder Service for Microsoft Teams chat and channel archiving with DLP/Webhook API
- Kiss, Mate
- Zszugyi
- Gabor Moczar (Unlicensed)
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. 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 setting, click on the 
icon to add a new connection.
Step 13 - In the left panel, provide the following settings:
| Setting Name | Description |
|---|---|
| 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) |
| Notification URL | The notification URL of the Unified IM Recorder service. The format is the following: https://server_CNAME.domain.com:3333/msteams. Note: in case you're using any kind of network element that accepts incoming messages from Microsoft Teams servers and forwards it to your recorder(s), here you should use the port opened on that network element (not necessarily 3333). The port the recorder awaits messages on is configured in the next field. The Microsoft Graph API limits the subscriptions to resources on the same Tenant and AppID to 1. Because of this, the only correct way to create a highly available configuration with 2 Recording Directors is to configure recorders with the same Notification URL and Connection Encryption Certificate, and set the notification URL for a load balancer that distributes incoming requests between the running recorders. If configurations differ and multiple recorders are set up for the same Tenant and AppId, because of the Microsoft API limit of 1 subscription, each recorder will constantly delete other recorders' subscriptions and create their own. |
| Event Listener Port | The event listener port of the Unified IM Recorder service. Set it to 3333. |
| Connection Encryption Certificate | The thumbprint of the certificate that is used for the connection. The certificate has to reside in the Windows Certificate Store. The same certificate has to be used for all Teams connections on all the servers. Alternatively, a certificate file can be used instead of the Windows Certificate Store. In this case, the path to the .crt file has to be provided. |
| Connection Encryption Key file | If the file path is provided at the Connection Encryption Certificate setting, then the path to the .key file has to be provided here. |
| Connection Encryption Key file password | If the file path is provided at the Connection Encryption Certificate setting, then the password of the .key file has to be provided here. |
| Connection Encryption trust list | The thumbprint of the incoming connection certificates that should be trusted, or the thumbprint of the CA certificates whose certificates should be trusted. If left empty, all certificates will be trusted. |
| Disable P2P/Group Chat Subscription | Sets whether the P2P or group chats should be recorded or not. |
| Disable Team/Channel Chat Subscription | Sets whether the Team or Channel chats should be recorded or not. |
| Forward Proxy Address | If a forward proxy is being used for the outgoing connection, then the proxy address has to be provided here. |
| Forward Proxy Port | The port of the forward proxy connection. |
| Forward Proxy User | The user of the forward proxy connection. Required, if the proxy requires authentication. |
| Forward Proxy Password | The 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:
More information: Licensing and payment requirements - Microsoft Graph |
Step 14 - Click Save.
Step 15 - Repeat steps 12-14 for every Microsoft Teams connection.
Step 16 - Save the changes by clicking on the 
icon.
Step 17 - 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.
Step 18 - Click on the Service Control tab.
Step 19 - Start the Verba Unified IM Recorder Service by clicking on the 
icon.