Below are the few use cases along with the JSONs that you can implement using the Auto-Triage Correction QaCONNECT Service.

• Use Case 1: Auto Correction of the Labels/Issues assigned by Worksoft AI/ML to the failed tests within the Test Cycle.

  You have executed a batch of tests and have observed the auto-assignment of the labels/issues by Worksoft AI/ML have happened incorrectly. In such scenarios, you can use this service to make the corrections by learning which helps you to auto-correct the assignment of the labels/issues to the failed tests. You just need to follow the below steps by assigning the correct root cause for a few tests.

  The steps to auto-correct the assignment of the labels/issues using the service are:

  1. Failures occurred for the tests executed within the specific test cycle and you have observed that the assignment of the root cause for failure labels/issues by Worksoft AI/ML is not correct. For example, there are 100 tests executed within a test cycle and out of which 70 tests got failed due to certain exception/error and you have observed few of the tests assigned with labels/issues by Worksoft AI/ML feature were not correct. 
  
  
  2. Now, all you need to do is simply correct the root cause for failure labels/issues assignment for the observed ones and let the other test gets corrected by using this service. You are learning that there is incorrect assignment and henceforth, you are performing the correction using the service. It is as simple as that.

     For example, the failure occurred due to application flakiness and the assignment made by Worksoft AI/ML is incorrect. Then assign application flakiness for one of the test runs. Once, the assignment is made, you need to prepare the request JSON for triggering the auto triage correction service.

  3. Prepare the JSON with the inputs as shown below.
     {
       "projectName": "YOUR_PROJECT_NAME",
       "sourceTestCycles": [
         "Batch_Test_Cycle_1"
       ],
       "targetTestCycles": [
         "Batch_Test_Cycle_1"
       ],
       "conditionsForAutoCorrection": "02",
       "scopeOfAutoCorrection": "00"
     }
     Since you are performing the auto-corrections within the test cycle, the parameter "sourceTestCycles" and "targetTestCycles" is the same.
  
  
  4. Using the JSON and the URL, you can trigger the service. Once, the request is successful, you can see the response.
     {
       "status": "success",
       "code": "OK",
       "developerMessage": "",
       "userMessage": "The processing for your request will start asap. It will take some time (several minutes) for the processing to complete. You can make a request to the https://www.web.worksoft.cloud/v1/{domainName}/{projectName}/analytics/reports/{key}, under 'Analytics' category of the DOCS page, to check the status and download a report that provides detail that you will benefit from (or you are looking for).",
       "data": {
         "key": "0c9c68be-1ef8-42ac-a715-2a63a3828966"
       }
     }
     
  5. As you can see the "userMessage" in the above response, you can see the corrections reflected for the failed tests of a test cycle after some time. You can also download the report(in .zip format) using another service available in the Analytics Section in the Docs page or you can simply use the URL mentioned in the "userMessage" by adding the required details. Using the "GET" method, you can download the report which comprises of 4 sheets namely "RCF Label Source Data Summary, RCF Label Update Summary, Issue Source Data Summary, Issue Update Summary, JSON Input for QaCONNECT" which details about all the Root Cause for Failure labels and Issues & also the JSON that was used to trigger the service.
  
  
  6. This way, you can also review the inputs that were passed in the JSON.
  
  
• Use Case 2: Auto-correction of the labels/issues assigned by multiple users within the team in your project within the test cycle

  In this scenario, you have multiple members within a team and are automating and executing the tests within a test cycle. According to each team member's knowledge of the failures occurred, the assignment of the labels/issues is made. As a project lead or another team member, you have observed that the assignment made by a few or one of them is incorrect. In such situations, you can use the auto triage correction service and make the necessary changes to the assigned labels/issues accordingly.

  You can follow the steps mentioned in the above Use Case 1 with the below JSON.

  {
    "projectName": "YOUR_PROJECT_NAME",
    "sourceTestCycles": [
      "TEST_CYCLE_1"
    ],
    "targetTestCycles": [
      "TEST_CYCLE_1"
    ],
    "conditionsForAutoCorrection": "03",
    "scopeOfAutoCorrection": "00",
    "usersThatPerformedActionsInSourceTestCycles": [
      "Source_User_Name_1",
      "Source_User_Name_2"
    ],
    "usersThatAssignedRootCausesInTargetTestCycles": [
      "Target_User_Name_1"
    ]
  }
  

• Use Case 3: Auto-correction of the labels/issues only from a specific time period which are either assigned by Worksoft AI/ML or manually within the test cycle.

This 3rd use case details about how the auto-correction of the labels/issues that are either assigned manually or by Worksoft AI/ML by specifying a certain time period. For example, you have executed a batch of tests in the morning and evening and the auto-assignment of the Worksoft AI/Ml or manually (or) you have the corrections to be made wrt the tests executed in the morning or evening, then you can specify the time using the "conditionCutOffDateTimeForSourceUsersThatPerformedActions" parameter.

You can follow the steps mentioned in the Use Case 1 with the below JSON.

{
      "projectName": "YOUR_PROJECT_NAME",
      "sourceTestCycles": ["TEST_CYCLE_1"],
      "targetTestCycles": ["TEST_CYCLE_1"],
      "conditionsForAutoCorrection": "03",
      "scopeOfAutoCorrection": "00",
      "usersThatPerformedActionsInSourceTestCycles": ["Source_User_Name_1","Source_User_Name_2"],
      "usersThatAssignedRootCausesInTargetTestCycles: ["Target_User_Name_1"],
  "conditionCutOffDateTimeForSourceUsersThatPerformedActions": "YOUR_CUTOFF_DATETIME_FOR_SOURCE_USERS"

}

You can refer to the docs page for more details accessible at Docs page.

Few points to be taken care of while preparing the request JSON along with the validations that occur during the triggering of the service

1. On providing invalid Project name as input in the Request JSON, the below error message is shown.
   {
     "status": "failure",
     "code": "InvalidInput",
     "developerMessage": "",
     "userMessage": "An Invalid value was passed as input for the \"name\" of the Project.The project name that was passed as input does NOT exist in your Worksoft SaaS domain.",
     "data": null
   }
   
2. On providing invalid test cycle identifiers in the "sourceTestCycles", below error message is shown
   {
     "status": "failure",
     "code": "InvalidInput",
     "developerMessage": "",
     "userMessage": "Please ensure that the test cycle(s) 'Batch_Runs_2020' provided in 'sourceTestCycles' parameter are present in the specified 'Amazon Public Site project. Please check the values and retry the request again.",
     "data": null
   }
   
3. On providing invalid test cycle identifiers in the "targetTestCycles", below error message is shown
   {
     "status": "failure",
     "code": "InvalidInput",
     "developerMessage": "",
     "userMessage": "Please ensure that the test cycle(s) 'Batch_Runs_2020' provided in 'targetTestCycles' parameter are present in the specified 'Amazon Public Site project. Please check the values and retry the request again.",
     "data": null
   }
   
4. On providing invalid inputs for "scopeOfAutoCorrection" and "conditionsForAutoCorrection" parameters in the request JSON
   {
     "status": "failure",
     "code": "InvalidInput",
     "developerMessage": "",
     "userMessage": "Please ensure that your QaCONNECT REST API client 'program' passes valid values for 'scopeOfAutoCorrection' and 'conditionsForAutoCorrection'. The valid values for 'scopeOfAutoCorrection' are 00,01,02 and for 'conditionsForAutoCorrection' are 01,02,03,04.",
     "data": null
   }