A typical AppBoard deployment will consist of:
AppBoard provides a configurable export system which will automatically capture all system configuration (1) and much of the custom assets (2). If custom assets are not captured then the export configuration can be modified to include them which would be considered a deployment best practice.
As for external supporting pieces that’s beyond the scope of the product itself but should be considered from a overall perspective.
The reasons for performing backups are:
Creating backups is done by navigating to the System Administration builder mode, and selecting the Backup icon.
Backup system administration page
This page allows new backups to be created as well as existing backups on the server filesystem to be downloaded or deleted.
Select the Create button to create a new backup, the following options will be presented:
The Backup AppBoard option backs up only AppBoard components, specifically: Stacks, Data Collections, and Data Sources. Everything else including server configuration, users, domains, roles, stack assignment, managed variables, and all enPortal specific custom export properties are not backed up.
Use the Backup All option for full system backups.
In addition, a special procedure is required to load an AppBoard only backup onto an existing server without losing other configuration, i.e. this is not necessary for a clean AppBoard installation. Instead of a Restore or Apply command, the FilesImport command should be used. This will overlay the files onto the filesystem without resetting the configuration database. All AppBoard content will be replaced however. The following steps are also required to ensure data sources are loaded correctly:
Recommended best practice is to ensure that backups include all required files for a functioning system. In many cases this is handled automatically by placing custom files within the supplied custom directories. Some files fall outside this pattern however and to handle these it’s necessary to customize the export file set by creating a custom.properties file and placing it into the [INSTALL_HOME]/server/webapps/enportal/WEB-INF/config/ directory.
This file can be used for various overrides so it may exist for other purposes already. The key part is to define an export.custom.other property with a list of rules defining the files to export. This is a semi-colon (;) separated list, with the backslash character (\) used to split the list over multiple lines to improve readability. For example:
# below is a list of additional files to export on a full backup
In this example a DB driver, a icon registry file, a custom graphic, a custom Look and Feel (LAF), and the test_dir are specific paths to be exported. The last example specifies a path and file expression so that only files ending with .png are included.
The format for each export rule is noted below. The initial Path is not a regular expression and must match exactly a single file or directory. PathExpression and FileExpression are regular expressions, not wildcards. The use of the exclude keyword is optional and implies the preceding expression should be excluded.
After making changes to the set of excludes perform a backup and verify the resulting (.jar) archive contains the desired set of files. The archive can be uncompressed using unzip, depending on the unzip tool it may need to be renamed to end with .zip.
The backup mechanism is only accessible via the web interface. In order to perform a backup unattended it is necessary to create a custom script to authenticate and call the following URL to generate the backup, in this case it would be the Backup All option:
Loading backup archives is completed on the command line and the AppBoard server must be shutdown beforehand. This process is disruptive and will replace the existing configuration – be sure that is what you want to do. Specifically all enPortal and AppBoard content and configuration will be replaced (assuming a Backup All archive).
The process to load an archive:
The applicable Load Types are defined below: