Backup & Restore (2.1.x)

< appboard | old

The instructions on this page are for versions 2.1.x of AppBoard. For versions 2.0.x of AppBoard, please see the Backup and Restore 2.0.x page. For versions 2.2.x of AppBoard, please see the 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.


Page Contents

1. 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.


1.1. Backup File Locations

Backup File Locations
Directory Description
/server/webapps/enportal/WEB-INF/xmlroot/server/content/ XML files representing all of the stock (original) enPortal content that was installed into the 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. This directory is created the first time you start the system, by copying the default installation files from /server/webapps/enportal/WEB-INF/xmlroot/server/content-autoload/
/server/webapps/enportal/WEB-INF/xmlroot/server/content-backup/ The /content-backup/ directory is identical to the /content/ directory, except it also includes all of the changes you have made in the system. This directory is created when the XMLExport command is run by an administrator.
/server/webapps/enportal/WEB-INF/xmlroot/appboard/adapters/ XML files representing all of the stock (original) AppBoard content that was installed into the database to provide the base system definitions and content. This directory is created the first time you start the system, by copying the default installation files from /server/webapps/enportal/WEB-INF/xmlroot/appboard/adapters-autoload/
/server/webapps/enportal/WEB-INF/xmlroot/appboard/adapters-backup/ The /adapters-backup/ directory is identical to the /adapters/ directory, except it also includes all of the changes you have made in the system. This directory is created when the AppBoard Backup command is run by an administrator.
/server/webapps/enportal/WEB-INF/archive/archive-<DATE>.jar The backup / archive generated from the Backup page in enPortal or AppBoard.

1.2. How To Create a Backup

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

  1. Navigate to Advanced->Backup (enPortal) or Settings->Backup/Restore (AppBoard Builder).
  2. Select Create

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

2. Restore

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


2.1. Restore File Locations

Restore File Locations
Directory Description
/server/webapps/enportal/WEB-INF/xmlroot/server/ Files in this directory are invoked whenever the AppBoard/enPortal server is started (by the startup command). Any file in this directory that begins with "load" identifies sets of enPortal XML content to be loaded into the system database, which will be executed unless the file contains a ".disabled" or ".completed" extension. When restoring the system, you can edit these filenames to control what content will get loaded into the database.
/server/webapps/enportal/WEB-INF/xmlroot/server/content-backup/ This is the full system backup directory, which will be loaded at server startup if the load file /server/webapps/enportal/WEB-INF/xmlroot/server/load_restore.txt is not disabled.
/server/webapps/enportal/WEB-INF/xmlroot/server/content-autoload/ Any XML files in this directory, or any sub-directories, will be loaded into the system database the next time the server is started. The files will then be moved into /server/webapps/enportal/WEB-INF/xmlroot/server/content/.
/server/webapps/enportal/WEB-INF/xmlroot/appboard/ Files in this directory are invoked whenever the AppBoard/enPortal server is started (by the startup command). Any file in this directory that begins with "load" identifies sets of AppBoard XML content to be loaded into the system database, which will be executed unless the file contains a ".disabled" or ".completed" extension. When restoring the system, you can edit these filenames to control what content will get loaded into the database.
/server/webapps/enportal/WEB-INF/xmlroot/appboard/adapters-backup/ This is the AppBoard data sources and adapters backup directory, which will be loaded at server startup if the load file /server/webapps/enportal/WEB-INF/xmlroot/appboard/load_restore.txt is not disabled.
/server/webapps/enportal/WEB-INF/xmlroot/appboard/adapters-autoload/ Any XML files in this directory, or any sub-directories, will be loaded into the system database the next time the server is started. The files will then be moved into /server/webapps/enportal/WEB-INF/xmlroot/appboard/adapters/.


2.2. Restore Commands

Restore Commands
Command How To Run Result
DBReset Shut down the system, then go to /server/webapps/enportal/WEB-INF/bin/ and run:

> portal DBreset. 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.
FilesImport Go to /server/webapps/enportal/WEB-INF/bin/ and run:

> portal filesImport -jar YourJarFileName

Extracts saved configuration files from a jar file to the proper location in the current system.

2.3. How To Restore AppBoard/enPortal

  1. On the previous system, run the backup command to generate the appboard-archive.jar file
  2. Stop AppBoard/enPortal.
  3. Steps needed for a new installation only:
    1. Install the new version of AppBoard/enPortal.
    2. Copy the appboard-archive.jar file to the new file system under /server/webapps/enportal/WEB-INF/bin/appboard-archive.jar
    3. In a console, go to /server/webapps/enportal/WEB-INF/bin/ and run the following command to import the files on to the new installation:
    > portal FilesImport -jar appboard-archive.jar
  4. Ensure that the file /server/webapps/enportal/WEB-INF/xmlroot/server/load_restore.txt does not have the ".disabled" extension.
  5. Run the DBReset command to clear out the system database (not needed for a new installation).
  6. Start AppBoard/enPortal