Difference between revisions of "Restore IMSMA Backup on Server"

From IMSMA Wiki
Jump to: navigation, search
 
(38 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{note| If you are restoring your IMSMA data due to a system crash, you will first want to reinstall IMSMA and its supporting applications. For more information, see the IMSMA 4.01.02 Installation Guide for details
+
{{TOC right}}
}}
+
{{note| If you are running IMSMA in a client/server configuration, the following procedures should be performed on the IMSMA '''server'''. }}
 
 
{{note| If you are running IMSMA in a networked environment, the following procedures should be performed on the IMSMA server
 
}}
 
 
   
 
   
To restore IMSMA data:
+
To restore IMSMA data on the server:
 
<ol>
 
<ol>
<li>Before beginning the restoration process, verify that the IMSMA server and all IMSMA clients have been shut down.</li>
+
<li>Are your '''really''' sure that you would like to write over the existing database on the server?</li>
 +
<li>Do you have backup that contains all '''attachments'''?</li>
 +
<li>Before beginning the restoration process, verify that the {{IMSMANG}} server, all IMSMA clients and all connections to the {{IMSMANG}} database from e.g. Navicat have been disconnected.</li>
 
<li>If the IMSMA Control Centre icon is not already displayed in the lower, right corner of your Window’s desktop, double-click the IMSMA Tray Launcher icon on your computer’s desktop.</li>
 
<li>If the IMSMA Control Centre icon is not already displayed in the lower, right corner of your Window’s desktop, double-click the IMSMA Tray Launcher icon on your computer’s desktop.</li>
 
<li>Right-click the IMSMA Control Centre icon that is displayed in the lower, right corner of your Window’s desktop.</li>
 
<li>Right-click the IMSMA Control Centre icon that is displayed in the lower, right corner of your Window’s desktop.</li>
<li>Select the IMSMA Backup and Restore option.</li>
+
[[Image:Backup Restore menu.png|center]]
<li>Select the Start Restore option.</li>
+
<li>Select '''Restore'''.</li>
:The IMSMA Restore window displays.
+
 
</ol>
+
[[Image:Restore.png|center|400px|''IMSMA Restore window'']]
[[Image:fig186.png|center|500px|''Figure 186. IMSMA Restore window'']]
 
 
<div align="center">
 
<div align="center">
 
''IMSMA Restore window''
 
''IMSMA Restore window''
 
</div>
 
</div>
  
<ol start = "7">
+
<li>In the IMSMA Restore window, click the [[Image:DestDir.png]] button.</li>
<li>Click the [[Image:DestDir.png]] button.</li>
+
<li>The Open window displays.</li>
:The Open window displays.
 
<li>From the Open window:</li>
 
<ol type="a">
 
 
<li>Navigate to the directory from which you would like to restore your IMSMA data.</li>
 
<li>Navigate to the directory from which you would like to restore your IMSMA data.</li>
 +
<li>Click the '''Open''' button.</li>
 +
<li>The path of the folder displays in the ''Select the directory you want to restore from'' field.</li>
 +
 +
[[Image:Restore2.png|center|400px|''IMSMA Restore window'']]
 +
<div align="center">
 +
''IMSMA Restore window''
 +
</div>
  
{{note| When selecting the directory from which you would like to restore your IMSMA data, be sure to select the directory that is named with the date and time the backup was performed
+
<li>In the '''Include the Following''' section, each available component in the backup folder is marked with [[Image:CheckedBoxIcon.png]]. Uncheck the checkbox next to each component you do not want to restore.</li>
}}
 
  
<li>Click the Open button.</li>
+
{{Note | Components that are disabled were not included in the IMSMA backup that you selected to restore. If you do not check any components, only the IMSMA database and any attachments will be restored.  }}
:The name of the directory displays in the Select the directory you want to restore from field.
+
{{Warning | If the backup folder that you are about to restore contains the folder Backup_YYYY_MM_DD_HH_MM_SS\server\attachments then all your existing '''attachments''' on the server will be '''deleted''' and replaced with what is in Backup_YYYY_MM_DD_HH_MM_SS\server\attachments. This behaviour also applies when Backup_YYYY_MM_DD_HH_MM_SS\server\attachments is empty.}}
</ol>  
+
<li>Click the '''Restore''' button.</li>  
<li>In the Include the Following section, each item that is available to be restored is checked by default. Uncheck the checkbox ([[Image:CheckedBoxIcon.png]]) next to each item you do not want to restore.</li>
+
<li>First the files outside of the database will be restored and at 20% the IMSMA Restore will ask for the password.</li>
:Items that are disabled were not backed up to the file you selected to restore and cannot be included. If you do not check any items, only the IMSMA database will be restored.
+
{{Note| It is possible to change the database password with SQL software. Note that ''C:\IMSMAng\trayLauncher\TrayLauncher.properties'' also needs to be updated.}}
<li>Click the Restore button.</li>  
+
<li>Enter the database password.  
:A window displays one of the messages listed in Table.
+
[[Image:Imsma pwd2.png|center|400px]]</li>
 +
<li>Click the '''OK''' button.</li>
 +
<li>The IMSMA Restore will continue and now the database is restored from the backup.</li>
 +
[[Image:Restore3.png|center|400px]]</li>
 +
<li>The attachments will be restored at 90%.</li>
 +
[[Image:Restore4.png|center|400px]]</li>
 +
<li>Click the '''OK''' button.
 +
[[Image:Restore confirm.png|center|250px]]</li>
 +
<li>The IMSMA Control Centre closes. The IMSMA Control Centre needs to be closed because the IMSMA database restored may be of an earlier version than the current version of the IMSMA application and therefore needs to be upgraded to the same version as the IMSMA application.</li>
 +
</ol>
  
<center>
+
{{Warning | It is not possible to upgrade a database of version 1 - 5.08.04 by restoring it with version 6.0. Contact your [[Information Management Team | GICHD IM advisor]] if you would like to upgrade a database of version 1 - 5.08.04 to version 6.0.}}
{| class="wikitable" width="500"
+
 
 +
 
 +
If you see these messages, your computer is configured as an IMSMA client and it is not possible to restore the database.
 +
{| class="wikitable"
 
|-
 
|-
| align="center" colspan="2" | '''Table 53. Backup File Descriptions'''
+
| [[Image:Client restore database error.png|center|400px]]
|-
+
| [[Image:Client restore confirm.png|center|400px]]
| width="125pt" | '''Backup File'''
 
| width="375pt" | '''Description'''
 
|-
 
| GIS Database || Contains all the GIS data such as map icons and their locations that appear in the map display. The file is located in the IMSMA_HOME\client\gis\sandbox\[active map]\map directory folder.
 
|-
 
| Map Data || Contains all the background geographical information (for example, rivers) that appears in the map display. The file is located in the IMSMA_HOME\server\gis\maps\[active map] folder.
 
|-
 
| Form Template || Contains unpublished field report templates that were created using the Form Designer and saved on the local computer. The file is located in the IMSMA_HOME\client\FormTemplates\MyTemplates folder.
 
|-
 
| Report Template || Contains unpublished report templates that were created using the External Reporting Tool (iReport) and saved on the local computer. The file is located in the IMSMA_HOME\iReport\IMSMA Reports folder.
 
|-
 
| Translations || Contains the ITerms_XX.properties, IMessage_XX.properties, and UIString_XX.properties files. The files are located in the IMSMA_HOME\client\resources\com\fgm\imsma\lexicon directory and the IMSMA_HOME\client\resources\com\fgm\util directory.
 
 
|}
 
|}
</center>
 
 
If you see this message
 
It means
 
Please enter Password
 
Continue to the next step.
 
No action taken. Database restore can only be performed on the Server.
 
The IMSMA database can only be restored on the server and your computer is configured as a client, not a server. Although other data can be restored on a client computer, you requested to restore the IMSMA database only or no other data was available, so no data was restored. 
 
 
Restore Complete. Please note that the IMSMA database was not restored. Database restore can only be performed on the Server.
 
The IMSMA database can only be restored on the server and your computer is configured as a client, not a server. The other data you requested to restore has been restored, but the IMSMA database has not been restored.
 
  
 +
==SQL Views after restore==__NOEDITSECTION__
 +
Since the views may build on other views it is not possible to know in which order they should be restored. Therefore the Restore functionality restores the SQL views as tables and after the restore is complete convert them to SQL views. If you still see any of your SQL views as tables after the restore, there is something wrong with your SQL views. The most common errors are:
 +
* the SQL views are created / owned by another user than imsma
 +
* the SQL syntax is not correct
 +
* the SQL view is referring to another SQL view that does not exist anymore.
  
<li>Enter the database password.</li>
+
{{NavBox Manage Information}}
<li>Click the OK button.</li>
 
:Your IMSMA data is restored from the backup. When the restore completes, a message window displays.
 
<li>Click the OK button. </li>
 
:The message window closes and the tray launcher closes.
 
</ol>
 
  
{{NavBox How To Backup}}
+
[[Category:NAA]]

Latest revision as of 09:34, 17 December 2017

Note.jpg If you are running IMSMA in a client/server configuration, the following procedures should be performed on the IMSMA server.

To restore IMSMA data on the server:

  1. Are your really sure that you would like to write over the existing database on the server?
  2. Do you have backup that contains all attachments?
  3. Before beginning the restoration process, verify that the IMSMANG server, all IMSMA clients and all connections to the IMSMANG database from e.g. Navicat have been disconnected.
  4. If the IMSMA Control Centre icon is not already displayed in the lower, right corner of your Window’s desktop, double-click the IMSMA Tray Launcher icon on your computer’s desktop.
  5. Right-click the IMSMA Control Centre icon that is displayed in the lower, right corner of your Window’s desktop.
  6. Backup Restore menu.png
  7. Select Restore.
  8. IMSMA Restore window

    IMSMA Restore window

  9. In the IMSMA Restore window, click the DestDir.png button.
  10. The Open window displays.
  11. Navigate to the directory from which you would like to restore your IMSMA data.
  12. Click the Open button.
  13. The path of the folder displays in the Select the directory you want to restore from field.
  14. IMSMA Restore window

    IMSMA Restore window

  15. In the Include the Following section, each available component in the backup folder is marked with CheckedBoxIcon.png. Uncheck the checkbox next to each component you do not want to restore.
  16. Note.jpg Components that are disabled were not included in the IMSMA backup that you selected to restore. If you do not check any components, only the IMSMA database and any attachments will be restored.
    Warning.jpg If the backup folder that you are about to restore contains the folder Backup_YYYY_MM_DD_HH_MM_SS\server\attachments then all your existing attachments on the server will be deleted and replaced with what is in Backup_YYYY_MM_DD_HH_MM_SS\server\attachments. This behaviour also applies when Backup_YYYY_MM_DD_HH_MM_SS\server\attachments is empty.
  17. Click the Restore button.
  18. First the files outside of the database will be restored and at 20% the IMSMA Restore will ask for the password.
  19. Note.jpg It is possible to change the database password with SQL software. Note that C:\IMSMAng\trayLauncher\TrayLauncher.properties also needs to be updated.
  20. Enter the database password.
    Imsma pwd2.png
  21. Click the OK button.
  22. The IMSMA Restore will continue and now the database is restored from the backup.
  23. Restore3.png
  24. The attachments will be restored at 90%.
  25. Restore4.png
  26. Click the OK button.
    Restore confirm.png
  27. The IMSMA Control Centre closes. The IMSMA Control Centre needs to be closed because the IMSMA database restored may be of an earlier version than the current version of the IMSMA application and therefore needs to be upgraded to the same version as the IMSMA application.
Warning.jpg It is not possible to upgrade a database of version 1 - 5.08.04 by restoring it with version 6.0. Contact your GICHD IM advisor if you would like to upgrade a database of version 1 - 5.08.04 to version 6.0.


If you see these messages, your computer is configured as an IMSMA client and it is not possible to restore the database.

Client restore database error.png
Client restore confirm.png

SQL Views after restore

Since the views may build on other views it is not possible to know in which order they should be restored. Therefore the Restore functionality restores the SQL views as tables and after the restore is complete convert them to SQL views. If you still see any of your SQL views as tables after the restore, there is something wrong with your SQL views. The most common errors are:

  • the SQL views are created / owned by another user than imsma
  • the SQL syntax is not correct
  • the SQL view is referring to another SQL view that does not exist anymore.