FIXEdge upgrade instruction

FIXEdge upgrade instruction

This article describes ways to upgrade to a new version of FIXEdge.

The difference between FIXEdge Installation and upgrade is that upgrading keeps the working configuration unchanged, but uses a new version of binaries with the new features and fixes.

Preparation

  1. Make sure you have sufficient administration permissions for further uninstall/install procedures.

  2. Download a new FIX Edge package for the corresponding OS version;

  3. Make a backup copy of your current installation (configuration and binaries);

  4. Make a copy of your current license (engine.license).
    If your license has expired or was lost, contact sales@btobits.com to obtain a new one;

  5. If you need to save data queued by Managed Queue then backup all the files from FixLayer.<managed_queue_name>.Storage.SQLite.FileName parameters in FIXEdge.properties

For FIXEdge version 6.5.0 and higher, VS2015 C++ redistributable is required. It can be found in FIXEdge's \Redist directory or downloaded from the Microsoft web-site.

How to replace your current FIXEdge version with a new one

This section shows how to upgrade the existing FIXEdge version and keep all configuration files unchanged.

The upgrade requires that you fully stop FIXEdge services in order to proceed with maintenance

Upgrade Process

  1. Make sure that there is a backup copy of the working installation.

  2. Stop the FIXEdge service process

  3. Stop the FIXICC-agent service process

  4. Uninstall the FIXEdge service(s)

  5. Uninstall the FIXICC Agent service(s)

  6. Upgrade FIXEdge binaries
    Copy and overwrite all files in FIXEdge's <FIXEdge installation>/bin/ directory with new binaries from the FIXEdge package

  7. Adjust FIXEdge configuration parameters if needed. 
    Make sure that your configuration files correspond to the most recent changes/improvements in the new product versions

    1. Visit the FIXEdge Release Notes page and look through the changes made from the current FIXEdge version to target the FIXEdge version.

      1. If the most recent product changes require an update of your current FIXEdge's and FIXICC's config files, adjust them to satisfy the new requirements;

      2. If the most recent product changes don't affect your current FIXEdge's and FIXICC's config files, you may leave them as they are;

      3. If you have any doubts, please contact SupportFIXAntenna@epam.com;

  8. Upgrade FIXICC
    Remove the <FIXEdge installation>/fixicc-agent/ and <FIXEdge installation>/fixicc/ directories
    Copy all files in FIXEdge's <FIXEdge installation>/fixicc-agent/ directory with new binaries from the FIXEdge package
    Copy all files in FIXEdge's <FIXEdge installation>/fixicc/ directory with new binaries from the FIXEdge package

  9. If there were changes in fixicc-agent and fixicc configuration then replace the new configuration with the configuration from the backup

    i.e. the following configuration should be re-used from the old FIXEdge version

    • fixicc/etc/fixengine.properties

    • fixicc/etc/fixicc/log4j.properties

    • fixicc-agent/conf/fixengine.properties

    • fixicc-agent/conf/agent.properties

    • fixicc-agent/conf/log4j.properties

    • fixicc-agent/conf/OrderAckTCPMonitor.properties 

    • fixicc-agent/conf/security.properties

  10. Upgrade Transport Adaptors and Handlers if you use them:

    1. Visit FIXEdge Release Notes page;

    2. Look through the changes made with Transport Adaptors and Handlers from the current FIXEdge version to target the FIXEdge version:

      1. If any improvements/bugfixes were done in the JMS Adaptor, then:

        1. Replace all jar files for the JMS adapter with new jar files from the FIXEdge package in FIXEdge's FIXEdge1\conf\jms-ta-distribution\lib directory;

        2. Replace all jar files for the JMS adapter with new jar files from the FIXEdge package in FIXEdge's FIXEdge1\conf\jms-ta-distribution\tool\lib directory;

      2. If any improvements/bugfixes were done in the RabbitMQ Adaptor, then:

        1. Replace all jar files for the RMQ adapter with new jar files from the FIXEdge package in FIXEdge's FIXEdge1\conf\amqp-ta-distribution\lib directory;

      3. if using the Kafka Transport Adapter serializer plugins make sure that the adapter is already updated in the bin directory (see step #6) then update the Kafka plugins in the plugins/ directory:
        For example:
        Windows: plugins/b2b_fixserver_kafka_test_serializer.dll
        Linux: plugins/libb2b_fixserver_kafka_test_serializer.so

      4. If any improvements/bugfixes were done in other Transport Adaptors or Handlers, then:

        1. Replace corresponding binaries with new ones from the package with SupAdapters in FIXEdge's <bin> directory;

  11. If using the Managed Queue, update managed queue plugin in <FIXEdge installation>/plugins/ directory:
    Windows: b2b_fixserver_plugin_queue_observer.dll
    Linux: libb2b_fixserver_plugin_queue_observer.so

  12. If using the Managed Queue, (i.e. FixLayer.ManagedQueue.Sessions parameter is configured) recover the queue files that were done in step #5 in the Preparation section.
    If data from the queue is not needed then you can skip this step. A new file will be created automatically after restarting the FIXEdge instance if it is missing.

  13. Copy your FIXEdge license into the license file path;

  14. Install the FIXEdge service(s);

  15. Install the FIXICC-agent service(s);

  16. Start the FIXICC-agent process;

  17. Start the FIXEdge process.