Edit Case Steps

AIO Tests not only allows bulk editing of case details via the Bulk Actions but also lets users bulk update steps of existing cases.

This is an advanced feature and some key application areas are

• if you want to add/edit one or two steps across multiple cases

• if you want to edit title of multiple existing cases

• if you want to use Excel features of insert, delete, etc. to quickly update your existing cases

This article shows the process to bulk edit case steps in AIO Tests.

The workflow supporting this feature has three steps

Open

Each step is explained in detailed below.

Export existing cases to Excel

Follow the steps below to export cases

1. Narrow down the list of cases for which steps need to be updated by using search/filters

2. Click on More actions ellipsis from the Cases tab and select ‘Export Steps’ as shown below
   
   

   Open

   

    

    

3. An excel file will download (sample shown below). The details included are Case Key, Title, Description, Step type (BDD/Classic), Keyword (for BDD cases), Steps, Linked Case Key (same project or other project’s case key), Data, Expected Result and Step Id and an Instructions sheet

Make updates in Exported Excel

To ensure that AIO Tests app continues to understand that these are existing cases, the updates have to be made in a specific way. Below are the instructions for each field. These details are present in brief in Instructions sheet in the exported excel.

1. Key: This is the key of the existing case in AIO and thus shouldn’t be updated or deleted

2. Description: This is the current description of the case in AIO. It can be updated in excel or deleted

3. Title: This is the title of the existing case in AIO. Title can be updated in the excel and it shouldn’t exceed 255 characters else it will error out on importing back. Title is a mandatory field thus it cannot be left blank either

4. Step Type: Tells if the case is a BDD case or a classic case. The step type can be updated if the case is not linked to other entities. For additional rules regarding conversion click here. The steps can be updated using the keywords of Gherkin

5. Keyword: This column is filled only for BDD cases and can be updated using the supported keywords (Given, When, Then, And and But)

6. Datasets/Examples: Datasets or exampled defined in the case are exported as pipe separated values. Datasets can be added, edited, deleted or reordered.

   1. The first row is considered as parameter names

   2. Parameter can be added, removed or modified

   3. To remove a dataset, remove the entire row

   4. To add a dataset, add pipe separated values for parameters

   5. If there is an empty value, simply add a pipe for keeping it empty

7. Steps: These are steps of the case. Each step is on a different row and has a step id associated with it (last column). Steps can be added, edited, deleted and reordered

   1. Add a new step - Insert a new row and add details of the step. Leave Step Id blank and AIO Tests will interpret it as a new step

   2. Edit a step - Update the contents of existing steps. Don’t change the step id

   3. Delete a step - Delete the entire row (step id also gets removed). If the step id is not found while importing, AIO Tests will interpret that the step needs to be deleted

   4. Reorder steps - Cut the entire row and paste it in the new location. The step id in this case stays the same as the entire row is being moved

8. Linked Case: This is the key of the case that is linked as a step in the case. Users can link cases of the same as well as other projects that they have access to

   1. A new case can be linked by adding a row and providing a valid AIO Tests case key

   2. Existing link can be updated by changing the key to another valid AIO Tests case key

   3. Linked case can be removed by deleting the entire row

9. Data: This is data corresponding to each step of a case. This field acts similar to Steps field - can be added, edited, deleted and reordered (along with step and expected result). Actions need to be taken on entire row. If a new data is being added, corresponding step description and expected result also need to be added as they are mandatory fields for a step

10. Expected Result: This is expected result corresponding to each step of a case. This field acts similar to Steps field - can be added, edited, deleted and reordered (along with data and expected result). Actions need to be taken on entire row. If a new expected result is being added, corresponding step description also needs to be added as it is a mandatory field for a step

11. Step ID: This represents the step id of each step from AIO Tests. Keep the below rules in mind for this field

    1. When adding new steps, leave this field blank

    2. When editing existing steps, do not change this field

    3. When deleting existing steps, delete the entire row in turn deleting this field

    4. When reordering steps, ensure step id gets reorder with the rest of the row

Import edited steps Excel

Once the updates are done to the exported excel file, follow the steps below to import the same file back into AIO Tests.

1. Click on More actions ellipsis from the Cases tab and select ‘Import Edited Steps’ as shown below
   
   

    

    

2. Attach the updated file in the screen below. Once the file is attached, the ‘Upload and Import’ button will be enabled
   
   

    

    

3. Click on Upload and Import button. This will schedule the file to be imported. The import scheduler runs every 3 minutes and imports any uploaded files. The status of the import can be checked in the Jobs section as shown below. The file is initially in ‘Queued’ status. Once its picked up and processed, the status changes to ‘Completed’ if no errors are found while importing. ‘Finished with Errors’ status shows up if the import failed.
   
   

    

4. Users can check details around each case by clicking on the 'Details' link next to the scheduled/completed job. A sample Details screen is shown below
   
   

    

Common Errors

Few of the errors that may occur are explained below

1. Step and Expected result are mandatory in steps: A new step is added but expected result is missing or expected result is removed of an existing step

2. Case not found or insufficient permissions: Invalid case key is provided as linked case or case key is changed and it’s not valid. Another reason for this error is that they case key provided is in draft status and it belongs to other user thus the user trying to import that case doesn’t have access on it. It can also happen if the user doesn’t have access to the linked case of other project

3. Step id does not belong to test or new version has been created: The steps of the case in question have been changed in AIO Tests app after the export was taken but before import could be done. In such scenarios a new version of the case gets created in AIO Tests with new step ids. This makes the exported data stale and it cannot be mapped to the updated version in AIO Tests