1. Edit the config.json file

The first step to using the VERA qTest Migration Helper utility is to edit the included config.json file. Follow the steps below to update the file:

{
  "api_key": "########-####-####-####-############",
  "server_url": "https://tx3.qtestnet.com" ,
  "project_ids": ["116893", "117063"],
  "fields_to_match": [
    {
      "name": "Status",
      "values": [ "Closed", "Approved" ]
    },
    {
      "name": "Priority",
      "values": ["Medium"]
    },
    {
      "name": "VERA Approval Status",
      "values": ["Draft"]
    }
  ],
  "fields_to_update": [
    {
      "name": "Status",
      "value": "Imported",
      "overwrite": true
    },
    {
      "name": "Description",
      "value": "Approved in previous system",
      "overwrite": false
    }
  ]
}

1. Provide an API Key (optional):
   1. This is the API key available from qTest for the account that will be updating records:
      1. To access your api key, click on the Resources button
         1. 
      2. Then expand the API & SDK section
         1. 
      3. Finally, copy the token after bearer:
         1. 

            Required Permissions

            The account used for the migration utility must have access to edit all tests and fields in the projects being updated.

   2. This can also be left blank and the utility will ask for the API Key each time it is run.
2. Provide the Server URL:
   1. This is the URL for the qTest server and is required,
3. Provide Project IDs:
   1. Enter a list of Project IDs for the projects that you want the utility to scan.
   2. Project IDs can be obtained from either the URL for a project or the list of Projects in the Administration area:
      1. URL:
         1.  
      2. Project Administration:
         1. As a site admin, access the Administration Area > Projects:
            1. 
         2. The table displays all projects and their ids:
            1. 
   3. This is required and the utility will fail if it is not provided.
4. Provide a list of criteria to match when selecting tests:
   1. Criteria are presents as JSON objects with two properties: Name and Values
      1. Name is the qTest Label of the field. This must match exactly with what is in qTest.
      2. Values is a list of string values to match. The utility will match any of the values in the list. This will only work for single select field and text fields. The field must match the text of the value exactly, but is case insenstive.
   2. At least one criteria must be present or else the utility will not run.
5. Provide a list of field updates:
   1. Field updates are presented as a list of JSON objects with three properties: Name, Value, and Overwrite
      1. Name is the qTest Label of the field. This must match exactly with what is in qTest.
      2. Value is the value to set the field to or append to the existing value
      3. Overwrite is a boolean indicating if the existing field value should be overwritten or appended to. True or omitting the property will overwrite the contents of the field and false will append to the existing value.
         1. Appending only works for text fields and will be ignored for single select fields.
   2. This is not required for the utility to process.