Skip to content
Ask A Question
  • There are no suggestions because the search field is empty.

Backing Up / Moving OmniServer Configurations from one machine to another

Is it possible to copy OmniServer protocols and topic/device settings from one machine to another?

For users of OmniServer V3.2.0.10 or newer

Starting with OmniServer V3.2.0.10, moving your devices, topics and associated protocols is easier than it's ever been. There are new options available for Export/Import Project (File menu and toolbar) and Export/Import CFG (File menu only). The Export Project option will export your devices, topics and the protocols being used by those topics into a single .zip file. You can then use the Import Project option to import those devices, topics and protocols. The devices and topics will be integrated with any existing devices and/or topics on the machine where they are being imported, making this option best for merging projects.

The Export CFG option from the File menu makes it easy to export your omnisrv.cfg file which contains not only your configured devices and topics but also any plug-in wedge information. The Import CFG option from the File menu then makes it easy to re-import that on a different machine.

NOTE: Please be aware than any existing topics, devices and plug-in/wedge configuration will be overwritten when using this option.

For users that are either NOT using OmniServer Professional or that don't have any of the plug-ins/wedges configured (File, Database, Keyboard or Email), you'll want to do the following:

  1. Use the Export Project option (File > Export Project  /  or click the Export Project button in the toolbar).
  2. Save the .zip export file to the desired location and copy to your other OmniServer machine.
  3. Use the Import Project option (File > Import Project  /  or click the Import Project button in the toolbar).

NOTE: If there are existing devices, topics or protocols that are duplicates, you will be prompt to overwrite those duplicates. Alternately you can cancel the import.

For users of OmniServer Professional with plug-ins/wedges configured, you'll want to do the following to ensure you transfer not only your devices, topics and protocols but also your plug-in/wedge configurations:

  1. Use the Export Project option (File > Export Project  /  or click the Export Project button in the toolbar).
  2. Save the .zip export file to the desired location and copy to your other OmniServer machine.
  3. Go to the File menu and also use the Export CFG option.
  4. Save the omnisrv.cfg file to the desired location and copy to your other OmniServer machine
  5. Use the Import Project option (File > Import Project  /  or click the Import Project button in the toolbar).

NOTE: If there are existing devices, topics or protocols that are duplicates, you will be prompt to overwrite those duplicates. Alternately you can cancel the import.

6.  Go to the File menu and use the Import CFG option.

For users who made customizations to the OPC UA server configuration, the modified XML file can be found in the location below:

C:\ProgramData\Software Toolbox\OmniServer\OmniServerUAConfig.xml

For users of OmniServer V3.2.0.9 or previous versions

Moving OmniServer configuration and protocols is possible by copying the following files from the old machine to the new PC.

  1. OMNISRV.CFG - This contains the definitions for your Topics, Devices, and Client Wedges (if you have the Professional Version).
  2. <your protocol>.DPD - These files (there may be more than one) contain your protocol. Each one will be the name of your protocol with the extension .DPD.

Each of these files will be located in the directory below, and must be moved to the destination machine.

You MUST stop the OmniServer Poller and close the OmniServer Configuration on the source machine before copying the files.  If the Poller is running as a service then you would need to stop the OmniServer Poller service. On the destination computer do NOT start the OmniServer Poller until you have completed the process described here (you can confirm if it is started or not by checking Task Manager for osrvpoll.exe - if it is running, you will need to stop it). 

  1. XP/2003 Server - C:\Documents and Settings\All Users\Application Data\Software Toolbox\OmniServer
  2. Windows 7/8 & 2008/2012/2016/2019 Server - C:\ProgramData\Software Toolbox\OmniServer

Newer versions of the OmniServer (from V2.8.0.10 or newer) support menu options for importing device/topic configuration (File > Import CFG) and Protocols (while in the Protocol section in OmniServer, go to File > Import > Protocol or use the Import button shown in the screenshot).  For multiple files, it will be easiest to copy the files directly into the directory referenced previously while the OmniServer Poller is stopped.