1. Home
  2. Opkey Help
  3. 26. Advanced Opkey Usage
  4. 26.1 Backup

26.1 Backup


The backup file of any kind of data plays a vital role in all scenarios. It stores a backup file and allows you to restore it while replacing the current working file. You can restore the backup file at the desired location in Project workspace. You can create multiple backup files if required.

Backup in OpKey

Backup is an advanced feature that is now available in OpKey. By using this Backup feature, you can easily create a copy of the file, make multiple backup files, restore that copy, restore to other places and do more.

Need of Backup feature?

While working on a file, OpKey users make various changes. Sometimes, they need to go back to the previous state of the file and restore that but tracing earlier changes and going back to that file state is very difficult. Now, it’s possible with the Backup feature as it allows you to create file backup(s) and restore a particular file backup and do more with the older file backup.

Benefits of Backup

Some of the common benefits of using the Backup feature are as follows:

  • You can create multiple file backups, save them & work on the current file
  • You can make a replica of a backup file, restore this backup, restore it to other places and do more
  • You can further branch the restored file backup
  • You can easily compare differences between two backup files
  • You can revert back to older file backups quickly and easily
  • You can add unique comments to trace file backup quickly
  • You can experiment with new changes without worrying about losing the functioning code

Getting started with the Backup

Let us create a Test Case file and then work on its backup feature.

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

  • Click on the Create New Backup button.

  • 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 Download Logs to download logs.
  • Click Close.

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

Backup Details

Mouse hover over the Backup Details button provides you the detailed information (CreatedBy, CreatedOn, ModifiedBy & ModifiedOn) about the file backup.

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

Preview and make a Replica of the file backup

The Preview button 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 button.

  • Click on the Preview button to make a replica.
  • 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 as Dependent artifact (like OR and FL) and created a replica file.

  • Once the replica has 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 button.

  • Click on the Restore Backup button 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 view that the Restore Backup process has 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 restore 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 Restore To button.
  • 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.

  • Here, your file backup has been restored to the selected folder, successfully.

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 button.

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

  • Here, you can view that the desired Backup file has been 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 about 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 have a look at the comparison report of the Backup and current Working file.

Was this article helpful to you? Yes No