November 2, 2011

Three Quick Ways to Tweak the Default Requirements Workflow

Helix ALM
TestTrack's sample project includes a sample workflow for managing requirements and requirement documents. In most cases, customers base their workflow on the sample, but want to tweak it to meet their needs. This article  explains how to make three quick tweaks to the sample workflow: configuring when requirements and requirement documents are locked, enabling test cases to be generated from requirements, and configuring the workflow states and events. Quick Tweak # 1 The following screenshot shows an open requirement document with a number of requirements. Requirement 2.1.1.1  has a  lock icon with the following text Record is locked through workflow displayed under it. This indicates the requirement is in a workflow state that locks it, which prevents other users from editing the requirement. [caption id="attachment_10209" align="alignnone" width="550" caption="Requirement Document with Locked Requirement"]Requirement Document with locked requirement[/caption] To change when requirements are locked, log in to TestTrack. Choose Tools > Administration > Workflow. Select "Requirements" from the Type drop-down list. Click the "States" tab if it is not selected. To configure the workflow so a requirement is unlocked in a specific state, select that state and click "Edit".  Select "Unlocked" from the Locked drop-down list and save your changes. Users will now be able to edit requirements in that workflow state. [caption id="attachment_10221" align="alignnone" width="390" caption="Requirement Workflow State locked option"]Requirement Workflow State locked option[/caption] Quick Tweak # 2 If you use TestTrack TCM, you can also generate test cases from approved requirements. To enable this, select the "Can generate test case" option when you're editing a workflow state. Quick Tweak # 3 The sample workflow has a number of default states and events that can also be changed to configure the workflow to fit your needs. The following screenshot shows the sample project's requirement workflow. [caption id="attachment_10235" align="alignnone" width="619" caption="Requirement Workflow Diagram"]Requirement Workflow Diagram[/caption] You can modify the workflow by removing or adding additional states and events. An event moves a requirement from one state to another. When you create a new state in the workflow, you will most likely need an event to move the requirement in and out of the new state. Keep in mind that an event can also be executed and have no effect on the state of an item. As an example, the Assign event is only used to assign an item to one or more users without changing the state of an item. In the following example, I want to change the workflow so a requirement can go directly to the Approved state from the Awaiting Review state. I'm going to use the Approve event to move the requirement. To implement this change, log in to TestTrack. Choose Tools > Administration > Workflow. Select "Requirements" from the Type drop-down list. Click the "Transitions" tab, then click "Edit" in the State Transitions area. [caption id="attachment_10239" align="alignnone" width="631" caption="Requirements State Transitions"]Requirements State Transitions[/caption] Select the "Awaiting Review" check box for the "Approve" event, as highlighted in the following screenshot. [caption id="attachment_10240" align="alignnone" width="597" caption="Requirement State Transitions Changed"]Requirement State Transitions Changed[/caption] After you save your changes, you'll notice you can now move requirements directly from the "Awaiting Review" state to the "Approved" state. [caption id="attachment_10242" align="alignnone" width="619" caption="Updated Requirements Workflow Diagram"]Requirements Workflow Diagram Changed[/caption] Check out the TestTrack RM Resource Center to learn more about configuring TestTrack RM.