Difference between revisions of "Backup IMSMA Data"

From IMSMA Wiki
Jump to: navigation, search
(Created page with "{{note| If you are running IMSMA in a networked environment, the following procedures should be performed on the IMSMA server }} To back up IMSMA data: 1. Before beginning th...")
 
 
(38 intermediate revisions by 6 users not shown)
Line 1: Line 1:
−
{{note| If you are running IMSMA in a networked environment, the following procedures should be performed on the IMSMA server
+
{{Note | Because the geodatabase is built on a per client basis, it is also recommended to launch the client on the server to fully update the geodatabase prior to backing it up. }}
−
}}
 
  
 
To back up IMSMA data:
 
To back up IMSMA data:
−
1. Before beginning the backup process, verify that the IMSMA server and all IMSMA clients have been shut down.  
+
<ol>
−
2. 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>Before beginning the backup process, verify that the {{IMSMANG}} server and all IMSMA clients have been stopped.</li>
−
3. Right-click the IMSMA Control Centre icon that is displayed in the lower, right corner of your Window’s desktop.
+
<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>
−
4. Select the IMSMA Backup and Restore option.
+
<li>Right-click the IMSMA Control Centre icon that is displayed in the lower, right corner of your Window’s desktop.</li>
−
5. Select the Start Backup option.
+
[[Image:Backup Restore menu.png|center]]
−
The IMSMA Backup window displays.
+
<li>Select '''Backup'''.</li>
−
 
−
Figure 185. IMSMA Backup window
 
−
6. Click the  button beside the Destination Directory field.
 
−
The Open window displays.
 
−
7. From the Open window:
 
−
a. Navigate to the directory to which you would like to save the backup files.
 
−
b. Click the Open button.
 
−
The name of the directory displays in the Destination Directory field.
 
−
8. In the Include in addition to IMSMA Database section, check the checkbox ( ) next to each item to back up.
 
−
If you do not check any items, only the IMSMA database will be backed up. See Table 53 on page 247 for a description of the type of information that is backed up with each file.
 
−
Table 53. Backup File Descriptions
 
  
−
Backup File
+
[[Image:Backup.png|center|400px|''IMSMA Backup window'']]
−
Description
+
<div align="center">
−
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. 
+
''IMSMA Backup window''
 +
</div>
  
−
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.
+
<li>In the IMSMA Backup window, click the [[Image:DestDir.png]] button next to the Destination Directory field. The Open window displays.</li>
 +
<li>From the Open window:
 +
* Navigate to the folder to which you would like to save the backup files.
 +
* Select a secure folder where there is enough space for the backup.
 +
* To store the backup on the same computer as the database is on, is '''not''' a secure place.
 +
* Click the ''Open'' button. The name of the folder displays in the Destination Directory field. </li>
 +
<li>In the ''Include in addition to IMSMA Database'' section of the Backup window, check the checkbox ([[Image:CheckedBoxIcon.png]]) next to each item to back up. If you do not check any items, only the IMSMA database and the attachments will be backed up. See the following table for a description of the type of information that is backed up with each file.</li>
  
−
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.
+
<center>
 +
{| class="wikitable" width="800"
 +
|-
 +
| align="center" colspan="2" | '''Backup File Descriptions'''
 +
|-
 +
| width="125pt" | '''Backup File'''
 +
| width="675pt" | '''Description'''
 +
|-
 +
| GIS Database || All the GIS data such as map symbols and their locations that appear in the Map pane. It is recommended to include this in the backup so the receiver of the backup does not need to rebuild the sandbox. The files are located in the ''C:\IMSMAng\client\gis\sandbox\[active map]\map'' folder. 
 +
|-
 +
| Map Data || All the files that builds up the background map of the '''active''' map display will be backup. The files are located in the ''C:\IMSMAng\server\gis\maps\[active map]'' folder. If there is sub-theme assignments also ''C:\IMSMAng\client\conf\UserPrefs.prop''s will be included.
 +
|-
 +
| Form Template || Data Entry Form templates that were saved in the ''C:\IMSMAng\client\FormTemplates\MyTemplates'' folder. Published templates are stored in the database.
 +
|-
 +
| Report Template || iReport templates that were saved in the ''C:\IMSMAng\iReport\ireport\templates'' folder.
 +
|-
 +
| Translations || The ITerms_XX.properties, IMessage_XX.properties and trans_XX.properties files. The files are located in the ''C:\IMSMAng\client\resources\com\fgm\imsma\lexicon'' folder.
 +
|}
 +
</center></li>
  
−
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.
+
<li>We '''never''' recommend to exclude the attachments but if you would like to reduce the size of the backup folder, you may select to back up the database without including attachments.</li>
 +
<li>Click the '''Backup''' button.</li>
 +
{{Note| It is possible to change the database password with SQL software.}}
 +
<li>Enter the database password.</li><br />
 +
[[Image:Imsma pwd.png|center|300px|''Enter the password'']]
 +
<div align="center">
 +
''Enter the password''
 +
</div>
 +
<li>Click the '''OK''' button. A copy of your data is saved to the specified destination directory in a folder named with ''Backup_current_date_and_time'' (e.g. Backup_2014_10_01_17_45_15). </li>
  
−
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.
 
  
 +
[[Image:Backup_completed.png|center|500px|''Backup went well'']]
 +
<div align="center">
 +
''Backup went well''
 +
</div>
 +
<li>Click the '''Close''' button.</li>
 +
<li>Verify the result of the backup.</li>
  
−
9. To reduce the size of the IMSMA database backup file, you can select to back up the database without including certain data attached to field reports such as audio, video, and other large files.
+
[[Image:Backup_result.png|center|500px|''Verify that the backup went well'']]
−
• If you do not want to back up the attachment data, check the Exclude Field Report Attachment data checkbox ( ).
+
<div align="center">
−
• If you want to back up the attachment data, leave the Exclude Field Report Attachment data checkbox unchecked ( ).
+
''Is the expected result there?''
−
10. Click the Backup button.
+
</div>
−
A window displays prompting you for the database password.
+
</ol>
−
11. Enter the database password.
+
 
−
12. Click the OK button.
+
==Errors during backup==
−
A copy of your data is saved to the specified destination directory in a directory named with the current date and time. When the backup completes, a message window displays.
+
{{Warning | If you see any error message during backup, it means that you do '''NOT''' have any backup of your database!}}
−
13. Click the OK button.
+
 
−
The message window closes.  
+
[[Image:Backup_error.png|center|500px|''The backup did '''not''' went well'']]
−
14. Close the IMSMA Backup / Restore window.
+
<div align="center">
 +
''The backup did '''not''' went well''
 +
</div>
 +
 
 +
The most common reasons why the backup did not go well are:
 +
* the password was mistyped
 +
* there was not enough space in the specified folder
 +
* the user did not have permission to write to the specified folder
 +
 
 +
In the details you will see more details on why the backup did not go well.
 +
 
 +
[[Image:Backup_error_detail.png|center|500px|''The backup did '''not''' went well'']]
 +
<div align="center">
 +
''Expand the error message by clicking on Show Detail''
 +
</div>
 +
 
 +
Example of another error message in the Console log:
 +
 
 +
''ava.lang.StringIndexOutOfBoundsException: String index out of range: -1''
 +
 
 +
This is an indication that something is not correct with e.g. '''[[IMSMA Client Configuration Tool | IMSMA Client variables]]''' or '''[[Environment Variables | Environment variables]]''' on the computer.
 +
 
 +
{{NavBox Manage Information}}
 +
 
 +
[[Category:NAA]]

Latest revision as of 10:24, 12 March 2019

Note.jpg Because the geodatabase is built on a per client basis, it is also recommended to launch the client on the server to fully update the geodatabase prior to backing it up.

To back up IMSMA data:

  1. Before beginning the backup process, verify that the IMSMANG server and all IMSMA clients have been stopped.
  2. 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.
  3. Right-click the IMSMA Control Centre icon that is displayed in the lower, right corner of your Window’s desktop.
    4. Backup Restore menu.png
  4. Select Backup.
    5. IMSMA Backup window

    IMSMA Backup window

  5. In the IMSMA Backup window, click the DestDir.png button next to the Destination Directory field. The Open window displays.
  6. From the Open window:
    • Navigate to the folder to which you would like to save the backup files.
    • Select a secure folder where there is enough space for the backup.
    • To store the backup on the same computer as the database is on, is not a secure place.
    • Click the Open button. The name of the folder displays in the Destination Directory field.
  7. In the Include in addition to IMSMA Database section of the Backup window, check the checkbox (CheckedBoxIcon.png) next to each item to back up. If you do not check any items, only the IMSMA database and the attachments will be backed up. See the following table for a description of the type of information that is backed up with each file.
    8. Backup File Descriptions
    Backup File Description
    GIS Database All the GIS data such as map symbols and their locations that appear in the Map pane. It is recommended to include this in the backup so the receiver of the backup does not need to rebuild the sandbox. The files are located in the C:\IMSMAng\client\gis\sandbox\[active map]\map folder.
    Map Data All the files that builds up the background map of the active map display will be backup. The files are located in the C:\IMSMAng\server\gis\maps\[active map] folder. If there is sub-theme assignments also C:\IMSMAng\client\conf\UserPrefs.props will be included.
    Form Template Data Entry Form templates that were saved in the C:\IMSMAng\client\FormTemplates\MyTemplates folder. Published templates are stored in the database.
    Report Template iReport templates that were saved in the C:\IMSMAng\iReport\ireport\templates folder.
    Translations The ITerms_XX.properties, IMessage_XX.properties and trans_XX.properties files. The files are located in the C:\IMSMAng\client\resources\com\fgm\imsma\lexicon folder.
  8. We never recommend to exclude the attachments but if you would like to reduce the size of the backup folder, you may select to back up the database without including attachments.
  9. Click the Backup button.
    10. Note.jpg It is possible to change the database password with SQL software.
  10. Enter the database password.

    11. Enter the password

    Enter the password

  11. Click the OK button. A copy of your data is saved to the specified destination directory in a folder named with Backup_current_date_and_time (e.g. Backup_2014_10_01_17_45_15).


    12. Backup went well

    Backup went well

  12. Click the Close button.
  13. Verify the result of the backup.
    14. Verify that the backup went well

    Is the expected result there?

Errors during backup

Warning.jpg If you see any error message during backup, it means that you do NOT have any backup of your database!
The backup did not went well

The backup did not went well

The most common reasons why the backup did not go well are:

  • the password was mistyped
  • there was not enough space in the specified folder
  • the user did not have permission to write to the specified folder

In the details you will see more details on why the backup did not go well.

The backup did not went well

Expand the error message by clicking on Show Detail

Example of another error message in the Console log:

ava.lang.StringIndexOutOfBoundsException: String index out of range: -1

This is an indication that something is not correct with e.g. IMSMA Client variables or Environment variables on the computer.

Information Exchange
Backup and Restore
Importing and Exporting
Retrieved from "http://mwiki.gichd.org:8090/mediawiki/index.php?title=Backup_IMSMA_Data&oldid=24210"