How to Check Workflow Status programmatically

Today I'll show checking all workflow statuses in SharePoint site programmatically. Sometimes you may want to check workflow statuses are error or not.

You need workflow status name (list column) when you get a item's workflow status. But you can't get workflow status name from SPWorkflow properties directly. You need to use SPWorkflow.AssociationId property and SPList.WorkflowAssociations property to get workflow status.

The sample code is here.

using System;
using Microsoft.SharePoint;
using Microsoft.SharePoint.Workflow;

// This is Console Application //

SPSite site = new SPSite("http://sharepoint-site");
SPWeb web = site.OpenWeb();

foreach (SPList list in web.Lists)
    foreach (SPListItem item in list.Items)
        foreach (SPWorkflow workflow in item.Workflows)
                Console.WriteLine("item url : " + item.Url);
                Console.WriteLine("workflow name : " + list.WorkflowAssociations[workflow.AssociationId].Name);
                Console.WriteLine("workflow status : " + item[list.WorkflowAssociations[workflow.AssociationId].Name]);
            catch (ArgumentException)
                //ArgumentException is throwed if the workflow is not exist in the list column. 
                Console.WriteLine("Workflow name : {0} is already not exist in List title : {1}.", 
                    list.WorkflowAssociations[workflow.AssociationId].Name, list.Title);

The result is like this :
item url : Lists/Announcement01/1_.000
workflow name : Approval01
workflow status : 2
Workflow status is displayed as a number. The workflow status number are related to SPWorkflowStatus Enumeration. For example, number 2 means "InProgress".


How to Disable an Expiration Policy (Retention) on a List Using SharePoint Object Model

We usually use Expiration Policy (Retention) in Information Management Policy features. Expiration Policy enables to set expiration date for each item in a list. The item will be deleted when expiration date will come.

If you enable or disable Expiration Policy using SharePoint API, it is little bit complicated.
Expiration Policy including Information Management Policy features is associated list's ContentType. (not list of itself) 

You can see how to enable and create Expiration Policy in bellow blog post.

Using the SharePoint API to Configure an Expiration Policy on a Document Library

If you delete and disable Expiration Policy, please see bellow program code.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Microsoft.SharePoint;
using Microsoft.Office.RecordsManagement.InformationPolicy;

namespace ConsoleApplication3
    class Program
        private const string expirationPolicyFeatureId = "Microsoft.Office.RecordsManagement.PolicyFeatures.Expiration";

        static void Main(string[] args)
            SPSite site = new SPSite("http://sp2010");
            SPWeb web = site.OpenWeb();

            SPList list = web.Lists["Annnounce03"];

            foreach (SPContentType contentType in list.ContentTypes)
                Policy policy = Policy.GetPolicy(contentType);

                if (policy != null)
                    //delete Expiration Policy on the List

Tips :
- You need to add Reference Microsoft.Office.Policy.dll from /14/ISAPI.
- Expiration Policy is defined as Microsoft.Office.RecordsManagement.PolicyFeatures.Expiration.


How to Customize Default Approval Workflow (Part.2)

In Part. 1 blog post, I introduced how to add Person or Group TextBox as CC form in Change Request Task Form. Only adding CC form, It doesn't work. So, in this blog post, I introduce how to add logic in custom Approval workflow to use CC form.

The Steps are here.

  • In Approval - Copy05 Top, click "Edit Workflow" and click "Approval Workflow Task (en-US) Copy".

  • Click "Change the behavior of a single task".

  • Add "Set Workflow Variable" in "When a Task Completes" section's top.

  • Click "workflow variable" and click "Create a new variable..." from pulldown. Fill in arbitrary name and choose String Type. Press OK.

  • Click value and click fx. Fill bellow parameters.

  • Click "Current Task:Assigned To" in "When a Task is Pending".

  • Click icon besides CC. Select "Workflow Lookup for a User...". And Fill in bellow parameters.

  • Click OK and publish the workflow.

The steps were finished. Please confirm that you can get CC email when you run the workflow.

In the steps, I created a workflow variable in "When a Task Completes" section to get CC form content. And I added the workflow variable as a CC address in "When a Task is Pending" section. The important point is that you can't directly get CC form content in "When a Task is Pending" section. When you fill in CC form and click Send in Change Request form of a workflow task, The workflow task is completed and new workflow task is created. CC form content is associated the completed task. So you need to get CC form content in "When a Task Completes" section.


How to Customize Default Approval Workflow (Part.1)

I'm sorry it has been taken long time since previous blog post.
Today I'd like to introduce how to customize default approval workflow using only SharePoint Designer (with non code).
This is new feature in SharePoint 2010. In SharePoint 2007, we couldn't customize default approval workflow. So you needed to make new own workflow from zero base if you want to customize approval workflow.

I introduce these steps in two blog posts.

OK, I introduce Part1 first, add bellow Person or Group TextBox as CC in ChangeRequest in Task Form.

The Steps are here.

  • First create a copy of default Approval Workflow in SPD. Click Copy and Modify and create new copy of default Approval Workflow.

  • Click Approval Workflow Task.

  • Click New in Task Form Fields to create CC as Person or Group Field.

  • Fill in these TextBox, choose Person or Group in Information type, and click Next.

  • Click Finish.

  • Save and Publish the .Approval Workflow.
  • Back to Approval - Copy05 page. Click Approval Workflow Task in Form.

  • Task Form is opened in InfoPath 2010. Check the CC form which was created previous step. 

  • Select CC Row and copy it(Control + C). Delete CC Row from default form.

Tips : You can also add CC from Fields property menu. But you can't resolve names in CC by using Enter key if you drag & drop CC from Fields property menu to ChangeRequest form. So you had better use the copy from default form.

  • Click Page Design Tab and choose ChangeRequest from View pulldown.

  • Add new Row and paste CC Row (Control + V) in ChangeRequest form.

  • Save the InfoPath form to local and Publish it.

Steps were finished.
I'll introduce how to use the CC in next blog post.