cloudBackup_CloudBackupService

This component provides the functionality for a registered device to initiate cloud backups. Cloud Backup Manager is the default view for this component. The Cloud Backup Service component is found in the cloudBackup palette.

The Cloud Backup Service is licensed for JACE and Supervisor platforms capable of running Niagara 4.3 or greater.

Via the service, you can manage your cloud backups as follows:

view existing backup details
download backups (encrypted and decrypted)
manually initiate backups and if desired, flag them for data retention
configure randomized time triggered backups
delete backups

The Cloud Backup Service generates alerts for the fault state, i.e. Cloud backup failed. Alerts are routed to the alarm class specified in the service’s Alarm Source Info property.

Cloud Backup Service properties

Name	Value	Description
Status	read-only	Indicates the condition of the component at the last check. `{ok}` indicates that the component is licensed and polling successfully. `{down}` indicates that the last check was unsuccessful, perhaps because of an incorrect property, or possibly loss of network connection. `{disabled}` indicates that the `Enable` property is set to `false`. `{fault}` indicates another problem. Refer to `Fault Cause` for more information.
Fault Cause	read-only	Indicates the reason why a system object (network, device, component, extension, etc.) is not working properly (in fault). This property is empty unless a fault exists.
Enabled	`true` or `false` (defaults to `true`)	Activates and deactivates use of the component.
Exclude Files	.hdb;.adb;.lock;backup;console.;config.bog.b;config_backup	Specifies the types of files to omit from backups.
Exclude Directories	file:^^alarm; file:^^history	Specifies the directories to omit from backups.
Offline Exclude Files	.hdb;.adb;.lock;backup;console.;config.bog.b;config_backup	Specifies the types of files to omit from backups that are created when performing an offline backup, i.e., the station is not running on the controller.
Offline Exclude Directories	.lock;backup;console.;config.bog.b;config_backup	Specifies the directories to omit from backups that are created when performing an offline backup, i.e., the station is not running on the controller.
Trigger Mode	7–days (default), 30–days, 90-days, Manual	Specifies whether to initiate backups using one of the randomized time trigger intervals or to initiate backups manually.
Next Trigger	date, time, AM/PM, time zone	Specifies the next scheduled trigger firing time.
Last Trigger		Displays the timestamp of the last firing of the trigger firing time.
Backup URL		Specifies the URL used to connect to the BaaS application in Niagara Cloud Services.
Alarm Source Info	additional properties	Contains a set of properties for configuring and routing alarms when this component is the alarm source.
Block Size	4MB (default)	Defines the block size for backup files being written to the cloud. A cloud backup is split into and streamed to the cloud in blocks. For example, a 360MB backup file will comprise 90 4MB blocks. There is no limit on the number of blocks for a backup file (as many as it takes)

NOTE: It is possible to remove the default exclusions of history and alarm databases, should you wish to include them in your backups. This would require modifying the default configuration on the Cloud Backup Service, removing both of the entries listed in the excludeDirectories property, as well as removing the entries (*.hdb and *.adb) listed in the excludeFiles property.

Actions

When you right-click on the service you can invoke the following action(s):

Backup — initiates a backup