Skip to main content

Debugging for SharePoint - Part 2


Problem

 At some point SharePoint developers will need to trace, log and debug their code when they get tripped up with bugs or any weird things when building custom solutions, applications, or components for SharePoint.

Solution

SharePoint hides the real detailed error messages and debug /tracing information which relate to the error. In order to display it we can debug SharePoint Applications & Solutions using the detailed steps below: 
  • Enable debug information and tracing over bugs and exceptions on WSS (Windows SharePoint Services) 3.0 & MOSS (Microsoft Office SharePoint Server) 2007 - Part 1.
  • Enable debug information and tracing over bugs and exceptions on SharePoint 2010 - Part 2.

Enable debug information and tracing over bugs and exceptions on SharePoint 2010 :

In WSS 3.0 / MOSS 2007, to allow debugging, we have to modify only the Web.Config which relates to your web application. But in SharePoint 2010, we have to modify two different Web.Config files by following the steps below:

I. Virtual Directory Web.Config File

 If we opened the target SharePoint solution using Visual Studio.net 2010 then select Debug or click F5, Visual Studio will prompt with a dialog box that alerts that the Web.Config file is not configured to enable debugging. The dialog box gives us the option of either running the project without debugging or modifying the Web.Config file to enable debugging.If we select the first option, the project runs normally. But if we select the second option the Web.Config file is configured to :            
  •  Turn on the Call Stack (CallStack="true")             
  •  Disable the custom errors in Visual Studio ()             
  •  Enable compilation debug ()
Note that:

We can configure the debugging manually as we did at Part 1 via:
  • Locate and open the "Web.Config" file . (Usually located at : "C:\Inetpub\wwwroot\wss\VirtualDirectoties\") .
  •  Search and find the line of code (below) and change the "debug" attribute to "true" and then save the changes :
    <compilation batch="false" debug="false">   into <compilation batch="false" debug="true">
  •  Search and find the following line of code and change the "CallStack" attribute to "true" and then save the changes :
    <SafeMode MaxControls="200" CallStack="false" ...>   into <SafeMode MaxControls="200" CallStack="true" ...>
  • Search and find the following line of code and change the "mode" attribute to "Off" and then save the changes:
    <customErrors mode="On" /> into <customErrors mode="Off" />
     

II. "LAYOUTS Web.Config File":

  •  Locate and open the LAYOUTS "Web.Config" file . (Usually located at : "C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\Template\Layouts") .
  •  Search and find the following line of code and change the "mode" attribute to "Off" and then save the changes:
    <customErrors mode="On" /> into <customErrors mode="Off" />
Note that:

According to the complex interactions between Visual Studio processes (of 'devenv.exe' and 'vssphost4.exe'), and the SharePoint and WCF layers, diagnosing errors that occur while building, deploying, etc...can be a challenge. In order to solve such errors, we can enable the enhanced debugging information by following the steps below:

  •  Go to the registry (Run > Regedit) in the windows registry.
  •  Go to [HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\10.0\SharePointTools] .
  •  Right Click on SharePointTools and select Create new dword value. Name it "EnableDiagnostics" for the key and set the value from "0" to "1" (Setting this key value to "1" causes stack trace information to appear in the Output window "View (Menu) > Output" whenever project system errors occur while we are running in Visual Studio. To disable enhanced debugging information set the "EnableDiagnostics"  key value to "0".
Labels:

Popular posts from this blog

Migrating from Skype for Business to Microsoft Teams: A Step-by-Step Guide

Do you still use Skype for Business to meet the communication and collaboration needs of your business? If so, now is the perfect time to think about switching to Microsoft Teams, a cutting-edge platform with cutting-edge capabilities and seamless connectivity with other Microsoft services. But if you're unfamiliar with the procedure, switching to a new platform can seem like a difficult task. I'll walk you through the process of switching from Skype for Business to Microsoft Teams in this article. Plan the migration in Step 1 You must make a plan before you start the relocation procedure. Set a deadline, make a list of all the Skype for Business capabilities you presently use, and choose whether to migrate gradually or all at once. Step 2: Set up your surroundings. Make sure your network and infrastructure fulfil Microsoft Teams' standards. Upgrades to your hardware, software, and licences might be necessary. Additionally, confirm that you have the right permissions to ca
Post a Comment
Read more

How to: Debug SharePoint Applications

You can greatly simplify debugging by using Visual Studio extensions for Windows SharePoint Services. This topic includes procedures that explain the following: Debugging with Visual Studio extensions for Windows SharePoint Services Performing manual debugging Performing remote debugging Debugging with Visual Studio extensions for Windows SharePoint Services Press the F5 key to begin debugging with Visual Studio extensions for Windows SharePoint Services. The following procedure demonstrates how to enable F5 debugging. To enable F5 debugging Locate and open the target SharePoint application's Web.config file. By default, it is located in C:\Inetpub\wwwroot\wss\VirtualDirectories\80. Find the following line of code and change the  debug  attribute to  true . Save the changes to the Web.config file. In Visual Studio, right-click the SharePoint project, and then click  Properties . Click the  Debug  tab, and then type the target SharePoint URL in t
Read more

SharePoint 2010 – How to use Audio and Video Webpart

Video and Audio Web Part [ a.k.a Media Web Part ] is one of the new cool web parts in SharePoint 2010, so in this article I am going to show you the way to add this web part in your page. To add Media web part to the page you must activate those two features 1- SharePoint Server Publishing Infrastructure Feature in Site Collection features 2- SharePoint Server Publishing Feature in Site features After that edit page then click on Insert tab in SharePoint Ribbon then select Video and Audio Now the Media Web Part in the page Click on the Media Web Part and you will find Options Tab in the Ribbon As you can see in the Options tab there are Chang Media button allow you to select the video and Chang Image button to change the image of web part and Styles (Dark, Light) Click on Change Media to select the Media file. From Computer opens up the Upload media so you can upload the video and display it. Once you click ok and saving the page. Click on play button and enj
Post a Comment
Read more