Page tree
Skip to end of metadata
Go to start of metadata
The CMS Settings button Export/Import feature is available with SmartServer 2.7 Update 1 and higher.

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 SFTP 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):

StepDataLocationToolFile Type
1Device TypesDevice Types widgetCMS.dtp
2 BACnet BAC Datapoint Discovery Files/var/apollo/data/bacnetrouter/resExport: SFTP
Import: CMS
.bac
3CMS Export

Settings button () on the CMS

CMS.zip
4Node-REDSequence flowsCMS.json
5Internal Devices/var/Apollo/www/appsSFTP
6Internal Device conf file/etc/supervisor/conf.dSFTP.conf
7Home Page (SmartServer Landing page)/var/apollo/www/userSFTP.html
8Custom Web Pages/var/apollo/www/user (or other /var/Apollo/www folders)SFTP
9Custom Graphics/var/apollo/www/imagesSFTP

Note : For SFTP, use a secure FTP 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.

  1. Exporting Device Types
  2. Exporting SmartServer Files Using the Settings Button
  3. Resetting and Updating the SmartServer
  4. Configuring the SmartServer
  5. Importing Device Types
  6. 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

To export a SmartServer configuration, perform the following steps:

  1. Click the Settings button () on the CMS.



  2. Select the Export action.



    The Export dialog box appears.



  3. Select the segment controller.



  4. Click EXPORT.

    A zip file is created and stored on your PC containing the SmartServer configuration files.

  5. Make any necessary modifications to the configuration files. 

Continue the SmartServer configuration replication process following the steps in the Resetting and Updating the SmartServer section below.

Resetting and Updating the SmartServer

  1. Reset the SmartServer to system defaults using the System Configuration page. See the Resetting the System to Defaults Using the Configuration Page in the Resetting the SmartServer to Factory Defaults section for more information.

  2. Update the SmartServer software as appropriate for your system. See the Updating the SmartServer Software section for more information and update procedures.

Continue the SmartServer configuration replication process following the steps in the Configuring the SmartServer section below.

Configuring the SmartServer

  1. Configure your SmartServer system using the Configuration pages. See the Configure Your SmartServer section for more information.

  2. If you are using the SmartServer Starter Kit, refer to the SmartServer IoT Starter Kit User's Guide for more information on how to set up the network configuration as well as Modbus and BACnet devices. Otherwise, skip this step.

  3. If you have any Modbus RTU devices, then you need to configure the RS-485 Configuration page. See (Optional) Add a Modbus RTU Interface for more information on Modbus RTU setup. Otherwise, skip this step.

  4. If you have any BAC files (used for BACnet devices), then you need to configure the BACnet Configuration page. See (Optional) Setting up BACnet for more information on BACnet setup. Otherwise, skip this step.

  5. If you are using Custom Web pages, you may also need to rename login1.html to login.html.

Continue the SmartServer configuration replication process following the steps in the Importing Device Types section below.

Importing Device Types

Import device types using the Device Types widget. See the Defining Device Types section for more information.

If you reset your system to defaults or re-imaged the SmartServer software, and you are using the VAV controller (VAV sim device) with the SmartServer Starter Kit and Node-RED, you also need to import the following files from the Lon Channel.dtp.zip (available from the Starter Kit archive → LON Channel folder) in the order shown below using the Device Types widget:

  1. nvs.xml
  2. envms.xml
  3. cps.xml
  4. fps.xml
  5. VAV_sim.XIF
  6. VAV_sim.APB


Continue the SmartServer configuration replication process following the steps in the Importing SmartServer Files Using the Settings Button
 section below.

Importing SmartServer Files Using the Settings Button

To import the SmartServer configuration, perform the following steps:

  1. Click the Settings button () on the CMS.



  2. Select the Import action.



    The Import dialog box appears.



  3. Select the file/zip to be imported and place it in the DROP FILE HERE area.



  4. Click IMPORT.

    A notification indicating that the file(s) was loaded will appear at the top right corner of the CMS. 

Continue your SmartServer setup by provisioning devices and importing any other necessary files.

Note: If you imported Node-RED flows with the CMS Import, you may need to change your dashboard themes. See Creating Sequence of Operations and SmartServer IoT Node-RED Tutorial for more information.

Replicating a SmartServer with Individual Device Files

The steps that follow describe how to replicate a SmartServer with individual device files.

  1. Export all device types from the Device Types widget to create a DeviceTypesArchive.dtp. See the Defining Device Types section for more information.

  2. Export all devices from the Devices widget. See the Discovering, Defining, or Importing Devices section for more information.

  3. Reset and update the SmartServer using the System Configuration page. See the Resetting and Updating the SmartServer section for more information.

  4. Configure the SmartServer using the Configuration pages. See the Configuring the SmartServer section for more information.

  5. Import all device types (i.e., DeviceTypesArchive.dtp) from the Device Types widget. See the Defining Device Types section for more information.

    If you reset your system to defaults or re-imaged the SmartServer software, and you are using the VAV controller (VAV sim device) with the SmartServer Starter Kit and Node-RED, you also need to import the following files from the Lon Channel.dtp.zip (available from the Starter Kit archive → LON Channel folder) in the order shown below using the Device Types widget:

    1. nvs.xml
    2. envms.xml
    3. cps.xml
    4. fps.xml
    5. VAV_sim.XIF
    6. VAV_sim.APB
  6. If you are using BACnet BAC Datapoint Discovery Files and did not import a BAC file before running device discovery, the SmartServer automatically creates the BAC fileIn this case, there will be a BAC file for each discovered device. You can add these device types (.dtp file) that were exported from the Device Types widget, or import them using Device Types widget.

     
  7. Import all devices from the Devices widget. See the Discovering, Defining, or Importing Devices section for more information.

  8. Continue your SmartServer setup by provisioning devices and importing any other necessary files.

Export/Import Reference


  • No labels