Local Device backup and restore properties

Starting in AX-3.2, server-side support was added for the BACnet DM-BR-B BIBB, such that a remote BACnet Workstation client can backup and restore the configuration of a station running on a JACE host. Several related properties were added to the LocalBacnetDevice, as shown in Figure 95.

Figure 95. Backup and restore related properties in LocalBacnetDevice


Backup and restore related properties in LocalBacnetDevice


The following descriptions apply to these properties:

NoteProperties above were defined in a recently accepted proposal to the SSPC to fix known issues with the backup and restore feature, as currently defined in the spec. The proposal will be the subject of a future public review document, but it will likely be accepted, and so it has been implemented for now. When the document becomes an official part of the standard, there will likely be an update patch to adjust the property identifier indices.

See the next section, About backup and restore operations, for additional details.

About backup and restore operations

Any backup or restore initiated from a remote BACnet Workstation client requires several things before it is acted upon by the station, as follows:

  • The station user “BACnet” requires admin-level write permissions on the BacnetNetwork and BacnetLocalDevice, at a minimum. The password for the BACnet user must be a non-blank (non-default) value, and this password must be known to the operator of the remote BACnet Workstation.

  • The normally-hidden “Reinitialize Allowed” property of the Server layer component (child of the BacnetComm container under the BacnetNetwork) must be unhidden and set to a value of “true,” as it defaults to “false.” Once changed, it can be rehidden if desired. See About Bacnet Comm: Client, Server, and Transport for related details.

If the conditions above are met, and if an AX-3.2 or later station receives a backup or restore request, these operations occur as described below:

NoteBackup and restore procedures used adhere to Clause 19 of the BACnet Specification.

Backup operation

Backup operation proceeds as follows:

  • The LocalBacnetDevice’s “Backup and Restore State” property changes from “Idle” to “Preparing for backup.”

  • The station’s BackupService begins preparing a backup .dist, containing the following:

    • Station database - config.bog

    • Alarm history database

    • History database

    • Module metadata - information about which version of each module is loaded.

      NoteModules themselves are not backed up.

  • The assembled backup .dist file is then exported as a File object and is part of the configurationFiles property of the device object. The backup client then reads the File object using BACnet file access services.

  • The LocalBacnetDevice’s “Backup and Restore State” property changes back to “Idle,” and normal station operation resumes.

Restore operation

Restore operation proceeds as follows:

  • The LocalBacnetDevice’s “Backup and Restore State” property changes from “Idle” to “Preparing for restore.”

  • The station begins a graceful shutdown, saving opened files.

  • The backup .dist file is sent from the remote BACnet Workstation client to the JACE platform.

  • The backup .dist file is installed, and then the JACE host rebooted.

  • Upon station startup, the LocalBacnetDevice’s “Backup and Restore State” property changes back to “Idle,” the “Last Restore Time” reflects the time of the backup .dist installation, and normal station operation resumes.