Wait? Why would you want to do this? I’ll tell you why, because writing the whole workflow in Visual Studio is lame. You’re better off writing an activity and letting some SharePoint admin put together and manage the workflows in SharePoint Designer.
Seriously, I can’t stress this enough. Write as little code as necessary in SharePoint, and let the built in tools and features do the rest of the work.
Creating the Solution
Ok, this is a little weird, but there isn’t a built in template for writing Activities. It almost seems like they didn’t expect people to be using them. Really, there is nothing built in for this. So, you have to do it all by hand.
Create a new project, select “Empty SharePoint Project” as the template.
- Give the project a cool name and click “OK.”
Select “Deploy as farm solution” in the wizard window.
- Click “Finish.”
- Add a reference to “Microsoft.SharePoint.WorkflowActions” from the .NET tab in the Add Reference dialog.
- Add a reference to “System.Workflow.Activities,” “System.Workflow.ComponentModel” and “System.Workflow.Runtime” under “Browse” in the folder “Program Files (x86)Reference AssembliesMicrosoftFrameworkv3.0“
Your references should look like this now:
Creating the Activity code
You now have a SharePoint solution with the proper references set so that you can write an Activity. It is time to add the class and the first bit of code.
- Add a new empty Class file to the project.
Add the following using statements and inherit from Activity.
In order to allow properties to be passed in from SharePoint designer, you have to set up Dependency Properties.
Add a Property and Dependency Property for values that will come in from the Workflow.
When your activity starts, the Execute method is fired. This is where you will do the work in the Activity.
Add an override for Execute to the class.
Adding the Activity to SharePoint
In order for SharePoint designer to know about the Activity, we have to add a special XML file to the Workflow folder in the SharePoint hive.
Right-click on the Project and select Add -> SharePoint Mapped Folder…”
From the folder list, select “TEMPLATE1033Workflow“
- In the Solution Explorer, right-click on the new Workflow folder and add an XML file (Add -> New Item -> DataXML File).
Name the file [project name].actions (obviously, substituting the actual name of your project, although it could be anything, as long as it is somewhat unique).
Add the following XML to the File… Substituting the actual information for your project.
- By the way, the FieldBind and Parameter sections tie to the Dependency Property you put in the class. In the rule designer, that “%1” is the place holder for the value of the first FieldBind node. You can have more than one of those.
- Here is the schema for this XML file, http://msdn.microsoft.com/en-us/library/bb897833.aspx
You’ve probably noticed you need the fully qualified name for your assembly. If you’ve never had to get the Public Key Token before, it can be a little confusing. Do yourself a favor and add this to your tools:
- Go to “Tools” and select “External Tools“
Then click “Add…“
Title: “Get &PublicKeyToken”
Command: “C:Program Files(x86)Microsoft SDKsWindowsv7.0ABinsn.exe”
Arguments: “-Tp $(TargetPath)”
- Check “Use Output Window” then click “OK“
- Now you can run this and it will write the key info into your output window
Turning this into a Feature and fixing up the Web.Config
Since you started with a blank SharePoint project, you’re going to need to add a Feature to it so this can be turned on and off – but, more importantly, because you need to add some things to the web.config for this to work. Luckily, having a Feature means you can add an Event Receiver that fires when the feature is activated/deactivated – which means handling the web.config properly isn’t that bad.
- In the Solution Explorer, right-click on Features and select “Add Feature“
- Rename the Feature to something more sensible than Feature1.
- Open the Feature Designer (double clicking the feature will do this) and switch the Feature Scope to “WebApplication“
- Right-click on the Feature in the Solution Explorer and select “Add Event Receiver“
- Open the new class and uncomment the FeatureActivated and FeatureDeactivated methods
- Add using statements for Microsoft.SharePoint.Administration, System.Collections.Generic and System.Linq
Add the following code to the FeatureActivated method (you can copy and paste this time):
- Don’t forget to change the assembly information to match your assembly. The things to change are in CAPS.
- P.S. The value for Owner should really be put in a “const string” at the top of the class. It has to be exactly the same when we go to remove the entry.
SPWebService service = SPWebService.ContentService;
SPWebConfigModification mod = new SPWebConfigModification();
mod.Path = “configuration/System.Workflow.ComponentModel.WorkflowCompiler/authorizedTypes”;
mod.Name = “authorizedType[@Assembly=’YOURASSEMBLYNAME, Version=220.127.116.11, Culture=neutral, PublicKeyToken=YOURKEY’][@Namespace=’YOURNAMESPACE’][@TypeName=’*’][@Authorized=’True’]”;
mod.Sequence = 0;
mod.Owner = “THE NAME OF YOUR PROJECT”;
mod.Type = SPWebConfigModification.SPWebConfigModificationType.EnsureChildNode;
mod.Value = “<authorizedType Assembly=’ YOURASSEMBLYNAME, Version=18.104.22.168, Culture=neutral, PublicKeyToken=YOURKEY’ Namespace=’YOURNAMESPACE’ TypeName=’*’ Authorized=’True’ />”;
Add the following code to the FeatureDeactivated method:
- Same notes as above + Notice the “ToList()” when looking up the config mods. This is because removing items from the collection while looping through it causes problems.
SPWebApplication webApplication = properties.Feature.Parent as SPWebApplication;
var mods = webApplication.WebConfigModifications;
var items = mods.Where(m => m.Owner == “SAME NAME FROM BEFORE”).ToList();
foreach (var item in items)
That about wraps it up. You should be able to deploy this sucker to SharePoint now – and then see it in SharePoint Designer.