Form Progress Steps

  • 23 September 2015
  • 29 replies

This is a visual control that displays a linear flow. It could give users a simple view of where they are in the process, and what other steps to take.

It can populate from a workflow and display client events into a linear progress bar (think of it as a super simplified View Flow), or it could populate from a SmartObject.

An item is highlighted in blue to mark is as 'active'. If populating from a workflow, this is detected form the SerialNo parameter to detect the current event; otherwise if populating from a SmartObject, this is defined by the State name.

29 replies

Badge +3



Can I use my own smart object? It seems not working even with the same schema.

I want to use stored proc SMO.

& make use of Description field (dynamic).

Badge +2




Excellent custom control!


Only issue I'm having is with event exclusion.


By default the control displays all potential events of the associated workflow.

I have a requirement to exclude events from showing based a predetermined number.

For testing I'm using a hard-coded data label.


I have been unsuccessful in excluding events based on the data label.



  • If Data Label contains 2
  • Exclude Step 3






(Step 3 not excluded)



Any instight on how to exclude events would be greatly appreciated.




Badge +1

That depends on the error message I guess. Did you execute the bat file via the cmd line or did you just double click it? You don't get a chance to read the error message when double clicking.


I get nothing after i run the bat file. What did i do wrong?

Badge +1

I published the the K2 Five code fix here since some people started asking for it:

Hi, Great Control, love it. A feature i would like to see is the ability to use any SmartObject and method as the current version is only limited to SmartBox SmartObject and it would be great if we could choose to use SQL server SmartObject with store procedures etc.. or a SharePoint List. Thanks Simon
Badge +1

Hi Garvit,


This control works on K2 Five, with the exception that the account that accesses the form needs full admin rights on K2 since the WorfklowManagementServer class that is used to get the progress steps is a bit more restricted now with the authorization framework.


Of course, that is not what you want; you don't want to assign every user admin rights on K2 just to show some progress steps.


So I implemented a fix that reverts the current user identity to the application pool account for the WorkflowManagementServer code part. Now you only need users to have view rights on the process (directly or via the group Everyone) and the K2 application pool needs admin rights on the process (or on the K2 server level if you use the control for every process).


Can't upload the updated the code as an attachment unfortunately, so if you need it, send me a PM.


@Riva, maybe we can get in contact to share the code fix so you can upload the updated package here.




Hi Riva,


I am currently working in K2 five, Does this control support K2 five? I am trying to populate this control from a workflow name and I have a admin access to that workflow. Even after that it throw me an exception " You don't have view permission for the mentioned Workflow". 


Let me know if I am doing something worng. If not then how can I resolve this issue.





Hi Riva,


I like to deploy this custom control in K2 Five.but it is not supported in K2 Five.

In K2 Five New clean installation does not provide k2 Designer for visual studio.


Let me know How to create custom control In k2 five new installation.



Hi Alpseb,

Done! Please see v0.8 uploaded. :)



Hi riva,


we are using a different K2 Server port than 5555. I guess this is the problem why the control doesn't work in our environment. Is there any possibility to make the port the control should use configurable?


Many thanks!

Hi Wortho,

I have reuploaded v0.7 and it seems to work now.


[Strangely the download all didn't work, but the individual downloads work. I have raised a ticket to our IT to check out the cause of this issue.]

Many thanks!

Hi Riva, when clicking the Download All Links above the zip is empty. Can you please re-upload? Thanks.

Hi Nik86 and Viesturs,

Thank you for your awesome feedback.

I have uploaded a new version that supports sorting based on WF Event Metadata. 


Hi Viesturs,

That is an awesome suggestion!

Will add that in when i find the time in the next few weeks. :)


Hi riva,
Regarding problem with event sorting, my suggestion is to add option to sort events by their Display name (not very useful) or Metadata.
Metadata fields are good solution for this problem because one could simply put sequence numbers in them.



We can also specify Metadata in Activity General Properties so for more flexibility maybe  allow to sort by both.

Hi Nik86,

Unfortunately, that is one of the limitations of the control, as documented in the PDF.

The Events are sorted based on the sequence of adding activities within the workflow. (i.e. First activity created within the workflow --- its event will be first in the control; 2 nd activity created will display its event as 2nd; etc.). Unfortunately, this cannot be easily changed for now. If you happen to have suggestions for the APIs (specifically for finding out the line sequences), do let me know. Meanwhile I'll ask around if there's a way to fix this.

Badge +6

Hi Riva,

I faced one issue while implemetning progress control.


I have added few Activities and used form progess control,Its working fine.

Now there is change requrest hence i have added couple of new acitvities in middle of the workflow. but progress control not updated steps ,My new activites came to last .


E.g  Submission  --> Assignment-->Approval --> END


Now i have added two more acitvities UpdateApproval,Investigation after Asssignment but now form progess rule dispaly those acitvities after END steps


Submission  --> Assignment-->Approval --> END-->UpdateApproval-->Investigation


How i can update the acitvity sequence if we add any new activites in middle .


Thanks in advance.

Hi All, i have uploaded a new version that includes bug fixes mentioned in this thread + your valuable feedbacks.

Please see the updated documentation for more details.

thanks what worked great, no issues.

I had the same probblem with control not reflecting the right client event. Turns out it was a caching issue.
Adding following to the control class solved the issue


protected override void OnInit(EventArgs e)






even after an iisrest it appears to get stuck in some previous state. Ill test on different machines next


Hi aaronmmc, That's strange. I've never encountered that before. Does it continue to work after doing a 1-time iisreset? What's your control's properties? Are you populating from the SN, or did you specify the workflow name / ID?

Actually it works if I issue an iisreset (it will reflect correct activity in the bar)



I notice that it often doesnt reflect the right client event, I open the viewflow and observe that its on the right activity but the progress img does not reflect that?