Using ULS Viewer to Troubleshoot ExCM

Article Contents:

 

ULS Viewer Background Information

ExCM 2016 and 2013 R2 write entries to the SharePoint Unified Logging Service (ULS) for various tasks that they performs.  These entries can be reviewed by a SharePoint Farm Administrator to help with troubleshooting problems. 

 

The ULS log files are ASCII text files that are located at "C:Program FilesCommon FilesMicrosoft SharedWeb Server Extensions15LOGS" on each server in your SharePoint farm.  In a SharePoint 2016 farm, the location is the same except it is in the "16" folder, rather than the "15" folder.

 

You can view the contents of these log files using Notepad or any other text editor, but it can be very tedious to do so due to the number of log files and entries that SharePoint generates.  A better way to examine the log files is to use Microsoft's free ULS Viewer tool.  You can download the latest version here:  https://www.microsoft.com/en-us/download/details.aspx?id=44020.  

 

The tool is a self-contained .exe - there is not an installer.  You can put the .exe file on the desktop of your SharePoint server, or in a folder if you prefer.  It will also accept UNC paths if you want to run it from a workstation while accessing the log files from the SharePoint server(s).

 

Note: ULS Viewer provides a feature to pull log files from multiple servers in a multi-server farm and combine them into one view.  So, if you have a multi-server farm, you really only need to run ULS Viewer from a single server or workstation.

 

TIP: The ULS Viewer tool is feature packed and it is beyond the scope of this article to provide full training on how to use it, but here is a good video series that goes over many of its features:

Introduction to ULS Viewer - Part 1
Introduction to ULS Viewer - Part 2
Introduction to ULS Viewer - Part 3
 

 

Example Scenario #1:  Troubleshooting a Correlation ID

Watch this video to see an example of using ULS Viewer to troubleshoot a situation where an ExCM-related feature has generated a Correlation ID:

 

 

 

Example Scenario #2:  Using ULS Viewer to troubleshoot a problem with the Extranet Global Configuration Timer Job

ExCM 2013 R2 and 2016 include a Timer Job that is responsible for automatically configuring your extranet web application(s) web.config files, based on actions that you take in the ExCM configuration pages in Central Administration.

 

For example, when you run the Extranet Setup Wizard or save the Password Policy Settings page in Central Administration, your desired actions are saved to a queue and the next time the Extranet Global Configuration Timer Job runs, the settings will be applied to the web.config file(s) for the appropriate web application on each of your servers.

 

If there are problems with the Extranet Global Configuration Timer Job, it will write diagnostic entries to the SharePoint ULS.  All of its ULS entries have the "Product" column in the logs set to "Extranet Configuration".  So, you can filter your log entries on "Product" contains "extranet" and see the specific entries that were made by this timer job:

 

SharePoint ULS

 

 

©2019 PremierPoint Solutions. All Rights Reserved. 

Create your own Knowledge Base