{"id":453,"date":"2011-09-13T05:11:38","date_gmt":"2011-09-13T04:11:38","guid":{"rendered":"http:\/\/www.stuartroberts.net\/?p=453"},"modified":"2011-09-13T05:11:38","modified_gmt":"2011-09-13T04:11:38","slug":"workflow-activity-part-2","status":"publish","type":"post","link":"http:\/\/www.stuartroberts.net\/index.php\/2011\/09\/13\/workflow-activity-part-2\/","title":{"rendered":"Workflow Activity – Part 2"},"content":{"rendered":"

This is the second part of the custom workflow activity creation tutorial. For the first part please go here<\/a>.<\/p>\n

Now that we have a workflow activity defined, the next step is to add a new project to Visual Studio.<\/p>\n

\"\"<\/a>

Create SharePoint Project<\/p><\/div>
\n
\nNext, add a project reference to the activity project.<\/p>\n

\"\"<\/a>

Activity Project Reference<\/p><\/div>\n

Now to create the workflow. Add a new item<\/em> to the project and select a Sequential Workflow<\/em>.<\/p>\n

\"\"<\/a>

New Sequential Workflow<\/p><\/div>\n

Give the workflow a name and set it as a list type.<\/p>\n

\"\"<\/a>

New List Workflow<\/p><\/div>\n

Next, select the option for associating with libraries and lists. You can of course opt to not auto associate and this is something I’d generally do as it allows you to control where and what the workflow is associated to when activating the feature, but that’s a different topic altogether.<\/p>\n

While the new workflow is opened, hover over the toolbox<\/em> pane and you should see the custom activity that was created in the first part of this post.<\/p>\n

\"\"<\/a>

Activity Toolbox<\/p><\/div>\n

Before adding the activity, add the ApplyActivation<\/em> activity to the designer.<\/p>\n

\"\"<\/a>

Apply Activation Activity<\/p><\/div>\n

To configure the apply activation activity, we first need to create and associate a workflow context property. To do this, select the activity in the designer, bring up the properties pane and edit the __Context property.<\/p>\n

\"\"<\/a>

Edit Context Property<\/p><\/div>\n

Switch to the Bind to a new member tab<\/em> and create a new field.<\/p>\n

The difference between a property and a field is that the former creates a dependency property while the latter is a simple .NET property with no such binding.<\/p>\n

Do the same for the _WorkflowProperties property, only this time instead of binding to a new member, select the workflowProperties<\/em> item that already exists.<\/p>\n

\"\"<\/a>

Bind Workflow Properties<\/p><\/div>\n

Next, add the custom activity to the workflow, immediately after the ApplyActivation<\/em> activity.<\/p>\n

\"\"<\/a>

Custom Activity<\/p><\/div>\n

Switch to the code behind for the workflow and add the following property.<\/p>\n

\r\npublic SPItemKey ListItemId\r\n{\r\n    get\r\n    {\r\n        return new SPItemKey(workflowProperties.ItemId);\r\n    }\r\n}\r\n<\/pre>\n
This will be used to convert the item id for the workflow to an SPItemKey object.<\/p>\n
Head back to the designer window and bring up the properties pane for the custom activity.  Here you want to bind __Context to applyActivation1_Context1 (or whatever you called the context field property).  You should also bind the __ListId property to the ListId child property of applyActivation1_Context1.<\/p>\n
\"\"<\/a>
Associate List Id Property<\/p><\/div>\n
Next, you should now associate the __ItemId property with the ListItemId property, which we created via code behind.<\/p>\n
\"\"<\/a>
Property Assignments<\/p><\/div>\n
Lastly, you should enter a valid email address for the EmailTo property.<\/p>\n
\"\"<\/a>
Specify Email Address<\/p><\/div>\n
If this were a workflow for a live system this would definitely not be the way to go, you’d want to dynamically set the value here either from the parent workflow or by retrieving the value from one of the workflow item’s fields.<\/p>\n
We’re now finished with the workflow.  Next, open the feature editor – as this is a new project and we only added one workflow there should only be one feature present.  To have SharePoint automatically register this workflow change the receiver assembly<\/em> to Microsoft.Office.Workflow.Feature, Version=14.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c<\/em> and the receiver class<\/em> to Microsoft.Office.Workflow.Feature.WorkflowFeatureReceiver<\/em>.<\/p>\n
\"\"<\/a>
Feature Receiver<\/p><\/div>\n
Before we deploy the solution, there is one last thing we need to do and that’s ensure the assembly for the workflow activity is deployed along with the SharePoint solution.  To do this open the package editor and click on the Advanced link.<\/p>\n
\"\"<\/a>
Advanced Package<\/p><\/div>\n
Click the Add<\/em> button and then Add assembly from Project Output…<\/em>.<\/p>\n
From the popup, select the workflow activity project and ensure the deployment target is set to the GAC.<\/p>\n
\"\"<\/a>
Add Project Assembly<\/p><\/div>\n
Deploy the solution, activate the feature and bob’s your uncle.  You should now be able to associate the workflow with any list or library and receive an email after creating a new item.  Ensure that your server has an outgoing email server configured and the email address set in the workflow is valid, otherwise you will get errors.<\/p>\n","protected":false},"excerpt":{"rendered":"
This is the second part of the custom workflow activity creation tutorial. For the first part please go here. Now that we have a workflow activity defined, the next step is to add a new project to Visual Studio.<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_mi_skip_tracking":false,"jetpack_post_was_ever_published":false,"jetpack_publicize_message":"","jetpack_is_tweetstorm":false,"jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":[]},"categories":[3,82],"tags":[81,6,30],"jetpack_publicize_connections":[],"aioseo_notices":[],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"jetpack_shortlink":"https:\/\/wp.me\/plx2I-7j","_links":{"self":[{"href":"http:\/\/www.stuartroberts.net\/index.php\/wp-json\/wp\/v2\/posts\/453"}],"collection":[{"href":"http:\/\/www.stuartroberts.net\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/www.stuartroberts.net\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/www.stuartroberts.net\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/www.stuartroberts.net\/index.php\/wp-json\/wp\/v2\/comments?post=453"}],"version-history":[{"count":12,"href":"http:\/\/www.stuartroberts.net\/index.php\/wp-json\/wp\/v2\/posts\/453\/revisions"}],"predecessor-version":[{"id":1171,"href":"http:\/\/www.stuartroberts.net\/index.php\/wp-json\/wp\/v2\/posts\/453\/revisions\/1171"}],"wp:attachment":[{"href":"http:\/\/www.stuartroberts.net\/index.php\/wp-json\/wp\/v2\/media?parent=453"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/www.stuartroberts.net\/index.php\/wp-json\/wp\/v2\/categories?post=453"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/www.stuartroberts.net\/index.php\/wp-json\/wp\/v2\/tags?post=453"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}