Edge Documentation

{{DISPLAYTITLE:Backup & Restore (2.0.x)}}
[[Category:AppBoard old]]
{{Note|The instructions on this page are for versions 2.0.x of AppBoard.  For versions 2.1.x of AppBoard, please see the [[appboard/old/backup_and_restore_2.1.x|Backup and Restore 2.1.x]] page.  For versions 2.2.x of AppBoard, please see the [[appboard/old/backup_and_restore|Backup and Restore 2.2.x]] page.}}


AppBoard/enPortal provides utilities for backing up and restoring system data and configuration settings.  This page details the commands and procedures for managing this aspect of the system.


==Backup==

There are several reasons that the AppBoard/enPortal administrator may need to create a backup of the system:


* Migrating a system from development to production, or from one physical location to another
* Upgrading the system to a newer version
* Creating a regular backup to have available in case the system ceases to function properly


In order to perform a backup, it is first helpful to understand the relevant file locations and commands.


===Backup File Locations===


{| class="wikitable"
|+ align="bottom"|''Backup File Locations''
|-
! Directory
! Description
|-
| <tt>/server/webapps/enportal/WEB-INF/xmlroot/server/content/</tt>
| XML files representing all of the stock (original) content that was installed into the AppBoard/enPortal database to provide the base system definitions and content.  Includes stock content for any Product Integration Modules (PIMs) that you have loaded into the system.
|-
| <tt>/server/webapps/enportal/WEB-INF/xmlroot/server/backup/</tt>
| The /backup/ directory is identical to the /content/ directory, except it also includes all of the changes you have made in the system.
|-
| <tt>/server/webapps/enportal/WEB-INF/xmlroot/appboard/</tt>
| Contains XML definitions for AppBoard data adapters and data sources.
|-
| <tt>/server/webapps/enportal/WEB-INF/appboard-archive.jar</tt>
| The AppBoard archive file, created by the Backup button in AppBoard Builder.
|}

===Backup Commands===


{| class="wikitable" border="1" style="background-color:#eeeeee;"
|+ align="bottom" style="color:#e76700;" |''Backup Commands''
|-
! width=150 | Command
! How To Run
! Result
|-
| XMLExport
| Log in to enPortal as administrator and select the Advanced / XMLExport menu item and then click "Start"<br><br>
- OR - <br><br>
Go to <tt>/server/webapps/enportal/WEB-INF/bin/</tt> and run:<br>
<tt>> portal xmlExport -uid administrator -pwd <i>adminpwd</i> -dmn System</tt>
| Creates the directory <tt>/server/webapps/enportal/WEB-INF/xmlroot/server/backup/</tt> containing XML definitions for all data in the system database.
|-
| FilesExport
| Go to <tt>/server/webapps/enportal/WEB-INF/bin/</tt> and run:<br>
<tt>> portal FilesExport -jar <i>yourJarFileName.jar</i></tt>
| Creates the enPortal archive file <tt>yourJarFileName.jar</tt>, containing backup copies of system license and configuration files.  Note, you can customize what files are included in this archive by editing the file <tt>/server/webapps/enportal/WEB-INF/config/export.properties</tt>.
|-
| Backup
| Log in to AppBoard Builder as administrator, select Settings, and click "Backup"
| Creates the AppBoard archive file <tt>/server/webapps/enportal/WEB-INF/appboard-archive.jar</tt>.  This is a compressed file containing the following directories of files:
* <tt>/data/</tt> - any data files stored locally under <tt>/server/webapps/enportal/WEB-INF/data/</tt>
* <tt>/groovy-script/</tt> - any groovy scripts under <tt>/server/webapps/enportal/WEB-INF/groovy-script/</tt>
* <tt>/h2/</tt> - database files for the embedded H2 database
* <tt>/stylesheets/</tt> - any style sheets under <tt>/server/webapps/enportal/WEB-INF/stylesheets/</tt>
* <tt>/xmlroot/appboard/</tt> - any adapter and config files under <tt>/server/webapps/enportal/WEB-INF/xmlroot/appboard/</tt>
|}


===How To Create a Backup===

Perform the following steps to create a full backup of AppBoard/enPortal:

# Execute the enPortal XMLExport
# Execute the enPortal FilesExport
# Execute the AppBoard Backup

After completing the above commands, copy the entire file system to the backup server.


==Restore==

The restore process enables you to install a new version of AppBoard/enPortal and restore your previous data and configurations.


===Restore File Locations===

{| class="wikitable" border="1" style="background-color:#eeeeee;"
|+ align="bottom" style="color:#e76700;" |''Restore File Locations''
|-
! Directory
! Description
|-
| <tt>/server/webapps/enportal/WEB-INF/xmlroot/server/</tt>
| Files in this directory are invoked whenever the AppBoard/enPortal application is started (by the startup command).  Any file in this directory that begins with "load" identifies sets of XML content to be loaded into the system database, which will be executed unless the file contains the ".disabled" or ".completed" extension.  When restoring the system, you must edit these filenames to control what content will get loaded into the database.
|-
| <tt>/server/webapps/enportal/WEB-INF/xmlroot/server/backup/</tt>
| This is the full system backup directory, which will be loaded at system startup if the load file "load_restore.txt" is not disabled.
|-
| <tt>/server/webapps/enportal/WEB-INF/xmlroot/appboard/</tt>
| Contains AppBoard configuration files, including the <tt>stacks.xml</tt> file with all of the Appboard visualization configurations.  XML files in the /adapters/ directory will load data adapters and data sources, unless the file contains the ".disabled" or ".completed" extension.
|}


===Restore Commands===


{| class="wikitable" border="1" style="background-color:#eeeeee;"
|+ align="bottom" style="color:#e76700;" |''Restore Commands''
|-
! width=150 | Command
! How To Run
! Result
|-
| DBReset
| Shut down the system, then go to <tt>/server/webapps/enportal/WEB-INF/bin/</tt> and run:<br>
<tt>> portal DBreset</tt>.  Enter "y" to reset the load files so the backup content will be loaded upon system startup.
| Clears all configuration data from the system database, so that the backup data can be re-loaded into the system.
|-
| LoadFileReset
| Go to <tt>/server/webapps/enportal/WEB-INF/bin/</tt> and run:<br>
<tt>> portal LoadFileReset</tt>
| Renames load files under <tt>/server/webapps/enportal/WEB-INF/xmlroot/server/backup/</tt>, to remove the completed extension.
|-
| FilesImport
| Go to <tt>/server/webapps/enportal/WEB-INF/bin/</tt> and run:<br>
<tt>> portal filesImport -jar <i>YourJarFileName</i></tt>
| Extracts saved configuration files from a jar file to the proper location in the current system.
|}


===How To Restore AppBoard/enPortal===

# On the previous system, run all of the backup commands
## XMLExport
## FilesExport
## Backup
# Stop AppBoard/enPortal.
# Steps needed for a new installation only:
## Install the new version of AppBoard/enPortal.
## Copy the directory <tt>/server/webapps/enportal/WEB-INF/xmlroot/server/backup/</tt> into the file system from the backup.
## Copy the enPortal archive jar file to the new file system and run FilesImport to import the enPortal configuration and license files on to the new installation.
## Copy the AppBoard archive jar file to the new file system and run FilesImport to import the AppBoard configuration files on to the new installation.
# Ensure that the file <tt>/server/webapps/enportal/WEB-INF/xmlroot/server/load_restore.txt</tt> does not have the ".disabled" extension.
# Copy all files from <tt>/server/webapps/enportal/WEB-INF/xmlroot/appboard/adapters-bk/</tt> to <tt>/server/webapps/enportal/WEB-INF/xmlroot/appboard/adapters/</tt>
# Run the DBReset command to clear out the system database (not needed for a new installation).
# Start AppBoard/enPortal