Backup and Restore test cases in Opkey

Why do we need Backup and Restore in Opkey?

By using the Backup feature, you can easily create a copy of the file, make a replica of that file, restore that backup, restore it to other places, and do more. 

Let's see how to utilize the backup feature within a test case:-

Getting Started with the Backup

Create a Test Case file by recording the application's actions or by manually adding test steps.

  • Click on the Create Backup icon.





  • A popup message “Do you want to create a new backup” appears.
  • Click OK to create a new backup and proceed.



  • Create Backup window opens. Have a look at the details (component type and count) of CreateBackup along with logs.
  • Click Close.




  • A new file backup has now been created successfully.
  • Navigate to the details section, click on the Backup tab, and have a look at the created file backup.


Backup Details

Hover over the Backup Details icon that provides you the detailed information (CreatedBy, CreatedOn, ModifiedBy & ModifiedOn) about the file backup.

  • Click on the  Backup Details icon to view details about the backup.


Preview and make a Replica of the file backup

The Preview icon allows you to make a replica file of the created file backup in Project Workspace. You can preview and make a replica of the older backup file by clicking on the Preview icon.


  • File Replica has been created successfully.
  • Click Finish.




  • The newly created Replica file opens in a new tab automatically. Here you can view that a folder with the same artifact name gets created which contains a subfolder named Dependent artifact (like OR and FL) and creates a replica file.




  • Once the replica has been created successfully, the backup file gets deleted automatically.

Restore Backup

If you have made some changes in the working file and want to restore the older file backup then you can use the Restore Backup icon.

  • Click on the Restore Backup icon to proceed.





  • The process to restore the file backup is going on. You can have a look at the Component Type, Count, and live logs.
  • In this step, you can see that the Restore Backup process has been completed successfully.
  • Click on Close.



Note –

While restoring an existing backup to the current working file, Opkey automatically creates a file backup (with a comment as “Auto created on restoring Version No: 1” )of the current file and then restores the desired file backup.



Restore To

This option allows you to restore the file backup to the desired place in the project workspace.


Click on the Restore To icon.


  • Restore To window opens. The select folder in which you want to restore the older backup file and then click on Next.



  • In this step, you can add tags.
  • Check the Retain Original Tag(s) checkbox to keep existing tags and click on Apply.



  • Your file backup has been successfully restored to the selected folder.



You can have a look at the restored backup file along with a folder Dependent_Artifacts containing dependent artifacts (like OR, FL, etc.)





Delete Backup

You can delete the existing file backup showing in the dockable panel under the Older backup tab.

  • Select the file backup and click on the Delete Backup icon.




  • A warning pop-up message appears: Are you sure you want to delete?
  • Click on Yes to delete the file backup.




  • The desired Backup file will get deleted.

Compare with Backup

OpKey users can now compare the current working file with its backup file. Thus, you can easily compare the changes done in both files and analyze them. You can easily identify the changes done in your current file. To compare the current working file with an existing backup of this file, you need to click on the compare backup button of the corresponding backup file showing under the dockable panel in the Backup tab.



  • Here, you can select the two backup files to compare them.





  • Here, you can have a look at the comparison report of the Backup and current Working file.





Click Here to learn more about Opkey features.

To gain more understanding about Opkey and its backup feature, visit https://university.opkeylms.com and enroll in our Opkey series course.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article