...

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

How to upgrade FIXEdge while the current version is up and running

This section shows how to setup an upgraded version of FIXEdge and transfer all required configuration without stopping the current working FIXEdge version.The difference between FIXEdge Installation and upgrade is to keep the working configuration unchanged but use the 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 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 new one;
5. Prepare configuration amendments in case you plan to change any credentials, destination folders, connection parameters, etc. Refer to configuration guides for assistance;

...

1. If it is needed to save data queued by Managed Queue then backup all the files from FixLayer.<managed_queue_name>.Storage.SQLite.FileName parameters in FIXEdge.properties

Upgrade Process

The detailed installation guide is presented here: FIXEdge Installation Guide. However, the main part of the new upgraded FIXEdge version setup is to make sure that the new FIXEdge configuration is the same as in the current version.

...

Unpack the archieve with new FIXEdge version;

...

FIXEdge configuration parameters adjustment:

1. Replace all files in FIXEdge1\conf directory of the new FIXEdge instance with ones from the made copy of you current FIXEdge version;

...

1. If you don't have any specific FIXICC/FIXICC Agent configuration in your current FIXEdge instance, then you may skip step 3.
   
2. If you setup any specific configuration for FIXICC for your current FIXEdge instance, then:
   1. Replace fixengine.properties file in fixicc\etc directory of the new FIXEdge instance with one from the made copy of you current FIXEdge version;
   2. Replace log4j.properties file in fixicc\etc\fixicc directory of the new FIXEdge instance with one from the made copy of you current FIXEdge version;
3. If you setup any specific configuration for FIXICC Agent for your current FIXEdge instance, then replace the following files in fixicc-agent\FIXEdge1.fixicc-agent\conf directory of the new FIXEdge instance with ones from the made copy of you current FIXEdge version:
   1. 1. agent.properties
         
      2. fixengine.properties
      3. log4j.properties
      4. OrderAckTCPMonitor.properties
      5. security.properties

...

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

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

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

3. If you use CME STP Adapter, it is necessary to upgrade the adapter after the FIXEdge upgrade procedure.

...

Replace the current FIXEdge version with a new one

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

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

7. Make FIXEdge configuration parameters adjustment if it's needed. 
   Make sure that your configuration files correspond last changes/improvements in new product versions

   :

   
   

   1. Visit FIXEdge Release Notes page;Look  page and look through the changes made from the current FIXEdge version to target FIXEdge target the FIXEdge version:.
      1. If last product changes require an update of your current FIXEdge's and FIXICC's config files, adjust them to satisfy new requirements;
      2. If last product changes don't affect your current FIXEdge's and FIXICC's config files, you may leave them as is;
      3. In case of doubts, please contact SupportFIXAntenna@epam.com;
8. Copy your FIXEdge license into the license file path;
9. Stop your current FIXEdge process;
10. Stop your current FIXICC-agent process;
11. If using the Managed Queue, refer to the instructions below:
    1. To check if Managed Queue is in use, check if the FixLayer.ManagedQueue.Sessions parameter is in use.
    2. Make sure the FIXEdge queue is empty
    3. Delete the Managed Queue storage file from the disk by searching for its name
       1. By default, the storage file will be named fe.db
       2. The file's name may have been customized via the fixedge.properties file (for example, FixLayer.ManagedQueue.Storage.SQLite.FileName=customname.db)
       3. This file won't exist if the Managed Queue is not in use
    4. A new file will be created automatically after restarting the FIXEdge instance.
12. Uninstall your current FIXEdge service(s);
13. Uninstall your current FIXICC Agent service(s);
14. Remove all content of FIXICC's working dir <.fixicc>  except servers.xml file. Working dir is normally placed in C:\Users\%USER%\AppData\Roaming directory;
    
15. Make sure that FIXEdge and FIXICC Agent are uninstalled in your system.
16. Install new FIXEdge service(s);
17. Install new FIXICC-agent service(s);
18. Start the new FIXICC-agent process;
19. Start the new FIXEdge process.

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

How to revert upgrade procedure

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

1. Stop the FIXEdge process;
2. Stop the FIXICC-agent process;
3. Uninstall the FIXEdge service(s);
4. Uninstall the FIXICC Agent service(s);
   
5. Remove all content of FIXICC's working dir <.fixicc>  except servers.xml file. Working dir is normally placed in C:\Users\%USER%\AppData\Roaming directory;
   
6. Restore your backup copy with original FIXEdge version;
7. Install the FIXEdge service(s) of the restored original FIXEdge version;
8. Install the FIXICC-agent service(s) of the restored original FIXEdge version;
9. Start the FIXICC-agent process of the restored original FIXEdge version;
10. Start the FIXEdge process of the restored original FIXEdge version.

How to upgrade the current FIXEdge version to the new one

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

Upgrade Preparation

1. Make sure you have sufficient administration permissions for further uninstall/install procedures.
2. Download new FIX Edge package for the corresponding OS version;
3. Stop the FIXEdge process;
4. Stop the FIXICC-agent process;
5. Uninstall the FIXEdge service(s);
6. Uninstall the FIXICC Agent service(s);
7. Remove FIXICC's working dir <.fixicc> normally placed in C:\Users\%USER%\AppData\Roaming directory;
8. Make a backup copy of your current installation (configuration and binaries);
9. Make a backup copy of your current license (engine.license).
   If your license has expired or was lost, contact sales@btobits.com to obtain the new one;
10. Prepare configuration amendments in case you plan to change any credentials, destination folders, connection parameters, etc. Refer to configuration guides for assistance;

Upgrade Process

1. Upgrade FIXEdge itself:
   1. For Windows version:
      Replace* files in FIXEdge's <bin> directory with new binaries from the FIXEdge package;
   2. For Linux version:
      Replace* files in FIXEdge's <bin> directory with new binaries from the FIXEdge package - all except *.sh files;
2. Upgrade FIXICC:
3. Replace* files in FIXEdge's <fixicc-agent> directory with new ones from the FIXEdge package – all except *.properties files;
Replace* files in FIXEdge's <fixicc> directory with new ones from the FIXEdge package – all except *.properties files;

Warning
It is critically important to update all absolute paths in the configuration. The recommendation is to use relative paths for simplifying upgrade steps

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

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

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

   Info
   the default Windows path for fixicc-agent configuration is: fixicc-agent\FIXEdge1.fixicc-agent\conf\ the default Linux path for fixicc-agent configuration is: fixicc-agent/conf

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

   • 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
6. Upgrade Transport Adaptors and Handlers if use them:
   1. Visit FIXEdge Release Notes page;
   2. Look through the changes made with Transport Adaptors and Handlers from you the current FIXEdge version to target FIXEdge target the FIXEdge version:
      1. If any improvements/bugfixes were done in JMS Adaptor, then:
         1. Replace * all jar files for 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 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 RabbitMQ Adaptor, then:
         1. Replace * all jar files for RMQ adapter with new jar files from the FIXEdge package in FIXEdge's FIXEdge1\conf\amqp-ta-distribution\lib directory;
      3. 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;
         If no improvements/bugfixes were done, you may skip step 4
         1. ;
      4. In case of doubts, please contact SupportFIXAntenna@epam.com;

      Note
      In case you have several instances of one Transport Adaptor (it means there are several copies of one TA library), 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) same libraries with different versions appear in the directory as it may cause issues.

7. If using the Managed Queue, (i.e. FixLayer.ManagedQueue.Sessions parameter is configured) recover the queue files that were done in Preparation step #5
   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 missing
8. Copy your FIXEdge license into the license file path;
9. Install the FIXEdge service(s);
10. Install the FIXICC-agent service(s);
11. Start the FIXICC-agent process;
12. Start the FIXEdge process.

How to upgrade FIXEdge and keep the current version running

This section shows how to set up a new copy of FIXEdge that would be an upgraded version of the current FIXEdge.

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

Upgrade Process

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 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 unchanged

4. Make FIXEdge configuration parameters adjustment if it's needed. 
   In case 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 relative paths for simplifying upgrade steps

   Note
   Until the version, 5.11 FIXEdge's instance directory had the name <FixEdge1>. Since 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 default Windows path for fixicc-agent configuration is: fixicc-agent\FIXEdge1.fixicc-agent\conf\ 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, 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 to setup it in a new configuration.

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

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

   3. 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 to configure it for the new FIXEdge instance;
8. Make sure that your configuration files correspond last changes/improvements in new product versions:
   1. Visit FIXEdge Release Notes page page;

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

      1. If last product changes require an update of your current FIXEdge's and FIXICC's config files, adjust them to satisfy new requirements;
      2. If last product changes don't affect your current FIXEdge's and FIXICC's config files, you may leave them as is;
      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 Preparation step #5
   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 missing
10. Copy your FIXEdge license into the license file path;
11. Install the FIXEdge service(s);
12. Install the FIXICC-agent service(s);
13. Start the FIXICC-agent process;
14. Start the FIXEdge process.

...

In order to ensure that the FIXEdge was successfully upgraded to the desired version, you may check the log files:

...

1. At this moment new FIXEdge is 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 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 and adjust the servers list

   Info
   Sometimes it's required to remove all content of FIXICC's working dir <.fixicc>  except servers.xml file. Working dir is normally placed in C:\Users\%USER%\AppData\Roaming directory;

Upgrade verification

Run FIXEdge and check the version in the version.log

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

How to revert upgrade procedure

In order to revert the upgrade, you should take your made backup copy and go through all the steps described above. 

In other words, the procedure is absolutely the same, the only difference is that the backup copy is the target FIXEdge version in this caseIf you need to revert changes in order to use your original FIXEdge version (that was used before the upgrade), you need to do the following steps:

1. Stop the FIXEdge process;
2. Stop the FIXICC-agent process;
3. Uninstall the FIXEdge service(s);
4. Uninstall the FIXICC Agent service(s);
   
5. Remove all content of FIXICC's working dir <.fixicc>  except servers.xml file. Working dir is normally placed in C:\Users\%USER%\AppData\Roaming directory;
   
6. Restore your backup copy with original FIXEdge version;
7. Install the FIXEdge service(s) of the restored original FIXEdge version;
8. Install the FIXICC-agent service(s) of the restored original FIXEdge version;
9. Start the FIXICC-agent process of the restored original FIXEdge version;
10. Start the FIXEdge process of the restored original FIXEdge version.

Troubleshooting

FIXEdge started to fail after the Upgrade

...