In Multi-User mode, it is important that the Essential Architecture Manager repository is backed up regularly. The repository operates in an on-line mode (where each update to the model is captured as it is made), so it is recommended that regular snapshots of the repository are taken. This articles describes the elements of the repository that should be backed up and how this can be performed.

In the event of a significant error occurring in the repository, e.g. a bad import process from an external repository, these snapshots can be used to restore the repository to a previously known-good state.

Elements to backup

In a Multi-User installation, the following system components should be backed up (/EssentialAM/Repository is used as the default installation location of the repository, but should be inter-changed with your actual installation location):

• Live repository configuration
  • /EssentialAM/Repository//.pprj
• Live Repository database backups (see section below)
  • /EssentialAM/Repository/Backups/Database
• Essential Viewer reports
  • /Apache Software Foundation/Tomcat5.5/webapps/essential_viewer
    
• Essential Architecture Manager metaproject
  • /EssentialAM/Repository/metaproject.pprj, metaproject.pont and metaproject.pins
    
  • OR /examples/server/metaproject.pprj, metaproject.pont and metaproject.pins
• Repository Change History (if using the Changes Tab / Collaborative Protege)
  • /EssentialAM/Repository//annotations_.pprj 
    
  • /EssentialAM/Repository//annotations_.rdf
    
  • /EssentialAM/Repository//annotations_.rdfs

These elements should be covered by some form of off-line backup, e.g. to tape, for use should the physical server fail.

Database Backups

The following backup jobs should be defined for the database that is storing the Essential Architecture Manager repository

• Daily at, e.g. 22:00hrs
  • Output to: /EssentialAM/Repository/Backups/Database
• Regular snapshot backups, e.g. 2-hourly
  • Output to: /EssentialAM/Repository/Backups/Database/Hours

Repository Configuration Project Backups

The repository configuration is file-based. The following backup scripts/jobs should be implemented, either

• using Windows scheduled tasks to backup the repository configuration project files, OR
  
• using cron jobs on Unix-based platforms.

Example Windows VBS scripts for these can be found in Server Backup Scripts. These will need to be tailored for your particular installation and can be used as a template for appropriate Unix shell scripts.

• Backup the repository configuration file, e.g. at 22:01hrs (after the Database backup)
  • Output to: /EssentialAM/Repository/Backups
  • Windows task scheduler execution command:

cscript //nologo \EssentialAM\Scripts\backupRepositoryProjectDaily.vbs

• Regular snapshot backups, e.g. 2-hourly
  • Output to: /EssentialAM/Repository/Backups/Hours
  • Windows task scheduler execution command:

cscript //nologo \EssentialAM\Scripts\backupRepositoryProjectHourly.vbs

Housekeeping Scripts

To manage the backup files that are created by the above sections, a set of house keeping scripts have been defined to manage the output database back up files. A set of these for Windows VBS to be scheduled using Windows Scheduled Tasks are available in Housekeeping Scripts. These will need to be tailored for your particular installation and can be used as a template for appropriate Unix shell scripts. These scripts should be located in the following directory:

• /EssentialAM/Scripts/
  

Scripts should be defined to:

• Run daily to purge backup files older than 31 days
  • manageDailyBackups.vbs
  • Windows execution command:

cscript //nologo \EssentialAM\Scripts\manageDailyBackups.vbs

• Run daily to purge hourly snapshot backup files older than 1 day
  • manageHourlyBackups.vbs
  • Windows execution command:

cscript //nologo \EssentialAM\Scripts\manageDailyBackups.vbs