backup-BackupService

In the 2013 “update releases” of NiagaraAX, including AX-3.7u1, password storage changes were made to increase security. These changes affect the backup dist content, and more importantly how backups can be restored. However, in AX-3.8 changes were made that simplify backup dist usage, although there are considerations about JACE platform credentials (which are no longer stored in a backup.dist file.) For details, refer to the NiagaraAX 2013 Security Updates document.

The BackupService provides for complete configuration backups to a Workbench PC or a browser PC (user with Wb web profile). By default, the BackupService is included when you create a new station using the New Station wizard. The target Niagara host (JACE, Supervisor) must have the backup module installed.

The default view of a station’s BackupService is the BackupManager, which provides a Backup button to manually initiate a backup. A backup automatically performs a local station save first, and is run as a standard station Job. This means each backup provides a progress bar, and upon completion, a popup notification. Under the station’s JobService, any backup appears as a “Fox Backup.”

See the following for more details:

About a backup dist

A backup is saved as a dist file (a zipped format) including minimally the station’s config.bog, current station console output (.txt file), and backup.log file. If other station file types and subfolders are not excluded (in the BackupService configuration), the backup dist file contains them too—for example, files of type: px, nav, html, jpg, png, and so forth.

Also, the backup dist contains the zipped “nre-config” for that host (including license and certificates files), as well as pointers to the installed “nre-core,” OS, and JVM, each by version. Essentially, a backup dist provides a “configuration snapshot” of the entire JACE platform in zipped “dist” file format. This allows for a complete image restoration.

Be careful to keep backup dist files in a secure location. They have always contained sensitive information, for example a station’s config.bog file. They also may contain sensitive host platform information. In update releases (AX-3.7u1), this includes unique “key ring” files used for client password encryption.

Not included in a backup is runtime data that is actively managed by the station, such as the alarm and history databases. This data should be “backed up” using standard alarm routing and history archiving to a Supervisor host.

The default backup destination depends on your station connection, as either:

Workbench (Fox) — !backups

A subdirectory “backups” under your Niagara release directory. If you have not previously made station backups, this directory is automatically created.
Browser access (Wb Web Profile) — !backups

A “niagara\wbapplet\backups” folder under your Windows user profile location, e.g.:

Windows 7: C:\Users\John\niagara\wbapplet\backups

Windows XP: C:\Documents and Settings\John\niagara\wbapplet\backups

If you have not previously made station backups, this directory is automatically created.

The default name for a backup file uses a format of: backup_stationName_YYMMDD_HHMM.dist

For example, “backup_demo_130412_1429.dist” for a backup made of station “demo” on April 12, 2013 at 2:29 pm.

Restoring a backup

To restore a backup dist from Workbench, you open a platform connection to the JACE, then use the platform Distribution File Installer to install a backup dist file.

Restoring from a backup may be necessary if the host failed in some manner, to allow recovery (to the same hardware, or to replacement hardware).
Another usage is to install the same backup dist file on multiple hosts, such that each host (typically JACE) has the identical configuration, including station database. When performing these “replicated” host installations of a backup dist, the platform Distribution File Installer allows you to choose if TCP/IP settings from the backup dist should be restored (the default is to not). Typically you do not, as TCP/IP settings must be unique on each host.

For related details, refer to “Restoring a backup dist” in the Platform Guide.
In update releases (including AX-3.7u1), in this “replicated station” use case it is recommended that you modify the original saved backup dist file, before installing it in multiple hosts. Otherwise, station security is compromised. However in AX-3.8, improvements were made such that edits to an AX-3.8 backup .dist file are unnecessary. For related details, see the sections “Station archiving changes” and “Making modifications to archived station files” in the NiagaraAX 2013 Security Updates document.

Also see “Restoring a backup dist” in the NiagaraAX Platform Guide.

BackupService configuration

Configuration lets you define the file types and/or folders not included in a station backup. The service’s property sheet provides the following properties for configuration:

Enabled

Either true (default) or false. Currently, this setting makes no difference (manual backup still possible even if service has disabled status).
Exclude Files

Specifies file types to exclude from the backup dist, either by name or extension (each delimited by “;”). By default, the following files are excluded: *.hdb;*.adb;*.lock;*backup*;console.*;config.bog.b*;config_backup*
Exclude Directories

Specifies station subdirectories to exclude from the backup dist, using relative ORD syntax. An ORD chooser control provides a Directory Chooser dialog in which you can select station subfolders. By default, the following subfolders are excluded: file:^history, file:^alarm
Offline Exclude Files

Specifies file types to exclude from the backup dist, when the station is stopped on the source host. either by name or extension (each delimited by “;”). By default, the following files are excluded: *.lock;*backup*;console.*;config.bog.b*;config_backup*

Note that history (*.hdb) and alarm (*.adb) files are backed up, unlike with a running backup.
Offline Exclude Directories

Specifies station subdirectories to exclude from the backup dist, when the station is stopped on the source host. Directories are specified using relative ORD syntax. An ORD chooser control provides a Directory Chooser dialog in which you can select station subfolders. By default, no directories are excluded, unlike with a running backup.