Difference between revisions of "Backup IMSMA Data"

From IMSMA Wiki
Jump to: navigation, search
Line 17: Line 17:
 
<li>From the Open window:</li>
 
<li>From the Open window:</li>
 
<ol type="a">
 
<ol type="a">
−
<li>Navigate to the directory to which you would like to save the backup files.</li>
+
<li>Navigate to the folder to which you would like to save the backup files.</li>
−
<li>Click the '''Open''' button.</li>
+
: Select a secure folder where there is enough space for the backup.
−
:The name of the directory displays in the Destination Directory field.  
+
: To store the backup on the same computer as the database is on, it '''not''' a secure place.
 +
<li>Click the ''Open'' button.</li>
 +
:The name of the folder displays in the Destination Directory field.  
 
</ol>
 
</ol>
−
<li>In the '''Include in addition to IMSMA Database''' section, check the checkbox ([[Image:CheckedBoxIcon.png]]) next to each item to back up.</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.</li>
 
:If you do not check any items, only the IMSMA database will be backed up. See the following table for a description of the type of information that is backed up with each file.
 
:If you do not check any items, only the IMSMA database will be backed up. See the following table for a description of the type of information that is backed up with each file.
 
</ol>
 
</ol>
Line 33: Line 35:
 
| width="375pt" | '''Description'''
 
| 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 Installation Directory''\client\gis\sandbox\[active map]\map directory folder.   
+
| GIS Database || All the GIS data such as map symbols and their locations that appear in the map display. The files are located in the ''IMSMA Installation Folder''\client\gis\sandbox\[active map]\map 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 Installation Directory''\server\gis\maps\[active map] folder.
+
| Map Data || All the background geographical information (for example, rivers) that appears in the map display. The files are located in the ''IMSMA Installation Folder''\server\gis\maps\[active map] folder.
 
|-
 
|-
−
| Form Template || Contains data entry form templates that were created using the Template Designer and saved on the local computer. The file is located in the ''IMSMA Installation Directory''\client\FormTemplates\MyTemplates folder.
+
| Form Template || Data entry form templates that were created using the Template Designer and saved in the ''IMSMA Installation Folder''\client\FormTemplates\MyTemplates folder.
 
|-
 
|-
−
| Report Template || Contains report templates that were created using the External Reporting Tool (iReport) and saved on the local computer. The templates are located in the ''IMSMA Installation Directory''\iReport\ireport\templates folder.
+
| Report Template || iReport templates that were saved in the ''IMSMA Installation Folder''\iReport\ireport\templates folder.
 
|-
 
|-
−
| Translations || Contains the ITerms_XX.properties and IMessage_XX.properties files. The files are located in the ''IMSMA Installation Directory''\client\resources\com\fgm\imsma\lexicon directory.
+
| Translations || The ITerms_XX.properties, IMessage_XX.properties and trans_XX.properties files. The files are located in the ''IMSMA Installation Folder''\client\resources\com\fgm\imsma\lexicon folder.
 
|}
 
|}
 
</center>
 
</center>
  
 
<ol start="8">
 
<ol start="8">
−
<li>To reduce the size of the IMSMA database backup file, you can select to back up the database without including certain data attached to data entry forms such as audio, video, and other large files.</li>
+
<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>
−
*If you ''do not'' want to back up the attachment data, check the '''Exclude Data Entry Form Attachment data''' checkbox ([[Image:CheckedBoxIcon.png]]).
 
−
*If you want to back up the attachment data, leave the '''Exclude Data Entry Form Attachment data''' checkbox unchecked ([[Image:UncheckedBoxIcon.png]]).
 
 
<li>Click the '''Backup''' button.</li>
 
<li>Click the '''Backup''' button.</li>
−
:A window displays prompting you for the database password.
+
[[Image:Imsma pwd.png|center|300px|''Enter the password'']]
 +
<div align="center">
 +
''Enter the password''
 +
</div>
 
<li>Enter the database password.</li>
 
<li>Enter the database password.</li>
 
<li>Click the '''OK''' button.</li>
 
<li>Click the '''OK''' button.</li>
−
:A copy of your data is saved to the specified destination directory in a directory named with the current date and time (e.g., Backup_{''date_time''}). When the backup completes, a message window displays.
+
:A copy of your data is saved to the specified destination directory in a folder named with the current date and time (e.g., Backup_{''date_time''}).  
 +
[[Image:Backup_completed.png|center|500px|''Backup went well'']]
 +
<div align="center">
 +
''Backup went well''
 +
</div>
 
<li>Click the '''Close''' button.</li>
 
<li>Click the '''Close''' button.</li>
−
:The message window closes.  
+
[[Image:Backup_result.png|center|500px|''Verify that the backup went well'']]
 +
<div align="center">
 +
''Is the expected result there?''
 +
</div>
 +
<li>Verify the result of the backup.
 
</ol>
 
</ol>
  
 +
{{Warning | If you see any error message during backup, it means that you do not have any backup of your database!}}
 +
<ol>
 +
[[Image:Backup_error.png|center|500px|''Verify that the backup went well'']]
 +
<div align="center">
 +
''Is the expected result there?''
 +
</div>
 +
 +
<li>
 
{{NavBox How To Backup}}
 
{{NavBox How To Backup}}
  
 
[[Category:ELR]]
 
[[Category:ELR]]

Revision as of 16:53, 24 October 2014

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. Select IMSMA Backup and Restore > Backup.
IMSMA Backup window

IMSMA Backup window

  1. In the IMSMA Backup window, click the DestDir.png button beside the Destination Directory field.
    2. The Open window displays.
  2. From the Open window:
    1. Navigate to the folder to which you would like to save the backup files.
      2. 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, it not a secure place.
    2. Click the Open button.
      3. The name of the folder displays in the Destination Directory field.
  3. 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.
    4. If you do not check any items, only the IMSMA database will be backed up. See the following table for a description of the type of information that is backed up with each file.
Backup File Descriptions
Backup File Description
GIS Database All the GIS data such as map symbols and their locations that appear in the map display. The files are located in the IMSMA Installation Folder\client\gis\sandbox\[active map]\map folder.
Map Data All the background geographical information (for example, rivers) that appears in the map display. The files are located in the IMSMA Installation Folder\server\gis\maps\[active map] folder.
Form Template Data entry form templates that were created using the Template Designer and saved in the IMSMA Installation Folder\client\FormTemplates\MyTemplates folder.
Report Template iReport templates that were saved in the IMSMA Installation Folder\iReport\ireport\templates folder.
Translations The ITerms_XX.properties, IMessage_XX.properties and trans_XX.properties files. The files are located in the IMSMA Installation Folder\client\resources\com\fgm\imsma\lexicon folder.
  1. 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.
  2. Click the Backup button.
    3. Enter the password

    Enter the password

  3. Enter the database password.
  4. Click the OK button.
    5. A copy of your data is saved to the specified destination directory in a folder named with the current date and time (e.g., Backup_{date_time}).
    Backup went well

    Backup went well

  5. Click the Close button.
    6. Verify that the backup went well

    Is the expected result there?

  6. Verify the result of the backup.
Warning.jpg If you see any error message during backup, it means that you do not have any backup of your database!
    Verify that the backup went well

    Is the expected result there?

  1. Template:NavBox How To Backup
Retrieved from "http://mwiki.gichd.org:8090/mediawiki/index.php?title=Backup_IMSMA_Data&oldid=17330"