December 23, 2009

How to display a workflow event field on the main window

Helix ALM
A common question I hear from TestTrack users is how to display a value that was entered as part of a workflow event on the main issue/test case/requirement window.  As some of you may know, this is not "out of the box" functionality. However, this can be configured rather easily using automation rules and custom fields. The only requirement is that the field on the main window has to be of type "String".

Example

I am going to create a custom field in the defect window, and then set up an automation rule that will set the field to the "Fix Resolution" value selected in the Fix event dialog. Instead of explaining how this works, I thought I would do a better job if I just showed you how to do it. Step 1: Create a Custom Field I am not going to go into detailed steps here.  Please review the user guide for detailed steps on how to create custom fields.  All I am going to show here is the "Add Custom Field" window with all of my configurations: [caption id="attachment_1273" align="aligncenter" width="354"]Add Custom Field Window Add Custom Field Window[/caption] Notice that I made the long label specify that this is the field on the main window.  I did this so, when I create a filter or insert a new column in my list window, I will be able to easily tell apart the "Fix Resolution" field that is part of the Fix Event from my custom field. Another option is to use a completely different name for the custom field. Step 2 - Create an Automation Rule Again, not going into step-by-step details here.  This is a simple trigger that should be set to fire before the defect enters the fix state.  The action is illustrated below: [caption id="attachment_1276" align="aligncenter" width="574"]addcustomfieldtrigger Trigger Configuration[/caption] Notice that when you chose "Modify" as the action, a drop-down is populated with all of the field codes available to use. Make sure you select the field code that will display the value that you are looking for. Part 3 - Make the Custom Field Read-Only This is really optional, but it does make sense to make this field read-only so it is only updated by TestTrack.  You can make the field read-only using the field security feature in security groups. We are done!

Seeing it in action

Now to see our nifty rule in action. I select a defect that is ready for a fix event.  The following image shows the fix event being performed. Notice in the background that the defect is open and that the custom field (read-only) is currently blank: [caption id="attachment_1290" align="aligncenter" width="519"]Fix Event Dialog Fix Event Dialog[/caption] The user clicks OK to commit the Fix event and then clicks the Apply button to save changes to the defect.  The next image now shows the custom field being populated by the value chosen in the Fix Event dialog. [caption id="attachment_1292" align="aligncenter" width="494"]Fix Custom Field Fix Custom Field[/caption]

In Conclusion

Hopefully I have demonstrated how easily you can set up a rule that allows you to display a value that was supplied during a workflow event on the main item window.  Keep in mind that the steps demonstrated here will work with any item in TestTrack.