Skip to main content

Mighty SharePoint Workflows - part 1 - workflow association, workflow instance

The task

Display SharePoint lists or libraries with active workflow associations.
Display item that have running or completed workflow instances and workflow status for this item.

In our scenario we have a document library with associated Disposition Approval workflow started on the document:


1. Get Workflow Association data for the certain list or library.

SPList list = ...; // Initialize your list instance here

if (list.WorkflowAssociations.Count != 0)
foreach (SPWorkflowAssociation workflowAssociation in list.WorkflowAssociations)
Guid gId = workflowAssociation.Id;
string sName = workflowAssociation.Name;
... // output the values you have got
// in our scenario we add them to Hashtable object
hashtable.Add(gId, sName);

2. Get workflow instance data for the certain list item or document.

We can access workflow instance data from the Workflows property of SPListItem object:

foreach (SPListItem item in list.Items)
foreach (SPWorkflow workflow in item.Workflows)
string sWFName = hashtable[workflow.AssociationId]; // SPWorkflow object only stores AssociationId, that's why we needed a dictionary for Id, Name pairs
string sStatus = InterpretWFStatus(item[item.Fields[sWFName].InternalName].ToString()); // InterpretWFStatus will be explained later
... // output workflow instance data

On workflow status in SharePoint. When you associate workflow with SharePoint list or library the column with the same title as workflow name is created for this list to capture workflow status. The problem with this column is that it is an integer value and SharePoint controls display appropriate string value to user.

After some research I have created a method to display string value of the workflow status using integer value:

string InterpretWFStatus(string nStatus)
if (nStatus == "1")
return "Failed On Start";
if (nStatus == "2")
return "In Progress";
if (nStatus == "3")
return "Error Occurred";
if (nStatus == "4")
return "Stopped By User";
if (nStatus == "5")
return "Completed";
if (nStatus == "6")
return "Failed On Start Retrying";
if (nStatus == "7")
return "Error Occurred Retrying";
if (nStatus == "8")
return "View Query Overflow";
if (nStatus == "0")
return "Not Started";
if (nStatus == "16")
return "Approved";
return "Custom";

The issue here is that if we have some other value which we don't know it will return "Custom" as workflow status. I haven't done any research yet as how to get true value of the custom status. I'm going to do this in the future.

Below is the image of how it works on the Web site:

In the next article I will explain how to create links to workflow statistics and how to get workflow tasks programmatically.

Stay tuned :)


Popular posts from this blog

Setting up External Content Type for SQL Server database using SQL Server authentication - SharePoint 2010 Foundation

This post is a follow up on the issues that I have got setting up External Content Type (ECT) on SharePoint 2010 Foundation that was going to connect to remote SQL Server database for information. I cannot use my SharePoint user accounts to access SQL Server.

According to the information I have discovered ECT and Business Connectivity Services are available in the SharePoint 2010 Foundation, but there are some issues if you want to use authentication methods in your external connections that are different from Windows Identity or Current User Identity. This is because there is no Secure Store Service in SharePoint 2010 Foundation which serves as an impersonation hub and is only available in SharePoint 2010 Server edition.
The issues are coming from the fact that you can actually create ECT in SharePoint Designer 2010 providing just Secure Store ID and system would ask you for credentials and here you go, but when you try to use your ECT in External Lists or as a lookup columns you wou…

SharePoint 2010 Search Issue - FQDN Crawl

I have recently set up a standalone SharePoint 2010 environment.

The Web application was created with host header and the site collection is accessible from the client machines, but not internally. That was because of using FQDN to access the Web site.

The error when I tried to access site internally was similar to the one described here:

You receive error 401.1 when you browse a Web site that uses Integrated Authentication and is hosted on IIS 5.1 or a later version

And the search returned the following error in the Event Log:

"The start address cannot be crawled.

Context: Application 'Search_Service_Application', Catalog 'Portal_Content'

Details: This item could not be crawled because the crawler could not connect to the repository."

One of the suggestions was to disable the loopback check, but that would compromise the Web server.

So what I have done was:

1. Added a binding to my IIS Web site for a different port. Let's say my Web server name is win-v7m…

SharePoint 2013 - Setting Up External Content Type

There were earlier posts where we discussed External Content Types setup for SharePoint 2010:

Setting up External Content Type for SQL Server database using SQL Server authentication - SharePoint 2010 Foundation

External Content Types - Reload - Setting up for SQL Server database using SQL Server authentication - SharePoint 2010 Server

This one is about creating connection to the custom SQL Server database (External System) in SharePoint 2013.

1. Create Secure Store Service Target Application

1.1. Go to Central Administration -> Manage Service Applications -> Secure Store Service Application. Click "Generate New Key" if required:

1.2. Provide Pass Phrase:

1.3. Create "New" to create new Target Application:

1.4. Provide the name and other parameters and click "Next":

Note: It's good idea to specify "Group" for Target Application Type. In that case you would be able to manage access to the external data using Active Directory groups rather …