Exporting and Importing SmartServer Configuration Files (Release 3.5)
The CMS IMPORT/EXPORT button is available with SmartServer 3.5 and higher. For SmartServer releases with 2.7 update 1 and higher and prior to 3.5, the CMS import/export feature is available with the CMS Settings button.
For SmartServer 3.6 and higher, see Exporting and Importing SmartServer Configuration Files.
For SmartServer 3.4, see Exporting and Importing a SmartServer Configuration (Release 3.4).
Backup and restore operations are dependent on SmartServer hardware versions
Restore operations are dependent on the SmartServer software and hardware versions for the backup and restore SmartServers. Consequently, you cannot restore a system image on all new SmartServers.
For example, if you backup a SmartServer 3.26 on a dual core SmartServer, then you cannot restore it on a new quad core that uses a Dialog PMIC, which is only supported with SmartServer 3.3 and higher. Doing so could result in the new SmartServer becoming unusable and possibly unrecoverable.
Therefore, only back up the settings and database (not the system) on the old SmartServer, and then on the new Dialog PMIC hardware, install SmartServer 3.3 or higher, and then restore the settings and database.
You can import and export configuration files using the SmartServer CMS Import/Export button () that is located on the SmartServer app bar, and an external file transfer tool such as WinSCP. You can import configuration files to define device types, device resources, device definitions, datapoint properties, datapoint connections, context definitions, favorites, Node-RED flow definitions, groups, and schedule definitions. You can export the same configuration files to replicate your SmartServer configuration on other SmartServers.
This topic consists of the following sections:
Configuration Import and Export Overview
The figure below is an example of the configuration files that you can export using the SmartServer CMS Import/Export button (CMS Export). You can edit the exported definition files to modify the configuration for your SmartServer or for other SmartServers. See Replicating a SmartServer with Individual Device Files for more information.
The tables below summarize the SmartServer configuration files that you can import and export using the Import/Export button () and an external file transfer tool such as WinSCP. Files can be exported in any order. To import files, follow the steps in the table below.
SmartServer 3.6 and Higher | ||||
|---|---|---|---|---|
Step | Data | Location | Tool | File Type |
1 | CMS Export | CMS Import/Export button ( ) | CMS | .zip |
2 | Internal Devices | /var/Apollo/www/apps | SCP |
|
3 | Internal Device conf file | /etc/supervisor/conf.d | SCP | .conf |
4 | SmartServer Home Page | /var/apollo/www/user | SCP | .html |
5 | Custom Web Pages | /var/apollo/www/user (or other /var/Apollo/www folders) | SCP |
|
6 | Custom Graphics | /var/apollo/www/images | SCP |
|
SmartServer 3.5 and Prior | ||||
Step | Data | Location | Tool | File Type |
|---|---|---|---|---|
1 | Device Types | Device Types widget | CMS | .dtp |
2 | BACnet XIF Files | /var/apollo/data/bacnetrouter/res | Export: SCP | .bac |
3 | CMS Export | CMS Import/Export button () | CMS | .zip |
4 | Node-RED | Sequence flows | CMS | .json |
5 | Internal Devices | /var/Apollo/www/apps | SCP |
|
6 | Internal Device conf file | /etc/supervisor/conf.d | SCP | .conf |
7 | SmartServer Home Page | /var/apollo/www/user | SCP | .html |
8 | Custom Web Pages | /var/apollo/www/user (or other /var/Apollo/www folders) | SCP |
|
9 | Custom Graphics | /var/apollo/www/images | SCP |
|
Replicating a SmartServer with a CMS Export File
The sections that follow describe the necessary steps to replicate a SmartServer system configuration using the Import/Export button ().
Exporting Device Types and SmartServer Files Using the Import/Export Button
Resetting and Updating the SmartServer
Configuring the SmartServer
Importing Device Types and SmartServer File Using the Import/Export Button
Exporting Device Types and SmartServer Files Using the Import/Export Button
You can use the CMS Import/Export button () → EXPORT tab to export the configuration from a SmartServer and make any modifications, if necessary. You can then import some or all of the files to your SmartServer.
With SmartServer 3.6 and higher, you can export device types using the CMS Import/Export button () → EXPORT tab → Settings options. The device types (.dtp file) is included in the CMS Settings Export. With SmartServer 4.1 (Beta) and higher, BTM files are also included in the .dtp file export.
With SmartServer 3.5 and prior, you can export device types using the Device Types widget. See the Defining Device Types section for more information and then continue with the steps below to export a SmartServer configuration.
To export a SmartServer configuration, perform the following steps:
Create a backup of the configuration files by following the steps for Backing Up the Database and/or Settings, or System in the Backing up and Restoring the SmartServer section, selecting the Settings option as your Export Contents.
When the backup is finished, a zip file containing the SmartServer configuration files is created and stored on your PC/SmartServer.Make any necessary modifications to the configuration files.