Versions Compared

Old Version 40

changes.mady.by.user Artem Kleshchev

Saved on

compared with

New Version Current

changes.mady.by.user Artem Kleshchev

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

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

The difference between FIXEdge Installation and upgrade is to keep that upgrading keeps the working configuration unchanged, but use the 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 the a new one;
  5. If it is needed 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
Note

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.

Info

The upgrade requires a full stop of the FIXEdge services for 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

    Info
    Make FIXEdge configuration parameters adjustment if it's

    If scripts in bin/ directory (*.sh or *.cmd) were modified earlier then they should be recovered from the backup 

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

    1. Visit Visit the FIXEdge Release Notes page and look through the changes made from the current FIXEdge version to target the FIXEdge version.
      1. If last 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 last If the most recent product changes don't affect your current FIXEdge's and FIXICC's config files, you may leave them as isthey are;
      3. In case of If you have any doubts, please contact SupportFIXAntenna@epam.com;
    Warning

    It is critically important to update all absolute paths in the configuration.

    The recommendation is to use We recommend using relative paths for simplifying the upgrade steps.

    Note

    Until the Before version , 5.11, FIXEdge's instance directory had the name <FixEdge1>. Since As of version 5.11, FIXEdge's instance directory name is <FIXEdge1>.

  8. Upgrade FIXICC
    Remove 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

    Info

    the The default Windows path for fixicc-agent configuration is: fixicc-agent\FIXEdge1.fixicc-agent\conf\

    the The default Linux path for fixicc-agent configuration is: fixicc-agent/conf

    Ii.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 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 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;
      Note

      In case If you have several instances of one Transport Adaptor, (it means meaning that there are several copies of one TA library), you need to upgrade all of them.

    Note

    "Replace" in this context means that files should be deleted from the current FE directory and new files from the package should be added there. This clarification is made in order to avoid the situation when two (or more) of the same libraries with different versions appear in the directory as it may cause issues.

  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 Preparation 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 will be 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.

...

In this case, all required configuration is transferred and the working version is not stopped so the upgrade can be smooth to the users.

Info

The limitation of this upgrade procedure is that FIXICC will still be still pointing to the working (old) version of FIXEdge. 

Configuration of FIXICC for working Configuring FIXICC to work with 2 FIXEdges simultaneously is requiring requires additional configuration steps.

...

  1. Make sure that there is a backup copy of the working installation.
  2. Unpack the archive with the new FIXEdge version to a new directory.
  3. Replace all files in in the FIXEdge1\conf directory of the new FIXEdge instance with the working ones from the current (old) FIXEdge version.
    Make sure that the working configuration remain remains unchanged.

  4. Make FIXEdge Make adjustments to FIXEdge configuration parameters adjustment if it's needed. 
    In case if If FIXEdge uses absolute paths, they should be updated with the new paths.

    Warning

    It is critically important to update all absolute paths in the configuration.

    The recommendation is to use We recommend using relative paths for simplifying to simplify the upgrade steps.

    Note

    Until the Before version , 5.11, FIXEdge's instance directory had the name <FixEdge1>. Since As of version 5.11, FIXEdge's instance directory name is <FIXEdge1>.

  5. FIXICC configuration parameters adjustment

    Info

    Skip this step if there are no changes in fixicc and fixicc-agent configuration.

    If you're unsure then follow the steps below.

    1. FIXICC changes in the new installation directory
      1. Replace fixicc/etc/fixengine.properties with a file from the working (old) FIXEdge version
      2. Replace fixicc/etc/fixicc/log4j.properties with a file from the working (old) FIXEdge version

    2. FIXICC-agent changes

      Info

      the The default Windows path for fixicc-agent configuration is: fixicc-agent\FIXEdge1.fixicc-agent\conf\

      the The default Linux path for fixicc-agent configuration is: fixicc-agent/conf

      1. Replace fixicc-agent/conf/fixengine.properties with a file from the working (old) FIXEdge version
      2. Replace fixicc-agent/conf/agent.properties with a file from the working (old) FIXEdge version
      3. Replace fixicc-agent/conf/log4j.properties with a file from the working (old) FIXEdge version
      4. Replace fixicc-agent/conf/OrderAckTCPMonitor.properties with a file from the working (old) FIXEdge version
      5. Replace fixicc-agent/conf/security.properties with a file from the working (old) FIXEdge version

  6. If you use Transport Adaptors or Handlers,  you need to make sure that they are configured properly:

    Note

    If you have several instances of one Transport Adapter in your current configuration, please follow the How to configure several instances of one adapter instruction  instructions to setup set it up in a new configuration.

    1. For the JMS Adaptor, RabbitMQ Adaptor, SMTP Adaptor, FMXML Handler, BLLanguageExtension Handler - all corresponding libraries are already in in the FIXEdge1\bin directory of the new FIXEdge instance, so nothing is required;

    2. If you use any other Transport Adaptors or Handlers, you need to put corresponding libraries to to the FIXEdge1\bin directory of the new FIXEdge instance - see the installation guides for each the relevant adaptor/handler for details;

    3. The CME STP Adapter is provided separately as a part of the Supplementary Adapters and Handlers package (SupAdapters-FE-*)
      The new version of the package should be downloaded and binaries should be replaced.

      Info

      Using the old version of the adapter's library may lead to application failures

  7. If you use Failover Cluster, please follow Failover Cluster instruction  instructions to configure it for the new FIXEdge instance;
  8. Make sure that your configuration files correspond last to the most recent changes/improvements in new in the new product versions:
    1. Visit Visit the FIXEdge Release Notes page;

    2. Look through the changes made from the current FIXEdge version to target the FIXEdge version:

      1. If last 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 last If the most recent product changes don't affect your current FIXEdge's and FIXICC's config files, you may leave them as isthey are;
      3. In case of doubts, please contact SupportFIXAntenna@epam.com;
  9. 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 step #5 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 will be is missing
  10. Copy your FIXEdge license into the license file path;
  11. At this moment The new FIXEdge is now installed as a separate one; however, it still requires additional steps for using it in parallel with the old version.  

Additional steps for running two FIXEdges in parallel

The main goal behind this process is to distinguish two FIXEdges and avoid the configuration conflicts such as mutual ports.

  1. Perform configuration steps from instruction instructions on How to install two instances of FIXEdge on one host
  2. Make sure that all services from the new FIXEdges are installed

  3. Run fixicc FIXICC and adjust the servers list

    Info

    Sometimes it's required to remove all content of FIXICC's working dir <.fixicc>  except the servers.xml file.

    Working dir is normally placed in in the C:\Users\%USER%\AppData\Roaming directory;

...

Code Block
languagebash
titleFixEdge.log
2016-09-20 10:46:19,459 UTC   INFO    [CC_Layer]  5552  FIXEdge Version X.Y.Z (rxyz) started

How to revert the upgrade procedure

If you need to revert changes in order to use your original FIXEdge version (that was used from before the upgrade), you need to do the following steps:

...

If FIXEdge started to crash after the upgrade and some adapters or handlers is are used in the configuration probably , most likely step #4 in in the Upgrade process wasn't done properly

...