Defining preconditions for reviews and approvals

Formal review preconditions allow you to restrict artifact state changes based on the artifact's approval status.

About this task

For example, you can create a precondition that prevents a test plan in the Under Review state from transitioning to the Approved state when someone tries to save the test plan. In this way, you can require that at least two team members of a specific role approve a test plan before it can transition to the Approved state.

The formal review preconditions are implemented on the save operations of supported artifacts. Supported artifacts include any test artifact type that supports formal reviews, such as test plans, test cases, test suites, test scripts, test case results, and test suite results.

The formal review precondition replaces the following predefined, non-configurable preconditions:

  • Disallow transition to approved until all approvers approve
  • Disallow transition to approved until all reviewers/approvers approve
  • Disallow transition to approved until required approvers approve
  • Disallow transition to approved until all reviewers approve
  • Disallow transition to approved until required reviewers approve
  • Disallow transition to under review until approvers defined
  • Disallow transition to under review until reviewers defined

Procedure

To define preconditions for a review:

  1. Log in as a user who has permission to save project areas. The appropriate permissions are as follows:
    • A user who has permission to save the project area in the process configuration.
    • A user who is an administrator of the project area.
    • A user who has either the JazzProjectAdmins or JazzAdmins repository group permissions.
  2. In the upper-right portion of the banner, click the Administration (Administration) icon, and then click Manage This Project Area.
  3. In the Project Area editor, click Preconditions and Follow-up Actions.

    The Preconditions and Follow-up Actions editor opens and shows the operations that are available for each test artifact type.

    Preconditions and Follow-up Actions

    If you want to assign a different role or time frame than the default selections, you must copy or create a configuration. For details, see "Copying precondition configurations" and "Creating precondition configurations."

  4. To edit a configuration, hover over the Actions column for a supported artifact operation, such as Save Test Plan, and click the Edit Configuration (Edit) icon.

    The Save Test Plan window opens and shows the available preconditions and follow-up actions.

  5. If you are working in a new project area, click the Add Precondition (Add) icon, select the Required Approvals precondition, and click OK.
  6. If you are working in a project area that was migrated from version 4, the Required Approvals precondition might already be listed for Save Test Plan and Save Test Case.

    Preconditions for Save Test Plan

    Select the Required Approvals precondition.
  7. In the Transition Rules section, click Add to add a transition rule.

    Add transition rule

    The New Transition Rule window opens.

    New Transition Rules

    Transition rules define the criteria that an artifact must meet to transition to a workflow state or state group. State groups are used for business logic and are needed for consistent reporting.

    In order for an artifact to transition to a state or state group, the artifact must meet all of the transition rules that were created for that state or state group.

  8. Select a state or state group for the transition rule.

    If an artifact does not met the criteria for the state or state group that you select, the artifact cannot transition to that state or state group. Typical states and state groups include Draft, Under Review, Pending Approvals, Reviewed, and Closed.

    The Pending approvals precondition prevents an artifact from transitioning to a different state when any review or approval is pending for the artifact. This precondition enables team members to be added as a reviewer or approver for artifacts that they are concerned with, and the artifact cannot change states until they complete their review, or are removed from the review. The following artifacts support this new constraint:
    • Test plan
    • Test case
    • Test suite
    • Test script
    • Test case result
    • Test suite result
  9. Select an approval type.

    Two categories of approvals exist: review and approval. When this rule is evaluated, it considers only the type of approval that you select.

  10. Optional: Specify the required role of the approver and how many approvers must have this role.

    The default value is the default role with one approver. Approvers who do not have the required role are ignored when the transition rule is evaluated. Approvals by users of different roles are considered for information only and do not affect the outcome of the evaluation of the transition rule.

  11. Optional: To configure advanced transition rule options, click Advanced Options.

    These settings are global options that apply to all of the transition rules for the precondition:

    • Use only the latest approval group: When this option is selected, only the approvals that exist within the last created approval group are considered when the transition rule is evaluated. All older approval groups are ignored.
    • Fail if pending approvals exist from required approval roles: When this option is selected, all of the approvers must respond or the transition fails.
    • Allow vetoes from users with required approval roles: When this option is selected, one rejected approval can veto the overall result.
  12. When you are finished defining the precondition, in the upper-right corner of the project area page, click Save.

What to do next

You can define a precondition for the Save Formal Review operation to require an Electronic Signature from reviewers and approvers.

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki