Exporting and Importing a SmartServer Configuration (Release 3.4)
The CMS Settings button Export/Import feature is available with SmartServer 2.7 Update 1 and higher.
For SmartServer 3.5 and higher, see Importing and Exporting SmartServer Configuration Files.
The workflow in this section describes how to replicate a SmartServer IoT system using file exports using the SmartServer CMS Settings button (). This button provides the ability to export and import a SmartServer configuration. Replicating a SmartServer using the CMS Export action allows you to create a zip file of the SmartServer configuration (including the device list, as well as device type, DLA, connection, etc. files), which can be imported into your SmartServer. The CMS Export zip file does not have all of the SmartServer configuration information, therefore, you may also need to export some CMS widgets files, or SCP other files, in order to duplicate the SmartServer configuration.
You can use the CMS Export feature to export the configuration from one SmartServer, make any modifications, and then import some or all of the files to your SmartServer. You can import the SmartServer configuration (such as devices, device types, DLA, connection, etc. files) using the SmartServer CMS Settings button Import action.
You can also export/import SmartServer configuration files individually. See Replicating a SmartServer with Individual Device Files for more information.
This section consists of the following:
Export/Import Overview
The table below shows the most common SmartServer configuration files that may need to be exported. While the exports are not strictly order dependent, the import order can affect the SmartServer configuration. For example, either the device types or CMS export can be exported first, however, the devices types file must be imported before the CMS export file. Therefore, it is recommended to use the import order shown in the table below.
Since not all SmartServers use all of the features shown below, you only need to perform the steps that apply to the features you are using. For example, if you are not using BACnet then you can skip step 2.
The following table provides the export/import order (you can skip steps for features not being used):
Step | Data | Location | Tool | File Type |
|---|---|---|---|---|
1 | Device Types | Device Types widget | CMS | .dtp |
2 | BACnet BAC Datapoint Discovery Files | /var/apollo/data/bacnetrouter/res | Export: SCP | .bac |
3 | CMS Export | CMS Settings 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 | Home Page (SmartServer Landing 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 |
|
Note: For SCP, use a secure tool like WinSCP to transfers files back and forth to the SmartServer.
Replicating a SmartServer with a CMS Export File
The sections that follow describe the necessary steps to replicate a SmartServer IoT system configuration using the Settings feature.
Exporting Device Types
Exporting SmartServer Files Using the Settings Button
Resetting and Updating the SmartServer
Configuring the SmartServer
Importing Device Types
Importing SmartServer Files Using the Settings Button
Exporting Device Types
Export device types using the Device Types widget. See the Defining Device Types section for more information.
Continue the SmartServer configuration replication process following the steps in the Exporting SmartServer Files Using the Settings Button section below.
Exporting SmartServer Files Using the Settings Button
You can use the CMS Export feature to export the configuration from one SmartServer and make any modifications if necessary. You can then import some or all of the files to your SmartServer. To export a SmartServer configuration, perform the following steps:
Click the Settings button ().
Select the Export action.
The Export dialog box appears.Select the segment controller.
Click EXPORT.
A zip file is created and stored on your PC containing the SmartServer configuration files.Make any necessary modifications to the configuration files.