Sample Lync Persistent Chat Archive Report

After receiving multiple requests for a way to report on Lync Persistent Chat Archive Data (from the mgccomp Compliance database) I decided to create this sample report. One problem with querying for this data directly from the mgccomp database is that the Persistent Chat rooms aren't listed by name and the Messages are in RTF format. This sample report will take care of all the data conversion and put that data into a presentable report. Currently this sample report will only work against Lync 2013 Persistent Chat Archiving data in the mgcomp database.

 

 

Current Features

· Gather Persistent Chat Archive data from the mgccomp compliance database and create a presentable report

· Ability to filter data based on Start and End dates, UserURI, or Persistent Chat Room

· Export this report into CSV, PDF, and Word formats

 

Future Features

· Currently when a file has been uploaded to the Persistent Chat room the report will show a blank space in the Messages field. This will hopefully be resolved in the next version. The plan is to include a link to where the file is stored on the Persistent Chat file store.

· SQL Mirroring support. Currently you would need to change that data source if the primary SQL server for the Persistent Chat databases fails over to mirror. Follow Step 5 from the Report Installation section to change this value.

· PDF Export doesn’t display the data correctly.

 

Pre-Requisites

· SQL Reporting Services Server (SRSS) – if you have deployed Lync Monitoring Reports then you should be able to use that same SRSS instance

· Permissions – in order to run this report you must have permissions to query both the mgccomp (Persistent Chat Compliance) and mgc (Persistent Chat Data) databases.

 

Report Installation

1.       Download and Unzip the Reports from https://gallery.technet.microsoft.com/Sample-Persistent-Chat-8ff37d5e. Copy the Persistent Chat Archive Report.rdl file to the SRSS server.

2.       Open Report Manager on the SRSS server via https://<SRSS Server Name>/Reports

3.       Click on "New Folder", give it a name e.g. "Persistent Chat Archive", and click OK

4.       Click on the newly created folder and select "Upload File". Click Browse and navigate to the location you copied the zip file from Step 1. Click on the "Persistent Chat Archive Report.rdl" file and select Open. Click OK which will upload the report.

5.       Configure the report to utilize your SQL servers.

a.       Click on the drop-down button for the "Persistent Chat Archive Report" and select "Edit in Report Builder".

b.      Expand the Data Sources folder, right click "mgccomp", and select Data Source Properties.

c.       On the General tab look under the section name Connection string. Change this value to Data Source=<SQL Server FQDN\Instance>;Initial Catalog=mgccomp.

                                                               i.      E.g. Data Source=FABSQL1.fabrikam.com;Initial Catalog=mgccomp

d.      Click OK

e.      Click Save on the toolbar or press Ctrl + S

6.       Close Report Builder

 

Report Usage

1.       Open Report Server on the SRSS server https://<SRSS Server Name>/ReportServer

2.       Click on the directory created in step 3 during Report Installation (e.g. "Persistent Chat Archive")

3.       Click on the "Persistent Chat Archive Report" link which will take you into the report

4.       Default Values

a.       StartDate (required)– this will pull the current date of the SRSS server and subtract 1 day

b.      EndDate (required)– this will pull the current date of the SRSS server and add 1 day

c.       UserURI – (NULL)

d.      Persistent Chat Room – (NULL)

5.       Filtering Data – you can filter data based on any of the 4 parameters above. The filters are cumulative so if you select to filter on UserURI and Persistent Chat Room the results will only show IMs by the specified user in the specified chat room.

a.       UserURI – users SIP address.

b.      Persistent Chat Room – exact match on the room name including spaces.

6.       Results – by default the report is configured to display the results of Date Created as UTC time. You can change this to the local time zone of the report server if needed.

a.       Open the report in Report Builder, right click on the field under "Date Created (UTC)", and select "Expression"

b.      Under "Set expression for: Value" paste this =TimeZone.CurrentTimeZone.ToLocalTime(Fields!entryDate.Value)

c.       Click OK and then Save or press Ctrl + S

d.      Rerun the report

                                                               i.      Prior to change

                                                             ii.      Post Change

 

7.       Exporting Data to Word, XML, Excel, or CSV

a.       After generating the report click on the save icon on the taskbar and choose your format.

 

If there are any questions or comments feel free to leave them in the comments section below.

 

Code Versions – download most current versions here:

https://gallery.technet.microsoft.com/Sample-Persistent-Chat-8ff37d5e

V1.0 – Initial Release.