Edge Documentation

The instructions on this page are for versions 2.2.x of AppBoard. For versions 2.1.x of AppBoard, please see Backup and Restore 2.1.x. For versions 2.0.x of AppBoard, please see Backup and Restore 2.0.x.

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

How To Create a Backup

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

1. On the original AppBoard system, log in to AppBoard as administrator
2. Under Builder Modes, select Settings
3. Under System Settings, select Backup
4. Click Create
5. Select Backup All and click Create Backup
6. Observe JAR file created in \server\webapps\enportal\WEB-INF\archive\

Restore

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

How To Restore AppBoard/enPortal

1. Shut down AppBoard
2. On the command line in the destination system, go to \server\bin\
3. Enter the command:

   Portal restore –jar ..\webapps\enportal\WEB-INF\archive\<name of backup jar file>

4. Enter “yes” to confirm replacing any existing content
5. Start AppBoard and confirm that the exported content was loaded successfully

The license file is included in the JAR file that is created by the backup. After executing a restore, you may need to manually replace the license file on the destination server with the appropriate file for that server.

If you are migrating an archive from version 2.2.x to version 2.3.x or higher, certain database drivers that were bundled with previous versions of Appboard are no longer included. After restoring the archive, you need to copy the driver from [AppBoard_Home]/server/webapps/enportal/WEB-INF/lib/ and save it into this same location on the new server. For example, to use MySQL you would need to copy the JDBC driver file (such as mysql-connector-java-5.1.19.jar) into the /lib/ directory of the new server. The error message indicating a missing driver would be "Please install missing [drivertype] Driver" on the screen and in Appboard.log. Tip: If you rename a database driver file to pkg-<libraryName>.jar, it will be preserved and migrated in archives generated by AppBoard.

On Unix systems, after restoring an archive you need to verify that some of the server settings are correct. For more information, see Unix Installation - restoring an archive

Advanced Configuration

The set of files that are included in the backup archive is configured in the file [INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/export-appboard.properties. You can customize the process by adding files to be included in the backup archive. To do so, create a file called custom.properties, and include any custom export commands.

The following is a sample customization block that could be added to custom.properties:

[xml,N]

1. Backup custom theme

export.custom.other=${webapp.webinf}/xmlroot/appboard/config/themes.xml;\

       ${webapp.home}/visualizer/assets/images/backgrounds/bg-red_1600.png;\
       ${webapp.home}/visualizer/assets/images/my_banner.png;\
       ${webapp.home}/login_pages/edgeLight/images/logo.png;\
       ${webapp.webinf}/lib/db2jcc.jar;\
       ${webapp.webinf}/lib/db2jcc_license_cu.jar;\
       ${webapp.home}/version.jsp;\
       ${webapp.webinf}/groovy-script/TrimSiteCode.groovy;

export-appboard.data=${webapp.webinf}/data