Difference between revisions of "Backup and Restore"

From IMSMA Wiki
Jump to: navigation, search
 
(12 intermediate revisions by 2 users not shown)
Line 11: Line 11:
 
*{{IMSMANG}}-specific backups
 
*{{IMSMANG}}-specific backups
  
−
Moreover, a backup is only as good as the ability to restore it. As such, any data backup strategy should include plans to test existing backups to ensure that the backups are usable. If it becomes necessary to restore data, regular testing of backups helps ensure that it will be possible to do so.
+
Moreover, a backup is only as if you are able to restore it. As such, any data backup strategy should include plans to test existing backups to ensure that the backups are usable. If it becomes necessary to restore data, regular testing of backups helps ensure that it will be possible to do so.
  
 
Note that an event-based change to the components necessitates a backup '''before''' and '''after''' the change. Event-based changes include events such as:
 
Note that an event-based change to the components necessitates a backup '''before''' and '''after''' the change. Event-based changes include events such as:
−
 
 
* upgrading any software on the server
 
* upgrading any software on the server
 
* importing data and/or Data Entry Forms
 
* importing data and/or Data Entry Forms
 
* changing SQL views in the database.
 
* changing SQL views in the database.
−
 
−
Following is a list of {{IMSMANG}} components that should be backed up.
 
−
*{{IMSMANG}} database
 
−
*Attachments
 
−
*GIS database
 
−
*Maps
 
−
*Templates
 
−
*Translation
 
  
 
===Backing Up the {{IMSMANG}} Database===__NOEDITSECTION__
 
===Backing Up the {{IMSMANG}} Database===__NOEDITSECTION__
Line 33: Line 24:
 
{{HowTo's
 
{{HowTo's
 
|[[Backup IMSMA Data|Backup IMSMA Data]]
 
|[[Backup IMSMA Data|Backup IMSMA Data]]
 +
|[[Scheduling Backup|Scheduling Backup of IMSMA database]]
 
}}
 
}}
−
Information managers can scheduled backups using PGSQL Administration tools, for example, and build daily or weekly routines that back up the database automatically. These backups work similarly to {{IMSMANG}} Backup; however, any backup made outside of {{IMSMANG}} will have to be restored manually. Even so, regularly scheduled backups are an excellent component of a backup strategy.
 
  
−
{{note| In a client/server configuration, backups should be made from the server rather than the clients. Similarly, backups can only be restored on the {{IMSMANG}} server
+
Information managers can schedule backups using PGSQL Administration tools and build daily or weekly routines that back up the database automatically. These backups work similarly to {{IMSMANG}} Backup; however, any backup made outside of {{IMSMANG}} will have to be restored manually. Even so, regularly scheduled backups are an excellent component of a backup strategy.
−
}}
+
 
 +
{{note| In a client/server configuration, backups should be made from the server rather than the clients. Similarly, backups can only be restored on the {{IMSMANG}} server.}}
  
 
===Attachments===__NOEDITSECTION__
 
===Attachments===__NOEDITSECTION__
−
{{IMSMANG}} stores attachments on the server file system separate from the {{IMSMANG}} database. Because of the total file size of the attachments, it may not be beneficial or necessary to back up the attachments each time. {{IMSMANG}} Backup provides the option to exclude attachments when performing a backup.
+
{{IMSMANG}} stores attachments on the server file system separate from the {{IMSMANG}} database. Because of the total file size of the attachments, it may not be beneficial or necessary to back up the attachments each time. {{IMSMANG}} Backup provides the option to exclude attachments when performing a backup which is '''not''' recommended.
  
−
For regular, complete backups, it is highly recommended to include attachments. It is also possible to take an IMSMA backup of the database and a file backup of the attachments. Excluding attachments from the backup routine is not recommended.
+
For regular, complete backups, it is highly recommended to include attachments. It is also possible to take an IMSMA backup of the database and a file backup of the attachments.
  
−
===Backing Up Other {{IMSMANG}} Information===__NOEDITSECTION__
+
===GIS Database===__NOEDITSECTION__
−
In addition to the {{IMSMANG}} database and attachments stored on the server, {{IMSMANG}} Backup allows users to back up certain settings from the {{IMSMANG}} client. These include:
+
While {{IMSMANG}} stores all coordinate data in the PGSQL database that is backed up with the {{IMSMANG}} database, {{IMSMANG}} also uses a geodatabase file (IMSMA.gdb), also known as the sandbox, to display the data in the Map Pane inside {{IMSMANG}}. These files should be included with each {{IMSMANG}} backup to shorten the time it takes to launch {{IMSMANG}} after a restore. {{IMSMANG}} automatically rebuilds the sandbox during launch of the {{IMSMANG}} if the sandbox is missing, but it can take several hours to do so. After it is backed up, the sandbox can be transferred manually to other freshly installed clients to shorten the time required to build the geodatabase during system launch.
−
 
−
* GIS database (file based geodatabase)
 
−
* map files (.mxd, etc.)
 
−
* Data Entry Form template files (not published versions)
 
−
* iReport template files (not published versions)
 
−
* translation files (.properties files)
 
−
 
−
====GIS Database====__NOEDITSECTION__
 
−
While {{IMSMANG}} stores all coordinate data in the PGSQL database that is backed up with the {{IMSMANG}} database, {{IMSMANG}} also stores coordinate data in a geodatabase file (file based) on each client computer to allow data to be displayed on the map. These files should be included with each {{IMSMANG}} backup to shorten the time it takes to launch {{IMSMANG}} after a restore. {{IMSMANG}} automatically rebuilds this file during system launch if the file is missing, but it can take several hours to do so.
 
  
−
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. After it is backed up, the geodatabase can be transferred manually to other freshly installed clients to shorten the time required to build the geodatabase during system launch.
+
===Maps===__NOEDITSECTION__
 +
{{IMSMANG}} map files can be loaded on a per-client basis and stored in {{IMSMANG}} Backup, providing an easy way to share maps between clients. In Map Data is also the [[Customise Sub-Themes | sub-theme]] assignments included.
  
−
====Maps====__NOEDITSECTION__
+
===Data Entry Form Templates and iReport Templates===__NOEDITSECTION__
−
{{IMSMANG}} map files can be loaded on a per-client basis and stored in {{IMSMANG}} Backup, providing an easy way to share maps between clients.
 
−
 
 
−
{{note| {{IMSMANG}} Backup backs up only the active map on each client. Other maps previously loaded on a client will need to be copied manually.
 
−
}}
 
−
 
 
−
====Data Entry Form Templates and iReport Templates====__NOEDITSECTION__
 
 
{{IMSMANG}} provides the capability to store copies of drafts of Data Entry Form templates and iReport templates to the file system during report design. While the published versions of the templates are backed up as part of the {{IMSMANG}} database backup, the files are only included if the option is selected on the {{IMSMANG}} Backup window. Storing these files in the backup is recommended as it makes it easier to resume drafting templates and reports.
 
{{IMSMANG}} provides the capability to store copies of drafts of Data Entry Form templates and iReport templates to the file system during report design. While the published versions of the templates are backed up as part of the {{IMSMANG}} database backup, the files are only included if the option is selected on the {{IMSMANG}} Backup window. Storing these files in the backup is recommended as it makes it easier to resume drafting templates and reports.
  
−
====Translations====__NOEDITSECTION__
+
===Translations===__NOEDITSECTION__
 
{{IMSMANG}} stores translations of the application in several places. Translations and localisations of data elements are stored in the {{IMSMANG}} database and are backed up with the database backup. The .properties files used to translate the {{IMSMANG}} interface are stored externally to the database, but they can be added to the {{IMSMANG}} Backup as an option. If changes are made to the .properties files, it is recommended to back them up after each change as well as each time a full backup is made.
 
{{IMSMANG}} stores translations of the application in several places. Translations and localisations of data elements are stored in the {{IMSMANG}} database and are backed up with the database backup. The .properties files used to translate the {{IMSMANG}} interface are stored externally to the database, but they can be added to the {{IMSMANG}} Backup as an option. If changes are made to the .properties files, it is recommended to back them up after each change as well as each time a full backup is made.
  
−
===Other Backup Considerations===__NOEDITSECTION__
+
==Other Backup Considerations==__NOEDITSECTION__
−
While {{IMSMANG}} Backup backs up all of the files used in the typical operation of {{IMSMANG}}, there are other customisable files that should also be backed up. These include:
+
While {{IMSMANG}} Backup backs up all of the files used in the standard configuration of {{IMSMANG}}, there are other files that should also be backed up and/or carefully documented.  
  
−
* non-standard projection files
+
* client and server '''settings''' including memory settings
−
* map customisations
+
* C:\IMSMAng\server\gis\maps\imsma.mxd (if customized)
−
{{IMSMANG}} does not automatically back up customisations made to maps used in {{IMSMANG}}. Users can make changes to the imsma.mxd file, create or modify ESRI style files, add symbology or make many other changes to maps, but these files are not included in the {{IMSMANG}} Backup and must be separately backed up and managed.
+
* the background map(s) source files ('''not''' only the .mxd file)
−
* base maps
+
* local projection files (.prj)
−
It is recommended that information managers make backups of maps that are imported into {{IMSMANG}} for use on client computers. While {{IMSMANG}} Backup backs up the maps when they have been imported, these base map files are not managed within {{IMSMANG}} and should be backed up manually to allow for customisation and later import.
+
* C:\IMSMAng\migration\conf\migration.properties and any import scripts
−
* external reporting tools
+
* [[Language and Translations#Data language|fallback fonts]] (C:\IMSMAng\java\lib\fonts\fallback)
−
External reporting tools and other add-ons are not backed up by {{IMSMANG}} and should be backed up manually. These include any tools using ODBC connections to {{IMSMANG}} such as Microsoft Access databases, Microsoft Excel spreadsheets, OpenOffice connections and Crystal Reports. Information managers should ensure that these tools get backed up manually or automatically.
+
* ODBC configurations
 +
* External tools
 +
: External reporting tools and other add-ons are not backed up by {{IMSMANG}} and information managers should ensure that these external tools are backed up manually.  
  
 
==IMSMA Restore==__NOEDITSECTION__
 
==IMSMA Restore==__NOEDITSECTION__
−
 
+
{{Warning| {{IMSMANG}} Restore replaces all data in the {{IMSMANG}} database and copy over existing files. Prior to restoring the {{IMSMANG}} database, information managers should ensure that all necessary data has been backed up. {{IMSMANG}} Restore operations cannot be undone.}}
−
{{Warning| {{IMSMANG}} Restore replaces all data in the {{IMSMANG}} database and may copy over existing files. Prior to restoring the {{IMSMANG}} database, information managers should ensure that all necessary data has been backed up. {{IMSMANG}} Restore operations cannot be undone
+
{{HowTo's
 +
| [[Restore IMSMA Backup on Server]]
 +
|[[Restore IMSMA Backup on Client]]
 
}}
 
}}
−
 
+
Backups created using {{IMSMANG}} Backup should be restored using {{IMSMANG}} Restore. {{IMSMANG}} Restore allows users to determine which components of an {{IMSMANG}} Backup to restore. The components available depend on the options that were selected during backup. Each option behaves slightly differently depending on whether the restore is occurring on a server or a client.
−
Backups created using {{IMSMANG}} Backup can be restored using {{IMSMANG}} Restore as well as other PGSQL tools if necessary. The {{IMSMANG}} Restore function can be used on both clients and servers to restore key information in the event of data loss or other restore needs (for example, after an  upgrade).
 
−
 
 
−
{{IMSMANG}} Restore allows users to determine which components of an {{IMSMANG}} Backup to restore. The components available depend on the options that were selected during backup. Each option behaves slightly differently depending on whether the restore is occurring on a server or a client.
 
  
 
===Restore on the Server===__NOEDITSECTION__
 
===Restore on the Server===__NOEDITSECTION__
 
In a client/server environment, the {{IMSMANG}} database can be restored only on the server machine so as to prevent accidental deletion of data by client users. Conducting an {{IMSMANG}} Restore on the server machine (or a stand-alone machine) restores the {{IMSMANG}} database and the available attachments to the server, replacing any existing data in the {{IMSMANG}} database. When a restore is complete, {{IMSMANG}} closes and must be restarted.  
 
In a client/server environment, the {{IMSMANG}} database can be restored only on the server machine so as to prevent accidental deletion of data by client users. Conducting an {{IMSMANG}} Restore on the server machine (or a stand-alone machine) restores the {{IMSMANG}} database and the available attachments to the server, replacing any existing data in the {{IMSMANG}} database. When a restore is complete, {{IMSMANG}} closes and must be restarted.  
  
−
{{IMSMANG}} Restore can also restore the GIS database, Data Entry Form templates, iReport templates, map files and translation .properties files; however, these are only necessary when running the client on the server or when running in stand-alone mode.
+
{{note| In a client/server environment, it is recommended to stop the server prior to restoring the database to ensure all clients are disconnected.}}
−
 
 
−
{{note| In a client/server environment, it is recommended to stop the server prior to restoring the database to ensure all clients are disconnected
 
−
}}
 
−
 
 
−
===Restore on the Client===__NOEDITSECTION__
 
−
Except for instances where the client and the server are on the same machine, the {{IMSMANG}} database cannot be restored to a client-only machine. However, {{IMSMANG}} Restore can be used to restore client settings including the GIS database, Data Entry Form templates, iReport templates, map files and translation .properties files. This functionality is particularly useful when connecting new clients to a server as this allows information managers to prebuild the GIS database and map configurations and simply restore them to the new clients.
 
−
{{HowTo's
 
−
|[[Restore IMSMA Data from a Backup|Restore IMSMA Data from a Backup]]
 
−
}}
 
−
On a client machine, {{IMSMANG}} Restore acts as a file copying function, copying files included in the backup to the correct location on the client. {{IMSMANG}} Restore also attempts to back up any files it is replacing. These backup directories have “_orig” appended to their file names to distinguish them from the new files.
 
−
 
 
−
{{Warning| {{IMSMANG}} Restore preserves only one backup of these files. Previous _orig directories are replaced with each {{IMSMANG}} Restore so care must be taken to preserve these files, if desired, prior to running {{IMSMANG}} Restore
 
−
}}
 
−
 
 
−
And because the client restore works as a file copy function, it is also possible to manually copy the desired files into the correct locations without running {{IMSMANG}} Restore. This can be a helpful shortcut when a full restore is not necessary.
 
  
−
{{NavBox Getting started with IMSMA}}
+
{{NavBox IMSMA NG Administration}}
  
−
[[Category:ELR]]
+
[[Category:NAA]]

Latest revision as of 15:49, 29 May 2017

Backing Up And Restoring Data

The most important aspect of maintaining a properly functioning IMSMANG system is backing up and restoring data. Regular data backups are essential for maintaining the integrity of the system in case of sytem failure, software errors or accidental data deletion. Not only should information managers mandate that all IMSMANG data is regularly backed up, but more importantly a multitiered backup strategy should be used to eliminate data loss. Consider the following options below when developing a backup strategy for IMSMANG.

  • disk mirroring
  • operating system backups
  • hard disk backup
  • offsite data storage
  • IMSMANG-specific backups

Moreover, a backup is only as if you are able to restore it. As such, any data backup strategy should include plans to test existing backups to ensure that the backups are usable. If it becomes necessary to restore data, regular testing of backups helps ensure that it will be possible to do so.

Note that an event-based change to the components necessitates a backup before and after the change. Event-based changes include events such as:

  • upgrading any software on the server
  • importing data and/or Data Entry Forms
  • changing SQL views in the database.

Backing Up the IMSMANG Database

By far, the most critical component to backup is the IMSMANG database itself because it contains all of the actual data in IMSMANG and published templates, etc. IMSMANG’s Backup capability backs up the IMSMANG database by executing a PGSQL database dump command that creates a complete backup of all of the data in the database. The resulting dump.sql file, which is stored in a time-stamped directory for easy identification.

Note.jpg The dump.sql file is stored in text format and can be made smaller for storage using compression tools such as WinZIP.
How To

Information managers can schedule backups using PGSQL Administration tools and build daily or weekly routines that back up the database automatically. These backups work similarly to IMSMANG Backup; however, any backup made outside of IMSMANG will have to be restored manually. Even so, regularly scheduled backups are an excellent component of a backup strategy.

Note.jpg In a client/server configuration, backups should be made from the server rather than the clients. Similarly, backups can only be restored on the IMSMANG server.

Attachments

IMSMANG stores attachments on the server file system separate from the IMSMANG database. Because of the total file size of the attachments, it may not be beneficial or necessary to back up the attachments each time. IMSMANG Backup provides the option to exclude attachments when performing a backup which is not recommended.

For regular, complete backups, it is highly recommended to include attachments. It is also possible to take an IMSMA backup of the database and a file backup of the attachments.

GIS Database

While IMSMANG stores all coordinate data in the PGSQL database that is backed up with the IMSMANG database, IMSMANG also uses a geodatabase file (IMSMA.gdb), also known as the sandbox, to display the data in the Map Pane inside IMSMANG. These files should be included with each IMSMANG backup to shorten the time it takes to launch IMSMANG after a restore. IMSMANG automatically rebuilds the sandbox during launch of the IMSMANG if the sandbox is missing, but it can take several hours to do so. After it is backed up, the sandbox can be transferred manually to other freshly installed clients to shorten the time required to build the geodatabase during system launch.

Maps

IMSMANG map files can be loaded on a per-client basis and stored in IMSMANG Backup, providing an easy way to share maps between clients. In Map Data is also the sub-theme assignments included.

Data Entry Form Templates and iReport Templates

IMSMANG provides the capability to store copies of drafts of Data Entry Form templates and iReport templates to the file system during report design. While the published versions of the templates are backed up as part of the IMSMANG database backup, the files are only included if the option is selected on the IMSMANG Backup window. Storing these files in the backup is recommended as it makes it easier to resume drafting templates and reports.

Translations

IMSMANG stores translations of the application in several places. Translations and localisations of data elements are stored in the IMSMANG database and are backed up with the database backup. The .properties files used to translate the IMSMANG interface are stored externally to the database, but they can be added to the IMSMANG Backup as an option. If changes are made to the .properties files, it is recommended to back them up after each change as well as each time a full backup is made.

Other Backup Considerations

While IMSMANG Backup backs up all of the files used in the standard configuration of IMSMANG, there are other files that should also be backed up and/or carefully documented.

  • client and server settings including memory settings
  • C:\IMSMAng\server\gis\maps\imsma.mxd (if customized)
  • the background map(s) source files (not only the .mxd file)
  • local projection files (.prj)
  • C:\IMSMAng\migration\conf\migration.properties and any import scripts
  • fallback fonts (C:\IMSMAng\java\lib\fonts\fallback)
  • ODBC configurations
  • External tools
External reporting tools and other add-ons are not backed up by IMSMANG and information managers should ensure that these external tools are backed up manually.

IMSMA Restore

Warning.jpg IMSMANG Restore replaces all data in the IMSMANG database and copy over existing files. Prior to restoring the IMSMANG database, information managers should ensure that all necessary data has been backed up. IMSMANG Restore operations cannot be undone.
How To

Backups created using IMSMANG Backup should be restored using IMSMANG Restore. IMSMANG Restore allows users to determine which components of an IMSMANG Backup to restore. The components available depend on the options that were selected during backup. Each option behaves slightly differently depending on whether the restore is occurring on a server or a client.

Restore on the Server

In a client/server environment, the IMSMANG database can be restored only on the server machine so as to prevent accidental deletion of data by client users. Conducting an IMSMANG Restore on the server machine (or a stand-alone machine) restores the IMSMANG database and the available attachments to the server, replacing any existing data in the IMSMANG database. When a restore is complete, IMSMANG closes and must be restarted.

Note.jpg In a client/server environment, it is recommended to stop the server prior to restoring the database to ensure all clients are disconnected.
Installing IMSMANG
English
Français
Español
Customising IMSMANG
Manage Information
Information Exchange · Backup and Restore · Importing and Exporting
Retrieved from "http://mwiki.gichd.org:8090/mediawiki/index.php?title=Backup_and_Restore&oldid=23141"