Affected Version: v.2.9.3 or higher versions


From v.2.9.3 of BioStar 2, the function "Backup & Restore" has been introduced newly.

Thanks to this new function, users can back up the necessary data on BioStar 2 more easily and conveniently.  


If you have an issue with this feature in BioStar 2 v2.9.4 or v2.9.5, please refer to the linked article below.
[Known Issue] Database Restore Failure at the BioStar 2 Restore Tool (Upgraded from V2.9.3)



Background


Until v.2.9.2, or lower versions, users needed to manually backup the necessary files, such as a database or enckey file, to prepare for any unexpected problems. However, this must be done manually, which may be cumbersome, and there is potential for issues during the backup, such as missing some mandatory files.


Note that

- If the MSSQL database and BioStar 2 are installed on different PCs, BioStar 2 System Backup and Restore     

   CANNOT be used.

- If BioStar 2 version at the time of backup is different from the current version, the restoration will not proceed.


Summary


1. Backup: 

Users can back up the necessary data automatically and regularly by using the new function SYSTEM BACKUP in the Settings of BioStar 2.


Note that

The below data is backed up in your current BioStar 2 when using this function.


  1. Database 
    1. AC
    2. TA
    3. Video
  2. Folders 
    1. cert
    2. lic
    3. util - The path in reference to "system.conf."
    4. imagelog
    5. upload (located in C:\Program Files\BioStar 2(x64)\nginx\html) --> This folder will be only included in backup data if there is any file. The file is generated only if you set the Graphic Map View in MONITORING of BioStar 2.                                                                  
    6. conf (located in C:\Program Files\BioStar 2(x64)\nginx)
    7. records (located in C:\Program Files\BioStar 2(x64)\ve)
    8. db (C:\Program Files\BioStar 2(x64)\ve)
  3. CONF files
    1. setting.conf
    2. system.conf
    3. server_url.conf
    4. log.conf
    5. sysbackup.conf


2. Restore:

Users can restore the backup data by using an extra application named biostar-restore located at C:\Program Files\BioStar 2(x64).




Major features


1. Set the cycle for backup of the data

Users can back up the files in BioStar 2 automatically and periodically according to the selected option in Frequency of Automatic System Backup. 


Note that

There are a total of four options (Not Use / Daily / Weekly / Monthly) on Frequency.


  1. Not Use: If selecting this option, the data will not be backed up regularly and automatically. Instead, you can back up the data by clicking the "Backup Now" in "General." 
  2. Daily: If selecting it, the data will be backed up at the set time daily
  3. Weekly: If selecting it, the data will be backed up at the set time and day weekly
  4. Monthly: If selecting it, the data will be backed up at the set time and date monthly



Note that

Users can see the last time the data was backed up, indicated by the red line below in the General.



2. Set the number of files to keep

Users can define the maximum number of backup files to keep by setting "Number of Backup Files to Keep" in the General section of BioStar 2. Once a specific number is set, the oldest backup data will be deleted when the number of backup files exceeds this limit.


Note

The allowable number range is from 1 to 100.




3. Use the extra application to restore

Restoring the data is processed through the extra tool named "biostar-restore." The tool will be automatically installed when installing BioStar 2 v.2.9.3 and located in C:\Program Files\BioStar 2(x64). 

Since the specific tool for data restoration is separate from BioStar 2, users can attempt to restore data when BioStar 2 isn't running normally due to configuration problems or database issues.



4. Restorable depending on the backup data version

If the backup data was generated using a version lower than the current one, it cannot be restored through this new function.

Example) 

If the backup data is generated in v.2.9.3, it CANNOT be restored in v.2.9.4 or a higher version of BioStar 2. 


Note

Suprema plans to improve the above restriction, but the specific plan is not fixed.




Precautions


In the case of using MSSQL, you will meet the two types of warning popups below and CANNOT each function normally if you don't assign the sysadmin of the Server Role to the database user. 

If you are in the above case, please check first if the sysadmin has already been assigned to the user.



Error Case 1. 

When using SYSTEM BACKUP



Error  Case 2.

When using biostar-restore




Execution Procedure


Step 1. Backup (based on the case of using the function manually) 


Step1-1. 

Go to SYSTEM BACKUP in Settings after logging into BioStar 2


Step1-2.

Click Backup Now


Note that

Backup File Path: Set the path to save the backup file. The save path must be set to a directory that has already been created.



Step1-3.

Go to C:\Program Files\BioStar 2(x64)\Backupgenerated correctly and check if the file is the correct one generated when you tried to make it.


Step2. Restore


Step2-1.

Run the application named biostar-restore located at C:\Program Files\BioStar 2(x64)

 


Step2-2.


1) If using Maria DB,

Select the file and apply it after clicking the Select File button. Then, put the root password on your Maria DB and click the Restore button.


2) If using MSSQL,

Select the file and apply it after clicking the Select File button. Then, click the Restore button.


Step2-3.

Then, you will see an additional popup appear below. Then, click Yes.


Step2-4.

Finally, the restoration is completed normally if you see the popup below. 

However, please note that the popup does not disappear even when the restoration is completed normally.


Step2-5.

You must log into BioStar 2 again once the restoration has been completed. After logging into BioStar 2, please check whether the restoration has been completed normally.