Recently I have been building a solution which makes use of Content Type Event Receivers. The event receivers were being deployed using declarative xml for example:-
<ContentType ID=”[Removed]” Name=”My Content Type” Group=”My Content Types” Version=”0″>
<DocumentTemplate TargetName=”/_layouts/CreatePage.aspx” />
<Assembly>MyAssembly, Version=22.214.171.124, Culture=neutral, PublicKeyToken=000000000000</Assembly>
Now this normally works great, except when you make a mistake. Its quite well known that upgrading Content Types that have been defined using declarative xml can be tricky.
This is one of the reasons why Microsoft released Feature Upgrades in SharePoint 2010 (if you haven’t seen this then please check out Chris O’Brien’s set of blog posts (http://www.sharepointnutsandbolts.com/2010/06/feature-upgrade-part-1-fundamentals.html) on the subject).
In this case the development was on a SharePoint 2007 environment and I found myself in a situation with deploying Content Type Event Receivers.
It seems that once the Content Type had been deployed and the feature switched on its quite difficult to make certain changes to the content type. This includes changes like the following:-
- changing a field’s default value
- changing whether a field is required
- changing the event receiver definition
- I looked at alternative utilities including :-
- Gary LaPointe – StsAdm extensions (http://blog.falchionconsulting.com/)
- Gaetan Bouveret – SharePoint Event Manager (http://speventsmanager.codeplex.com/)
- However, unfortunately Gary LaPointe’s stsadm commands would not working correctly for my content type and Gaetan Bouveret’s utility only manages list event receivers but does look very good at that!
Therefore I started to write my own command line utility. The first version was quickly written to get what I needed to do, done.
I have updated it so that at least its a bit more intuitive but it still only allows you to modify event receivers at a content type or list level.
Please be careful because if you ask it to delete an event receiver then guess what it will delete the event receiver!
As with all these utilities please do not try using this on your production environment without performing some testing on a development environment beforehand.
If you have any comments, problems with the utility please leave a comment and I’ll take a look..
Utility System Requirements:-
- SharePoint 2007 SP2 (Tested on April 2010 and April 2011 Cumulative Update)
- Utility must be run from machine which is connected to the SharePoint farm that is being modified.
Console application name: ITSP.EventReceiverConfig.exe
Command Line Arguments:-
- -url : full url of site that hosts content type or list
- -mode : [list | add | remove]
- -targettype : [list | contenttype | assembly]
- -targetname : [name of list | name of content type | name of assembly]
- -assembly : [full assembly name including version number etc]
- -class : [fully qualified class name that is implementing the event receiver]
- -type : [itemadding | itemadded | itemupdating | itemupdated]
- -sequence : [number bigger than 1]
The utility with releases, document and source code can be found on Codeplex.
Codeplex Project: http://itspeventreceiver.codeplex.com
Documentation can be found here: http://itspeventreceiver.codeplex.com/documentation