Restore HyWorks Controller

Entire HyWorks deployment can be restored from the database backup. In this section, different scenarios, methods will be mentioned in detail.

Placing The BackUp File On HyWorks Controller

Once backup is taken successfully, it is very important for administrator to place the backup file in

1. Appropriate format (.bak format)

2. Appropriate location on controller for restore

BackUp File Format

HyWorks Controller stores the backup file in zip format in the following default location:

C:\Windows\TEMP\DB\BACKUP\

To restore backup, the file must be extracted first. On extraction, following type of file will be available for restore:

• For SQL Server Database: file should use .bak extension

Appropriate Directory For Restore

The location from where backup files can be restored, depends on the HyWorks controller database configurations:

• For HyWorks Controller with SQL Server Database: While restoring HyWorks Controller with SQL Server configuration, SQL Server should have write access on the directory in which Backup file is available. This can be done using following two methods:

  • Copy Backup File in SQL Server Backup Directory: The default location where the backup is placed does not have the required permission set and thus either the permission should be appropriately configured for SQL Server or the file can be moved to SQL Server Install location -> Backup folder. Backup folder works correctly while restoring HyWorks controller with SQL server and should be preferred for restore over any other location.

  • Configure Permissions on Backup File Directory

Please refer Troubleshooting section for permission configuration guidelines.

Restore HyWorks Controller

Important

Important

• In production environments, restore operation should be done very carefully.
• Restored HyWorks Controller and source server (whose backup has been taken) should not run in same network, as session host server and other modules will start getting conflicting HyWorks Controller server configurations.

Prerequisites:

1. Appropriate backup file in specified file format available for restore. Refer section BackUp File Format

2. Backup file is available in appropriate directory. Refer section Appropriate Directory For Restore for details. Preferably, the backup file can be kept in SQL server backup folder itself, if SQL Server is installed locally on same Windows server.

   1. Default location of SQL Server backup location:

   C:\Program Files\Microsoft SQL Server\MSSQL14.SQLEXPRESS\MSSQL\Backup

Restore Process using Controller Setup wizard

Installing New Controller with Backed-up Database

Follow the below listed steps to configure a new controller by restoring backup database

1. Access the Windows server to be configured as HyWorks Controller; which satisfies the following prerequisites

   1. All required prerequisites for HyWorks Controller i.e. DotNet4.5, ASP.Net4.5, SSCE runtime, SQL server and Web Server (IIS roles) are configured

   2. The server does not have any existing installed HyWorks Controller as the new HyWorks Controller has to be created using existing database backup

2. Invoke HyWorks Installer with administrative rights on the server (where the HyWorks Controller is not installed)

   

3. The Setup wizard will get launched in fresh installation mode displaying Welcome screen

4. Follow the onscreen instructions and proceed until Service Database Configuration screen

5. In Database Selection

   Select Database type as Microsoft SQL Server; if the backup file is from SQL Server based Controller. Provide required information i.e. Database Address, Port Number, Database Name, Authentication details ii. Click Next to proceed

6. Configure appropriate log server in Log Database Configuration Screen and click on Next to proceed

7. On Restore Database

   1. Select checkbox Do you want to restore database?

   2. Click Browse

   3. Browse to location where the backup file (.bak for SQL Server database) is kept

   4. Select the backup file and click Next

   

8. Follow onscreen instructions; click Install to start the installation

9. Wait for installation to complete

10. After completion of installation, new HyWorks Controller will be up and running with configurations as per the backup

11. Verify the configurations from HyWorks Controller Management Console

Repair existing HyWorks Controller and restoring the backup

1. Access the Windows server to be configured as HyWorks Controller; which satisfies the following prerequisites

   1. All required prerequisites for HyWorks Controller i.e. DotNet4.5, ASP.Net4.5, SSCE runtime, SQL server and Web Server (IIS roles) are configured

   2. The server is already having an existing installed HyWorks Controller; which should be repaired to restore configurations

2. Invoke HyWorks Installer with administrative rights on the server (where the HyWorks Controller is not installed)

   

3. The Setup wizard will get launched in Maintenance Mode displaying options to Repair and Uninstall; select option Repair, and Click Next

4. Maintenance mode with Repair option provides different configuration screens as most of the configurations as already done during installation. After selecting the Repair option, Administrator will be presented with following screens:

   1. Components Selection Screen to select

   2. Service Logon Credentials

5. On Restore database page

   1. Select checkbox Do you want to restore database?

   2. Click Browse

   3. Browse to location where the backup file (.bak for SQL Server database) is kept

   4. Select the backup file and click Next

   

6. Proceed till Confirm screen in Setup wizard by providing appropriate details in different screens; Click Repair to start the repair operation as per configured option and provided database backup file

7. After completion of repair operations, existing HyWorks Controller will be repaired with database restored from backup file.

8. Verify the configurations from HyWorks Controller Management Console

Configurations not supported or not recommended for restore

Following types of HyWorks Controller configurations cannot be restored using backup file and thus the restore should not be attempted on such production configurations.

• HyWorks Controller configured to use SQL Server database on Remote machine

  The backup itself will get failed with appropriate error and even when some backup file is available, the restore should not be attempted.

• HyWorks Controllers in Cluster Configuration

  It is not recommended to attempt restoring primary or secondary HyWorks Controller in cluster configuration though backup can be taken successfully.

  • Recommendations for Clustered HyWorks Controllers:

    1. Prepare a fresh HyWorks Controller with same version

    2. Add it to the cluster

    3. It will automatically sync the database from primary HyWorks controller avoiding any restore process.

Restore using SQL Server Management Studio

As mentioned in section above, mentioned in Troubleshooting section and in Important section, restoring HyWorks controller using Controller setup wizard will have some configurational issues:

1. A fresh controller equivalent to existing controller will be readied and all other modules in production may start communicating with both of the HyWorks Controllers and cause issues
2. Fresh controller created using backed-up database will have entry of the old controller (from where backup has been taken) and it has to be cleared after controller is installed completely.
3. Restoration can not be done for setups having SQL server running on other Windows server than HyWorks Controller.

This method of restoring HyWorks Controller backup, using SQL Management Studio can help to overcome these challenges.

Benefits:

1. Initially only database will be restored, which means no new HyWorks Controller will be live similar to the one which has been backed-up.
2. Administrator will be able to clean-up the database, to remove residual entries from source controller.
3. The method can be used to restore database for configurations, which are using SQL server running on other than HyWorks Controller server.

Prerequisites:

1. Backup file from source controller is available in appropriate directory.

2. Preferably, the backup file can be kept in SQL server backup folder itself.

   1. Default location of SQL Server backup location:

   C:\Program Files\Microsoft SQL Server\MSSQL14.SQLEXPRESS\MSSQL\Backup

Part# 1: Restoring Database

1. Assuming backup file is placed in SQL server backup location.
2. Launch SQL Server Management Studio
3. Connect to SQL Server on which backup has to be restored
4. Right click on left hand object explorer, right click on Databases
5. Select option Restore Database...

6. In Restore Database window

   1. Select option Device
   2. Click on Browser button to select backup file

   

   1. This will automatically open dialog to add backup file

      1. In Select backup devices dialog, click Add button

      

      1. It should open SQL Server backup location by default and should list the backup file copied in step# 1

      

      1. Select the file, and click on OK button
         1. Selected file should now be shown on Select backup devices dialog, click on OK to proceed
      2. Administrator should be navigated back to Restore Database window, displaying all selected options.
      3. Click on OK to continue restoring

   

7. Progress bar will be displayed on top of Restore Database window and once completed successfully, dialog will be displayed confirming successful restore of the database.

   

Part# 2: Installing Controller and using Restored DB

1. Copy HyWorks Controller setup on Windows Server with all prerequisites installed and configured
2. Proceed with installation until screen Service Database Configuration comes
3. In Service Database Configuration screen, provide following details:
   1. SQL Server details which has been used to restore the database
   2. Provide database name same as the one restored
   3. Provide credentials (Source and destination SQL server configurations should be identical to avoid failures)
4. Click on Next to proceed

5. Dialog will be displayed, suggesting database with same already exist and should it be used

   1. Click on YES to proceed with installation

   

6. Configure log database as per recommendations

7. When installing controller with existing database, Do not select restore database option on Restore database screen
8. All other installation configurations should also be done as per deployment and recommendations.
9. Finish the setup - Controller will be installed with restored database.

Troubleshooting

Duplicate Controller Entry after restore

Secondary controller entry will be automatically added when HyWorks Controller is installed using backup database using SQL Server as database.

Procedure to remove secondary controller entry:

1. Login into HyWorks management console

2. Go to Server -> HyWorks Controller section

3. Verify the duplicate entries being present of same server

4. Click Delete displayed against one of the entry to remove the secondary controller entry

Manually configure permission for SQL Server on default Backup Directory

This one-time configuration can help in achieving convenient way of backup restore from the default directory and avoiding any possible permission issue on server.

The intention is providing full control to MSSQLSERVER account on the default backup directory; which is

C:\Windows\TEMP\DB\BACKUP\

Follow the below steps to configure permissions on this backup folder:

1. Log into the server. (The change must be made on the actual server, not through a network share.)

2. Select the backup folder highlighted below and Right-click -> Select option Properties

   

3. In Properties -> Security -> Click Edit

   

4. In Security dialog, Click Add

   

5. In Add User dialog

   1. Change the Locations to the local server name.

   2. Type in NT SERVICE\MSSQLSERVER in the name box. (Do not click Check Names)

   3. Click OK. You will then see a list of the matching service accounts. Select MSSQLSERVER, and click OK to accept the selection.

      

      

You should see the service account listed in the security settings, and can adjust the permissions accordingly.