| Table of Contents | ||
|---|---|---|
|
About eSignature and Approval Workflow
...
Once you enable the eSignature feature, you can click on the Approval Access option on the tree, wherein you can assign Test Case Approvers, Test Run Approvers and Test Suite ApproversRun Closers.
Approval Levels and Mechanism
- If you have the eSignature feature enabled even before QMetry Test Management v8.8, then your existing test case and test suite approvers will be carried forward at Level 1 in respective sections.
- Maximum 5 levels can be added for Approval Workflow, the settings are done from Customization > General Settings & Audit > General Settings.
- Customization “Modify” rights are required to be able to add/remove levels.
- In the General Settings section of the project, the admin defines the frequency to send a notification to reviewers, approvers/approvers closers of pending level.
- The entity will be considered as approved only on approval at all the defined Levels, else the entity will be displayed in an In-review state.
- In case the entity gets rejected later on at any of the levels, it will be moved back to the first level of approval i.e. In Review state.
- There can be multiple approvers/reviewers at each level. But to mark an entity as approved, approval from a single approver is required. The entity will then move to the next level of approval.
- During the approval process, if users make any change to the entity, the entity will be moved back to the first level of approval irrespective of its current level of approval. All the approvals of that entity will be revoked.
- You can not add the next level when the lower level does not have reviewers/approvers in it.
Whenever assets are reviewed/approved, a notification is sent to reviewers/approvers of all levels except the one who reviewed/approved the assets and to Created By, Watchers, Owners of those assets.
QMetry sends a notification to the "Created by" user when reviewers/approvers/closers reject an entity with Request Change.
...
- Adding a New Level
- Edit Level Name
- Change sequence of Levels
- Delete Approval Levels
- Add Requirement Reviewers to Levels
- Add Test Case Approvers to Levels
- Add Test Suite Run Approvers to Levels
- Add Test Run Closers to Levels
Review a Requirement
Users may want to verify whether the requirements are written in accordance with the specifications. In the case of an external tracker like Jira, users can verify the requirements imported from Jira into QMetry and associate relevant test cases.
...
See that the Orange symbol is replaced with the Green symbol after approval at all the levels.
(C) On the Change Log tab on the test case details page.
...
Operations on "Approved" Test Cases | Impact on Test Case State |
|---|---|
Copy | Will reset the State to “In Review” |
Move in same project | Will preserve the State |
Move in other project | Will reset the State to “In Review” |
Export | Will export the State of test case |
Re-import | Will create a new version of test case and reset the State to “In Review” |
Linking Release/Cycle/Requirement/Test Execution | Will not reset the test case State |
Adding Comments | Will not reset the test case State |
Approve a Test Execution
Test Case executions are approved through the Approval Workflow that verifies that the test run execution was documented correctly.
...
- Test Suite > Test Executions tab
- Test Execution Screen
- Bulk Operations
- Bulk Request Change Operation for Test Executions
The following is the list view of test executions available in the Test Suites module (Test Execution tab). Later in the section, we have used the test execution screen.
...
The Test Execution screen appears disabled until you approve the test suiteexecution. Once you approve the test suite for execution, the Test Execution screen is displayed in editable mode.
Request Change: If the approver wants some modifications in the test case, then they can ask for the required change by clicking on the Request Change button.
When the approver clicks on the Request Change option, the pop-up opens to enter remarks regarding it. Add remarks and click on the Request change button.
Approve: The test execution will be marked as Approved by the approver at <Level 1>.
The following pop-up opens asking for confirmation. Click “Yes” to approve the test case.
A pop-up opens to add remarks.
...
- Approve: The option behaves the same as Level 1. The test execution will be marked as Approved by the approver at Level 2.
- Request Change: If the approver wants some modifications in the test execution, then they can ask for the required change by clicking on the Request Change button.
Request Change
When the approver clicks on the Request Change option, the pop-up opens to enter remarks regarding it. Add remarks and click on the Request change button.
The test execution is moved back to Level 1 for approval.
The email notification about the approval status and details is sent to the "Created By" users when approvers request changes.
...
- Approve: The option behaves the same as Level 1. The test execution will be marked as Approved by the approver at the last level.
- Request Change: If the approver wants some modifications in the test execution, then they can ask for the required change by clicking on the Request Change button.
Approving the Test Execution Run at the last level will allow the user to update Test Case results.
On approval at the last level, the test case will have the Approved state.
Once the test execution is approved for execution, an email will be sent to its Owner/Assignee informing that it is ready for execution.
...
Once the approved test suite is executed, proper status is assigned and bugs are logged with relevant test cases/test steps, the test execution can be marked as "Closed" by the users with test suite approval execution closer access.Once you close the test execution, test case results In the case of multiple hierarchy levels defined for test execution closers, only the last level closer can close the test execution.
Once you close the test execution, test case results cannot be modified/executed further. However, you can view the bugs and download the attachments associated with the test cases and test steps.
Use Case: The QA Manager in an organization wants to freeze the execution of the test suite once it is executed to preserve the test run execution and prevent any modification in the test suite runexecution.
To close the test execution of the test suite, click on the Close option at the top-right of the Test Execution screen.
The following pop-up opens asking for confirmation. Click "Yes" to close the test execution.
The test execution is greyed out and its status is changed to "Closed". You can view the approval details by clicking on the info icon.
View Approval Logs
As the test execution passed through subsequent levels, the corresponding entries are displayed under Change Log.
Bulk Edit
For test case Bulk Edit, users can select either "In Review" and "Approved" test cases at a time.
Note: Users can perform bulk edit on unarchived and non-shareable records.
You can add/edit the following for Approved test cases:
- Linkages (like Attachments, Requirements, Releases & Cycles)
- Comment
Approval Workflow for Cross Projects
...
Approval Workflow in
Project A (current project)
...
Approval Workflow in
Project B
...
NA (For Approval Workflow disabled projects, the Link Test Cases screen shows projects without Approval Workflow)
...
Automation Testing
If the eSignature feature is enabled in the project, then -
a) Test Cases created or linked through Automation (Automation API/Jenkins/Bamboo/Rest API) will be approved automatically irrespective of user's permissions for Approval.
b) Test Suite Executions created through Automation (Automation API/Jenkins/Bamboo/Rest API) will be in the "Approved for Execution" State irrespective of user's permissions for Approval.
Audit Log
All the activities related to approval workflow are logged under Audit Compliance > Audit Log.
Approval Workflow Details
Users can open test case detail in PDF by clicking on the Export Test Case Detail icon on the test case detail page.
If the eSignature feature is enable for the project, then the report also includes Approval Workflow details for the test case including approval statuses i.e. "In-Review", "Approved", etc.
Remove Reviewers/Approvers from Project
Expand eSignature on the tree and click on the Approval Access option. The screen opens with three tabs on it: RQ Reviewer, TC Approver and TS Approver.
...
Entities reviewed/approved earlier by this reviewer/approver will not have any impact.
You can also view Approval Workflow Report.
Bulk Review Requirements
The Review option of Bulk Operation is only available in Requirements modules. Users can now review requirements in bulk for the e-Signature feature.
When the reviewer is confident about the requirements covered in the release and cycle, they prefer to review them at a time instead of reviewing them one by one.
Note: Users can only review the In-Review and unarchived requirements in bulk
Business Rules:
Test Suite Execution is “Approved” and not closed at any level i.e. "Closure Pending at Level 1”: If new Approval Level is added then Approved level will be changed to Pending at {New Level}.
Test Suite Execution is “Approved” and closer is initiated at any of the Level: If new Approval Level is added, then Closure status will remain as it is.
- If a Closure cycle is not initiated any of the levels and requires tester to change execution or add additional information on execution, then by Request Change, Approver can reset the status back to Approval Pending at Level 1.
Once Closure cycle is initiated, adding a new level of Approval will not impact the current status of Closure cycle.
To close the execution of the test suite, click on the Close option at the top-right of the Test Execution screen.
Closure at Level 1
Steps:
1. Open the test execution with the “Approved” State.
2. To close the test execution run, click on the Close option at the top right. Once you close the test execution, it cannot be edited further.
Request Change: If the closer wants some modifications in the test case/test suite, then they can ask for the required change by clicking on the Request Change button.
When the closer clicks on the Request Change option, the pop-up opens to enter remarks regarding it. Add remarks and click on the Request change button.
Once the test execution is requested for change at closure level, its approved status will reset and set as "Approval Pending at Level 1".
The entire cycle of approval needs to be performed on the test execution. Once the test execution achieves the status of "Approved", it becomes available for Closure cycle.
Close: The test execution pending for closure will show "Closure Pending at <Level 1>. Once you click the Close option, The following pop-up opens asking for confirmation. Click “Yes” to close the test execution.
Multiple Hierarchy for Closure:
Once the closure is performed at level 1, the status shows Closure Pending at <Level 2>. The test execution will be marked as "Closed" only if the closer at last level closes the test execution.
The test execution gets closed at the last level of test execution Closure. The test execution is greyed out and its status is changed to "Closed".
You can view the approval details by clicking on the Approval & Closure Details button.
View Approval Logs
As the test execution passed through subsequent levels, the corresponding entries are displayed under Change Log.
Bulk Edit
For test case Bulk Edit, users can select either "In Review" and "Approved" test cases at a time.
Note: Users can perform bulk edit on unarchived and non-shareable records.
You can add/edit the following for Approved test cases:
- Linkages (like Attachments, Requirements, Releases & Cycles)
- Comment
Approval Workflow for Cross Projects
Approval Workflow in Project A (current project) | Approval Workflow in Project B | Linking assets of Project B to Project A |
|---|---|---|
| enabled | disabled | NA (For Approval Workflow enabled projects, the Link Test Cases screen shows only those projects which has Approval Workflow enabled) |
| disabled | enabled | NA (For Approval Workflow disabled projects, the Link Test Cases screen shows projects without Approval Workflow) |
| enabled | enabled | Only Approved test cases from Project B |
| disabled | disabled | All test cases from Project B |
Automation Testing
If the eSignature feature is enabled in the project, then -
a) Test Cases created or linked through Automation (Automation API/Jenkins/Bamboo/Rest API) will be approved automatically irrespective of user's permissions for Approval.
b) Test Suite Executions created through Automation (Automation API/Jenkins/Bamboo/Rest API) will be in the "Approved for Execution" State irrespective of user's permissions for Approval.
Audit Log
All the activities related to approval workflow are logged under Audit Compliance > Audit Log.
Approval Workflow Details
Users can open test case detail in PDF by clicking on the Export Test Case Detail icon on the test case detail page.
If the eSignature feature is enable for the project, then the report also includes Approval Workflow details for the test case including approval statuses i.e. "In-Review", "Approved", etc.
Remove Reviewers/Approvers/Closers from Project
Expand eSignature on the tree and click on the Approval Access option. The screen opens with three tabs on it: RQ Reviewer, TC Approver and TS Approver.
To remove a reviewer/approver, click on the Delete icon adjacent to that particular reviewer/approver. The user will not have the right to review/approve requirements/test cases/ test suites for the project anymore.
Entities reviewed/approved earlier by this reviewer/approver will not have any impact.
You can also view Approval Workflow Report.
Bulk Review Requirements
The Review option of Bulk Operation is only available in Requirements modules. Users can now review requirements in bulk for the e-Signature feature.
When the reviewer is confident about the requirements covered in the release and cycle, they prefer to review them at a time instead of reviewing them one by one.
Note: Users can only review the In-Review and unarchived requirements in bulk.
1. Go to Bulk Operations.
2. Select Review as the operation to perform and click Next.
The screen shows entity records. Select the requirements that you want to mark as reviewed.
Then click on the Review button.
Enter remarks and click Review.
The confirmation message pops up. Click "Yes" to proceed.
Bulk Approve Test Cases
Approve option of Bulk Operation is only available in Test Cases and Test Suites modules. Users can now approve test cases and approve/close test executions in bulk for the e-Signature feature.
When QA Manager/Approver is confident about the test cases and test suites covered in the release and cycle, they prefer to approve them at a time instead of approving them one by one.
1. Go to Bulk Operations.
2. Select Approve as the operation to perform and click Next.
The screen shows entity records.
Select the test cases you want to approve or test cases you want to approve/close. Then click on the Approve button.
The confirmation message pops up. Click "Yes" to proceed.
Enter remarks and click Approve.
Bulk Request Change
Bulk Request Change can be applied to test assets (requirements and test cases) that have been approved at least once in any of the previous levels.
The “Request Change” option is not applicable to requirements that are imported from an external tracker like Jira. These imported requirements will not appear in the list of Bulk Operations > Request change.
1. Go to Bulk Operations.
2. Select Request Change as the operation to perform and click Next.
The screen shows records that are approved in the previous levels.
Select the records for which you want to apply Request Change and click on the Request Change button.
The confirmation message pops up. Click "Yes" to proceed.
Add remarks and click on the Request Change button.
Bulk Approve Test Suites/Test Executions
In Bulk Operations for test suite, the Approve, Request Change - Approval, Request Change - Closure and Close options are for test execution.
1. Go to Bulk Operations.
2. Select Review Approve as the operation to perform and click Next.
The screen shows entity records. Select the requirements that you want to mark as reviewed.
Then click on the Review button.
Enter remarks and click Review.
The confirmation message pops up. Click "Yes" to proceed.
Bulk Approve Test Cases
Approve option of Bulk Operation is only available in Test Cases and Test Suites modules. Users can now approve test cases and approve/close test suites in bulk for the e-Signature feature.
When QA Manager/Approver is confident about the test cases and test suites covered in the release and cycle, they prefer to approve them at a time instead of approving them one by one.
If the records exceed 1000, then you can apply the required Filters to filter out records of test executions.
Select records that should be approved and click Approve.
The confirmation pop-up opens. Click Yes to proceed.
Add remarks and click Approve.
Bulk Request Change - Approval
Bulk Request Change - Approval can be applied to test executions that are pending for approval. It will revert test execution's status from "Pending Approval" to "In Review".
1. Go to Bulk Operations.
2. Select Approve Request Change - Approval as the operation to perform and click Next.
The screen shows entity records that are pending for approval.
Select the test cases you want to approve or test suites you want to approve/close. Then click on the Approve button.
If the records exceed 1000, then you can apply the required Filters to filter out records of test executions.
Select the records for which you want to apply Request Change - Approval and click on the Request Change button.
The confirmation message pops up. Click "Yes" to proceed.
Enter Add remarks and click Approveon the Request Change button.
Bulk Request Change - Closure
Bulk Request Change - Closure can be applied to test assets (requirements, test cases and test suites) executions that have been approved at least once in any of the previous levels.
The “Request Change” option is not applicable to requirements that are imported from an external tracker like Jira. These imported requirements will not appear in the list of Bulk Operations > Request change.
1. Go to Bulk Operations.
2. Select Request Change as the operation to perform and click Next.
The screen shows records that are approved in the previous levelsall the approval levels. It will revert test execution's status from "Pending Closure" to "In Review".
If the records exceed 1000, then you can apply the required Filters to filter out records of test executions.
Select the records for which you want to apply Request Change - Closure and click on the Request Change button.
The confirmation message pops up. Click "Yes" to proceed.
...
Add remarks and click on the Request Change button.
...
Bulk Close Test Executions
In Bulk Operations for test suite, the Approve, Request Change and Close options are for test execution.Closers can change the test execution status from "Approved" to "Closed". They can mark the test executions as "Closed" in bulk at a time.
1. Go to Bulk Operations.
2. Select Approve as Close as the operation to perform and click Next.
If the records exceed 1000, then , you can apply the required Filters to filter out records of test executions.
Select the records that should be approved you want to mark as "Closed" and click Approve Close.
The confirmation pop-up opens. Click Yes to proceed.
Add remarks and click ApproveClose.