Configuring Microsoft Lync Scanning & Archiving

Introduction

Lync is an intra-corporate communication tool developed by Microsoft (MS). The Netbox Blue MS Lync archiving solution scans and archives instant messaging communications. The following specific features are supported:

  • Two way conversations
  • Group conversations with attachments

There is also the ability to pass these records through alerting rules defined on the Netbox if required.

Prerequisites

The following conditions must be met before configuring the Netbox Lync Archiving service.

  1. A Microsoft Lync environment must be set up, with the Monitoring and Archiving role enabled.
  2. A Netbox appliance must be installed, registered with a valid sitekey, and have appropriate permissions through any firewalls.

These prerequisites fall outside the scope of this document. Please consult the relevant guides.

Overview

To enable MS Lync scanning and archiving the following steps need to be completed:

  1. Configuration of the Netbox appliance to accept the Lync traffic.
  2. Configuration of an ODBC connection that the Netbox Lync service will use.
  3. Installation and configuration of the Netbox MS Lync windows service.

Setup and Configuration

Configure the Netbox appliance to accept and archive Lync traffic

  • Browse to Content Scanning -> General
  • Enable SafeChat scanning of web content
  • Enable SafeChat scanning of instant messaging clients
  • Set Archival mode to “Text and Attachments”
  • Port to listen on for the MS Lync archiving service, specifies which port the Netbox will communicate with the Windows service
    • If this option is not available, please contact customer support to have this enabled
    • Take note of this port and open any firewall rules in the Windows environment
    • The Netbox has two Ethernet connections: the internet side and the LAN side, the Lync service can connect to either of these
  • Click on the Update button
  • Browse to Content Scanning -> General
  • Enable SafeChat scanning of web content o Enable SafeChat scanning of instant messaging clients
  • Set Archival mode to “Text and Attachments”

Install the MS Lync service on the MS Lync database server

The MS Lync service is a Windows service, that reads the MS Lync Archive database for new records, and sends them to the Netbox appliance for archiving.
The installer for this service can be obtained directly from the Netbox by logging onto the Netbox UI, and browsing to Content Scanning > General and clicking on the link where it states, “The MS Lync service may be downloaded here“.
The installer is a .msi file, that will deploy a Windows service, running under the LocalSystem account.

Ensure that the MS Lync service has started

Ensure that the MS Lync Windows service has started. To view the list of services, navigate to Start -> Services. The MS Lync service is named as the Netbox Archiving Support Service for Microsoft Lync.

Configure the MS Lync service

The service is configured via a simple web configuration page. Open a web browser and navigate to http://localhost:8000/ to access the configuration of the MS Lync service. The following list of configuration values is an example of what is required.

Hostname: demo.safenetbox.biz
Netbox Port: 62001
Local Web UI Port: 8000
Lync Database DSN: DRIVER={SQL Server};Server=LABS08-LYNC\ ARCHIVE;Database=LcsLog;Trusted_ Connection=Yes
Lync Shared Location (Lync 2010 only): C:\lync\1-ArchivingServer-1\DataConf

Hostname: This is the hostname of the Netbox.
Netbox Port: 62001 is the default port and must be allowed through any firewalls that exist between the MS Lync database server and the Netbox appliance. Refer back to step 1 to ensure that the port specified here is the same port that was specified when configuring the Netbox appliance. The data is encrypted before it’s sent to the Netbox appliance.
Local Web UI Port: This is the port the web configuration page can be accessed on.
Lync Database DSN: refers to the ODBC connection that will need to be setup.
Lync Shared Location: This field can be ignored for Lync 2013 archival. For Lync 2010, specify the path to the archiving server file store. Depending on the specific installation of Microsoft Lync, this path will vary. You can typically retrieve this using the Lync Server Management Shell:

PS> ‘C:\’ + (Get-CSService -filestore). ShareName + ‘\’ + (Get-CSService -ArchivingServer).ServiceID + ‘\DataConf’
=> C:\lync\1-ArchivingServer-1\DataConf

Verification

The MS Lync Windows services checks for new messages every minute, and sends them to the Netbox for archival. After a few minutes of Lync activity, an email digest can be forcefully triggered via:

  • Browse to Content Scanning -> General
  • Click “Edit” next to “Archive emails”
  • Ensure that an email is specified in Microsoft Lync email address
  • Click “Send now...” next to “Send archive

Troubleshooting

Enable Logging

Enable logging of the MS Lync service if connectivity issues are experienced. Logging is enabled by setting values in the Windows Registry, which can be accessed by regedit.exe from the command prompt.
The registry settings for the service are available at: HKEY_LOCAL_MACHINE\SOFTWARE\ Wow6432Node\NetboxBlue\MS Lync
Logging to a file can be configured by adding the following keys to the above registry path:

Name: logfile
Type: REG_SZ (String)
Data: C:\log_directory\MS Lync.log

Restart the MS Lync service to apply the changes. Please be aware, that unattended logging to the file system will continuously use disk space.

Basic Interpretation of Logging Errors

winripclient.clientlogging: XE ProgrammingError: (ProgrammingError) (‘42000’, ‘[42000] [Microsoft][ODBC SQL Server Driver][SQL Server]Cannot open database “NoExist” requested by the login. The login failed. (4060) (SQLDriverConnect);
Explanation: The MS Lync service is unable to connect to the MS SQL Lync Database. Check the DSN database string, and the ODBC connection.
 
winripclient.main: XD Connection to server lost/failed, will retry in xx s
Explanation: The MS Lync service is unable to connect to the Netbox. Check host and port connectivity between the two machines.
 
MS Lync.db: XI No archiving records found since last archived message
Explanation: This is not an error. No new activity has been observed since the last time the archiving service had sent data to the Netbox.