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

EFM Pointer Backup and Restore Recommendations

This FAQ provides general guidance on how to backup, restore, or otherwise migrate the TOP Server EFM suite's EFM pointer files to another PC.

The TOP Server EFM Exporter Suite is a plug-in for TOP Server that collects historical data from electronic flow computers and exports it to a variety of formats. In doing its work, it updates an EFM pointer file stored on disk after it successfully completes each export, to allow it to resume collection after a failed collection but also to know where to resume collection. The backup and management of these files is an important part of any system migration or disaster recovery strategy.
  • This tutorial assumes that you are familiar with generally accepted IT/OT best practices for change management, are familiar with and trained in following your own company's change management guidelines and practices. 
  • Users are expected to be on an active TOP Server Support & Maintenance agreement if they believe they may need assistance in their migration/restoration beyond what is included in this FAQ. If your company's licenses are not on an active TOP Server Support & Maintenance agreement you can request a renewal quote here.
  • Users seeking to avoid the risks associated with hardware failure should consider the use of commercially available off-the-shelf high-availability hardware and virtualization systems that avoid the need to re-load operating systems, software licenses, etc. These include but aren't limited to software solutions from VMWare, Microsoft, and hardware vendors such as Stratus, of course working within your company's IT guidelines. When using virtualization, we strongly recommend you consider our TOP Server Virtualization Guidelines. 

What makes an EFM Exporter Migration Unique? 

It is important to understand that if you have any active EFM configuration in TOP Server, those groups may start polling when the TOP server runtime service starts, even if no clients are connected to the TOP Server because the EFM Exporter plug-in acts like an internal client to the runtime engine. Users that are used to the concept that TOP Server does nothing until a client (OPC, Suitelink, etc) connects, will find this different, but an important consideration. 
The EFM exporter stores pointers for each EFM device that it retrieves history from and updates them after data from the last poll is committed to the configured export mechanism successfully. If an export fails, the pointer will not update because that can result in potential lost data and prevent re-polling for that data.  The management of the EFM pointer files is important to the overall system health. 
 
Location of EFM Pointer Files: C:\ProgramData\Software Toolbox\TOP Server\V6\EFM Pointer Files
 
Inside that folder will be a separate folder for each driver being used (i.e. ABB Totalflow, Fisher ROC Plus Ethernet, Omni Flow Computer, etc) and inside that folder are the .ptr pointer files for each meter of that driver type that will need to be moved to a new machine, and for disaster recovery purposes backed up with regularity consistent with your specific level of tolerance for re-polling of data based on the values stored in the last pointer file. 

Controlled Moves:

In the ideal world of a controlled move, you would want to stop all polling, so that there are no risks of the EFM pointer files changing while you are moving everything to the new machine, and carefully control when polling gets started on the new machine, so that you only start polling when you know you have the EFM pointer files in place, your license in place, etc., so that you can do a controlled restart on the new machine. Depending on how tightly you want to control the restart, you could also consider disabling all polling groups before you stop the runtime, so that when you move the configuration file (*.opf), EFM polling won't just auto-restart when you start the TOP Server Runtime Service. You will be in control of the restarts as you re-enable polling groups.
 
Here are suggested steps, but you should modify these to take into account the specific requirements of your system: 
  1. Make sure you have your configuration password/login if one was assigned at install, as you will need it for all work done.  You will need to configure the SAME password on the new machine. If you are changing that password, then you will need to, in the step to save your *.OPF configuration file, save it without encryption and take appropriate safeguards during moving the unencrypted file and restore security to the file as soon as possible on the new production machine. 
  2. (Optional) - Disable polling on all EFM polling groups in the EFM Exporter plug in by right clicking on each Polling Group name in the tree-view and select Disable. Doing this provides the most control on restart but may not be required in your situation.
  3. Stop the TOP Server Runtime Service either from the Windows Services App (listed as TOP Server x.y Runtime) where x.y is the version # - i.e. 6.9, etc or from the TOP Server system tray icon (right click, Stop Runtime service).  For safest results, use the Windows Services App and stop ALL TOP Server services, the number of which will vary based on what other TOP Server components you have installed. At a minimum there is a Runtime, Key Service, and Event Logger. 
  4. Make backup copies of your *.OPF project file and your EFM pointer files.
  5. Install the TOP Server on your new computer. We recommend that you start with the same version you are presently running. Although we would not anticipate upgrading the version at the same time causing issues, change management best practices suggest that you plan to upgrade the software version as a separate step from migration, after you confirm all operations are working as expected after migration. 
  6. Transfer your license over to the new machine using the TOP Server License Transfer procedure - it is also a good idea to make sure you have your TOP Server Emergency IDs available just in case something goes wrong.  
  7. Verify after transfer that the License Utility shows licenses for all drivers you are using. 
  8. Stop All TOP Server services as you did in Step 3. 
  9. Make a copy of your backed up *.OPF and EFM pointer files and put them on the new machine in their proper locations. Keep your backup copies separate in case you have to revert back. 
  10. Restart the same TOP Server services that you stopped in step 8
  11. At this point if you did not do step 2, polling of EFM history devices will resume on the schedules you have configured in the EFM suite, using the pointer values you stored. Carefully monitor the TOP Server Event Log for relevant errors and warnings that may indicate something is not working well. If you are having problems, consider stopping the runtime services to allow you time to assess the situation and TOP Server Event Log errors.  
  12. (Optional) If you did step 2 above, then after the prior step to this one, no EFM history polling will be occurring until you re-enable the polling groups. We suggest if you chose this more conservative route, that you choose to re-enable polling groups in an order that enables you to test and confirm success. The order would be based on your specific application, your networks, your level of stress on those networks, and any other knowledge you have of your system. 
  13. Once success is confirmed, make new, separate backups of your configuration and pointer files separate from your old ones
  14. Implement any new backup strategies required. 
  15. Complete any documentation required to insure you have your Emergency Activation IDs for all licenses on the new machine, your login, etc properly stored for future disaster recovery 
  16. If you removed any security from your configuration file, please restore it at this time. If you are not using security on your configuration file, and are in a governmentally regulated application with cybersecurity risks, we recommend you consider applying security and reviewing our TOP Server Secure Deployment Considerations Guide. 

Uncontrolled/Emergency Moves:

In an unplanned configuration move as part of a disaster recovery, it's possible that you will end up with some re-polling of data, so management of that added short term loading should be considered if you are running at the edges of capacity on your communications network. If you have sufficient spare capacity to allow the system to catch up, then your risks around the re-polling are lower.
The background principals and steps involved in restoring after a machine failure are the same as Steps 7 forward in a controlled move, but the level of success will depend on the quality of company backups and prior preparation for disaster recovery. 
 
Provided you have your Emergency IDs that were delivered with your original licenses, you will be able to activate those online 24/7/365 in our Registration Center, which will create a ticket for our team to provide you with new permanent licenses.