TOP Server JSON Configuration File Format

Flexibility for Sophisticated Users

The TOP Server configuration file can be saved in a JSON format which allows experienced users to perform edits as required to the entire channel+device set, such as a mass IP address update.  The use of this feature expects that a user is able to read/understand JSON structure formatting, understands TOP Server configuration, and that the user will follow best practices regarding backups of their work and working with care. Users comfortable with development, such as integrators or users with in house staff skilled in web services and .NET, can also use the TOP configuration API's instead of exporting to JSON and re-opening the project.  

We strongly recommend that users only use this format for editing, and then save the configuration file in the native *.OPF file format as that format provides encryption and password security capabilities. We also suggest that you not leave JSON format text files that could contain sensitive information in unsecured locations if you have concerns about the risks of someone accessing the files.  

The native *.OPF secure binary format also will perform better than a text JSON configuration on startup and updating of projects from the configuration UI. Users with small to mid-sized configurations will not notice a difference but if you have configurations in the tens of thousands or hundreds of thousands of tags, you may notice the difference.

Here's some more details about how to use this feature. 

Step 1: Preparation

First save your project as a *.opf file then save it as a *.json file with a different name.

This will protect your file from any accidental error that may happen when opened in a JSON editor.  There is a wide variety of JSON text editors available for free, as well as a plug-in for Notepad++.  If you have JSON development skills this feature will let you create your own project builder or make changes for different projects.  You must use great care when editing your project with any JSON editor and we suggest you test that a saved project from any JSON editor loads into the TOP Server successfully.

NOTE: For V5.x users previously saving as .XML, it is still possible to open .XML format files in TOP Server Version 6.  Save options in TOP Server Version 6 are limited to .OPF and .JSON.

Start by going to File | Save As in the TOP Server Configuration

Step 2 - Set File Format

When the Save As dialog opens change the type of file as shown to the right to a *.JSON type file.

Step 3 - Edit File and then Re-Open

You can now open the file in your chosen JSON editor. The image to the right shows where the Device ID can be found for Ethernet devices. You can also do a Find and Replace with most JSON editors. We suggest you try finding each item and replacing individually the first time before using the Replace All function to make sure you don’t change anything by accident.

Get Started Now

The demo is the full product once licensed. Once a client application connects to the  TOP Server, the TOP Server runtime will operate for 2 hours at a time. At the end of the 2 hour demo period, the demo timer must be reset by restarting the TOP Server runtime service.

Connect with Us

1-888-665-3678 (US + Canada toll free)
+1-704-849-2773 (Global)