Difference between revisions of "Backup IMSMA Data"

From IMSMA Wiki
Jump to: navigation, search
 
(8 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
{{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. }}
+
{{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:
Line 7: Line 7:
 
<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>
 
[[Image:Backup Restore menu.png|center]]
 
[[Image:Backup Restore menu.png|center]]
−
<li>Select '''Backup'''.
+
<li>Select '''Backup'''.</li>
  
 
[[Image:Backup.png|center|400px|''IMSMA Backup window'']]
 
[[Image:Backup.png|center|400px|''IMSMA Backup window'']]
 
<div align="center">
 
<div align="center">
 
''IMSMA Backup window''
 
''IMSMA Backup window''
−
</div></li>
+
</div>
  
 
<li>In the IMSMA Backup window, click the [[Image:DestDir.png]] button next to the Destination Directory field. The Open window displays.</li>
 
<li>In the IMSMA Backup window, click the [[Image:DestDir.png]] button next to the Destination Directory field. The Open window displays.</li>
Line 18: Line 18:
 
* Navigate to the folder to which you would like to save the backup files.
 
* 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.  
 
* 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.
+
* 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>
 
* 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 will be backed up. See the following table for a description of the type of information that is backed up with each file.
+
<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>
  
 
<center>
 
<center>
Line 30: Line 30:
 
| width="675pt" | '''Description'''
 
| width="675pt" | '''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 ''C:\IMSMAng\client\gis\sandbox\[active map]\map'' folder.   
+
| 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.  
+
| 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 created using the Template Designer and saved in the ''C:\IMSMAng\client\FormTemplates\MyTemplates'' folder.
+
| 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.
 
| Report Template || iReport templates that were saved in the ''C:\IMSMAng\iReport\ireport\templates'' folder.
Line 44: Line 44:
 
<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>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>
 
<li>Click the '''Backup''' button.</li>
−
<li>Enter the database password.<br />
+
{{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'']]
 
[[Image:Imsma pwd.png|center|300px|''Enter the password'']]
 
<div align="center">
 
<div align="center">
 
''Enter the password''
 
''Enter the password''
−
</div></li>
+
</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>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>
 +
 
 +
 
 
[[Image:Backup_completed.png|center|500px|''Backup went well'']]
 
[[Image:Backup_completed.png|center|500px|''Backup went well'']]
 
<div align="center">
 
<div align="center">
 
''Backup went well''
 
''Backup went well''
−
</div></li>
+
</div>
 
<li>Click the '''Close''' button.</li>
 
<li>Click the '''Close''' button.</li>
−
<li>Verify the result of the backup.
+
<li>Verify the result of the backup.</li>
  
 
[[Image:Backup_result.png|center|500px|''Verify that the backup went well'']]
 
[[Image:Backup_result.png|center|500px|''Verify that the backup went well'']]
 
<div align="center">
 
<div align="center">
 
''Is the expected result there?''
 
''Is the expected result there?''
−
</div></li></ol>
+
</div>
 +
</ol>
  
 
==Errors during backup==
 
==Errors during backup==
Line 72: Line 76:
 
The most common reasons why the backup did not go well are:
 
The most common reasons why the backup did not go well are:
 
* the password was mistyped
 
* the password was mistyped
−
* there was not enough pace in the specified folder
+
* there was not enough space in the specified folder
 
* the user did not have permission to write to the specified folder
 
* the user did not have permission to write to the specified folder
  
Line 82: Line 86:
 
</div>
 
</div>
  
−
{{NavBox How To Backup}}
+
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:ELR]]
+
[[Category:NAA]]

Latest revision as of 09: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"