HOW TO UPGRADE LIGHTSTREAMER ============================ First of all, please see CHANGELOG.HTML to know all the differences from the previous versions of the Lightstreamer components. --------------------------------------------------- Upgrading from 6.0.3 build 20160905 to This Version --------------------------------------------------- If you have an existing installation of Lightstreamer 6.0.3 build 20160905, then this new release only brings improvements to the Server and some client SDKs, as well as introducing new SDKs, also in replacement of old ones. Still, we suggest you to do a fresh install of Lightstreamer 6.1.0, then: - CONFIGURATION: You are allowed to reuse your actual files under conf and launch scripts under bin (e.g. LS.sh, LS.bat), but some inline comment may become obsolete, specifically in lightstreamer_conf.xml and lightstreamer_log_conf.xml, which also bring a few improved suggested settings. For the latter files only, you may prefer to take note of the changes you performed and apply your changes to the new factory configuration files (should be easy, as they have changed only slightly with no compatibility issues). - ADAPTERS: You can deploy your existing Adapters unchanged, but some inline comment may become obsolete. In particular, if you are deploying any Robust Proxy Data Adapter, new options and improved suggested setting are available. Only in the latter case, you may prefer to take note of the changes you performed on the involved blocks in adapters.xml, then replace them with the new template provided in adapter_remoting_infrastructure\doc\adapter_robust_conf_template\adapters.xml and apply your changes to the new blocks. - CLIENTS: The Server is compatible with previous client libraries, so your existing clients should work with no issues. This will allow you to upgrade the server *before* upgrading the clients. When you are ready to upgrade the clients, read carefully through the CHANGELOG to learn about any possible compatibility issues and if you need to recompile your code. If you are using the .NET or Windows Phone or winRT SDK, you should move to the new .NET PCL SDK, which exposes the same interface. - MPN MODULE DATABASE (where available): Can be used by the new Server version, with no porting actions needed. The new Server, upon the first run, will slightly modify a few tables. The modified database will still be backward compatible with Server 6.0.3. Should any issue arise, please contact the support. --------------------------------------------------- Upgrading from 6.0.2 build 20160510 to This Version --------------------------------------------------- If you have an existing installation of Lightstreamer 6.0.2 build 20160510, then this new release only brings improvements to the Server and some client SDKs, as well as introducing new SDKs, also in replacement of old ones. Still, we suggest you to do a fresh install of Lightstreamer 6.1.0, then: - CONFIGURATION: You are allowed to reuse your actual files under conf and launch scripts under bin (e.g. LS.sh, LS.bat), but some inline comment may become obsolete, specifically in lightstreamer_conf.xml and lightstreamer_log_conf.xml, which also bring a few improved suggested settings. For the latter files only, you may prefer to take note of the changes you performed and apply your changes to the new factory configuration files (should be easy, as they have changed only slightly with no compatibility issues). However, if you launch the Server with custom scripts, please check the "compatibility notes" in the Server CHANGELOG. - ADAPTERS: You can deploy your existing Adapters unchanged, but some inline comment may become obsolete. In particular, if you are deploying any Robust Proxy Data Adapter, new options and improved suggested setting are available. Only in the latter case, you may prefer to take note of the changes you performed on the involved blocks in adapters.xml, then replace them with the new template provided in adapter_remoting_infrastructure\doc\adapter_robust_conf_template\adapters.xml and apply your changes to the new blocks. - CLIENTS: The Server is compatible with previous client libraries, so your existing clients should work with no issues. This will allow you to upgrade the server *before* upgrading the clients. When you are ready to upgrade the clients, read carefully through the CHANGELOG to learn about any possible compatibility issues and if you need to recompile your code. If you are using the .NET or Windows Phone or winRT SDK, you should move to the new .NET PCL SDK, which exposes the same interface. - MPN MODULE DATABASE (where available): Can be used by the new Server version, with no porting actions needed. The new Server, upon the first run, will slightly modify a few tables. The modified database will still be backward compatible with Server 6.0.2. Should any issue arise, please contact the support. --------------------------------------------------- Upgrading from 6.0.1 build 20150730 to This Version --------------------------------------------------- If you have an existing installation of Lightstreamer 6.0.1 build 20150730, then this new release only brings improvements to the Server and some client SDKs, as well as introducing new SDKs, also in replacement of old ones. Still, we suggest you to do a fresh install of Lightstreamer 6.1.0, then: - CONFIGURATION: You are allowed to reuse your actual files under conf and launch scripts under bin (e.g. LS.sh, LS.bat), but some inline comment may become obsolete, specifically in lightstreamer_conf.xml and lightstreamer_log_conf.xml. For the latter files only, you may prefer to take note of the changes you performed and apply your changes to the new factory configuration files (should be easy, as they have changed only slightly with no compatibility issues). However, if you launch the Server with custom scripts, please check the "compatibility notes" in the Server CHANGELOG. Moreover, if LICENSE_SERVER is configured in lightstreamer_version_conf.xml, you may have to tune the configuration; please check the "compatibility notes" in the Server CHANGELOG for version 6.0.2 build 1797. - ADAPTERS: You can deploy your existing Adapters unchanged, but some inline comment may become obsolete. In particular, if you are deploying any Robust Proxy Data Adapter, new options and improved suggested setting are available. Only in the latter case, you may prefer to take note of the changes you performed on the involved blocks in adapters.xml, then replace them with the new template provided in adapter_remoting_infrastructure\doc\adapter_robust_conf_template\adapters.xml and apply your changes to the new blocks. - CLIENTS: The Server is compatible with previous client libraries, so your existing clients should work with no issues. This will allow you to upgrade the server *before* upgrading the clients. When you are ready to upgrade the clients, read carefully through the CHANGELOG to learn about any possible compatibility issues and if you need to recompile your code. If you are using the .NET or Windows Phone or winRT SDK, you should move to the new .NET PCL SDK, which exposes the same interface. - MPN MODULE DATABASE (where available): Can be used by the new Server version, with no porting actions needed. The new Server, upon the first run, will slightly modify a few tables. The modified database will still be backward compatible with Server 6.0.1. Should any issue arise, please contact the support. --------------------------------------------------- Upgrading from 6.0.1 build 20150716 to This Version --------------------------------------------------- If you have an existing installation of Lightstreamer 6.0.1 build 20150716, then this new release only brings improvements to the Server and some client SDKs, as well as introducing new SDKs, also in replacement of old ones. Still, we suggest you to do a fresh install of Lightstreamer 6.1.0, then: - CONFIGURATION: Take note of the changes you performed on the various configuration files under conf (e.g. lightstreamer_conf.xml, lightstreamer_log_conf.xml) and apply your changes to the new factory configuration files (should be easy, as the config files have changed only slightly with no compatibility issues). Do the same for the launch scripts under bin (e.g. LS.sh, LS.bat); however, if you launch the Server with custom scripts, please check the "compatibility notes" in the Server CHANGELOG. For lightstreamer_conf.xml only, you can, alternatively, use the online Configuration File Upgrade Tool; it is available at: https://service.lightstreamer.com/ConfigUpgrade Moreover, if LICENSE_SERVER is configured in lightstreamer_version_conf.xml, you may have to tune the configuration; please check the "compatibility notes" in the Server CHANGELOG for version 6.0.2 build 1797. - ADAPTERS: You can deploy your existing Adapters unchanged, but some inline comment may become obsolete. In particular, if you are deploying any Robust Proxy Data Adapter, new options and improved suggested setting are available. Only in the latter case, you may prefer to take note of the changes you performed on the involved blocks in adapters.xml, then replace them with the new template provided in adapter_remoting_infrastructure\doc\adapter_robust_conf_template\adapters.xml and apply your changes to the new blocks. - CLIENTS: The Server is compatible with previous client libraries, so your existing clients should work with no issues. This will allow you to upgrade the server *before* upgrading the clients. When you are ready to upgrade the clients, read carefully through the CHANGELOG to learn about any possible compatibility issues and if you need to recompile your code. If you are using the .NET or Windows Phone or winRT SDK, you should move to the new .NET PCL SDK, which exposes the same interface. - MPN MODULE DATABASE (where available): Can be used by the new Server version, with no porting actions needed. The new Server, upon the first run, will slightly modify a few tables. The modified database will still be backward compatible with Server 6.0.1. Should any issue arise, please contact the support. ------------------------------------------------- Upgrading from 6.0 build 20150213 to This Version ------------------------------------------------- If you have an existing installation of Lightstreamer 6.0 build 20150213, then this new release only brings improvements to the Server and some client SDKs, as well as introducing new SDKs, also in replacement of old ones. Still, we suggest you to do a fresh install of Lightstreamer 6.1.0, then: - CONFIGURATION: Take note of the changes you performed on the various configuration files under conf (e.g. lightstreamer_conf.xml, lightstreamer_log_conf.xml) and apply your changes to the new factory configuration files (should be easy, as the config files have changed only slightly with no compatibility issues). Do the same for the launch scripts under bin (e.g. LS.sh, LS.bat); however, if you launch the Server with custom scripts, please check the "compatibility notes" in the Server CHANGELOG. For lightstreamer_conf.xml only, you can, alternatively, use the online Configuration File Upgrade Tool; it is available at: https://service.lightstreamer.com/ConfigUpgrade Moreover, if LICENSE_SERVER is configured in lightstreamer_version_conf.xml, you may have to tune the configuration; please check the "compatibility notes" in the Server CHANGELOG for version 6.0.2 build 1797. - ADAPTERS: You can deploy your existing Adapters unchanged, but some inline comment may become obsolete. In particular, if you are deploying any Robust Proxy Data Adapter, new options and improved suggested setting are available. Only in the latter case, you may prefer to take note of the changes you performed on the involved blocks in adapters.xml, then replace them with the new template provided in adapter_remoting_infrastructure\doc\adapter_robust_conf_template\adapters.xml and apply your changes to the new blocks. - CLIENTS: The Server is compatible with previous client libraries, so your existing clients should work with no issues. This will allow you to upgrade the server *before* upgrading the clients. When you are ready to upgrade the clients, read carefully through the CHANGELOG to learn about any possible compatibility issues and if you need to recompile your code. If you are using the .NET or Windows Phone or winRT SDK, you should move to the new .NET PCL SDK, which exposes the same interface. - MPN MODULE DATABASE (where available): Can be used by the new Server version, with no porting actions needed. The new Server, upon the first run, will slightly modify a few tables. The modified database will still be backward compatible with Server 6.0. Should any issue arise, please contact the support. ------------------------------------------------- Upgrading from 6.0 build 20150121 to This Version ------------------------------------------------- If you have an existing installation of Lightstreamer 6.0 build 20150121, then this new release only brings improvements to the Server and some client SDKs, as well as introducing new SDKs, also in replacement of old ones. Still, we suggest you to do a fresh install of Lightstreamer 6.1.0, then: - CONFIGURATION: Take note of the changes you performed on the various configuration files under conf (e.g. lightstreamer_conf.xml, lightstreamer_log_conf.xml) and apply your changes to the new factory configuration files (should be easy, as the config files have changed only slightly with no compatibility issues). Do the same for the launch scripts under bin (e.g. LS.sh, LS.bat); however, if you launch the Server with custom scripts, please check the "compatibility notes" in the Server CHANGELOG. Moreover, if LICENSE_SERVER is configured in lightstreamer_version_conf.xml, you may have to tune the configuration; please check the "compatibility notes" in the Server CHANGELOG for version 6.0.2 build 1797. - ADAPTERS: You can deploy your existing Adapters unchanged, provided that you add the new commented line at the top of your instances of "adapters.xml" as shown in the new version of the sample "adapters.xml" in DOCS-SDKs\sdk_adapter_java_inprocess\doc\adapter_conf_template. However, some inline comment may become obsolete. In particular, if you are deploying any Robust Proxy Data Adapter, new options and improved suggested setting are available. Only in the latter case, you may prefer to take note of the changes you performed on the involved blocks in adapters.xml, then replace them with the new template provided in adapter_remoting_infrastructure\doc\adapter_robust_conf_template\adapters.xml and apply your changes to the new blocks. - CLIENTS: The Server is compatible with previous client libraries, so your existing clients should work with no issues. This will allow you to upgrade the server *before* upgrading the clients. When you are ready to upgrade the clients, read carefully through the CHANGELOG to learn about any possible compatibility issues and if you need to recompile your code. If you are using the .NET or Windows Phone or winRT SDK, you should move to the new .NET PCL SDK, which exposes the same interface. - MPN MODULE DATABASE (where available): Can be used by the new Server version, with no porting actions needed. The new Server, upon the first run, will slightly modify a few tables. The modified database will still be backward compatible with Server 6.0. Should any issue arise, please contact the support. ------------------------------------ Upgrading from 5.1.2 to This Version ------------------------------------ If you have an existing installation of Lightstreamer 5.1.2, we suggest you to do a fresh install of Lightstreamer 6.1.0, then: - CONFIGURATION: You can use the online Configuration File Upgrade Tool to automatically convert Lightstreamer 5.1.2 configuration files to 6.1.0. Supported files are lightstreamer_conf.xml and lightstreamer_log_conf.xml in the conf folder. The online Configuration File Upgrade Tool is available at: https://service.lightstreamer.com/ConfigUpgrade For other configuration files under conf (e.g. lightstreamer_version_conf.xml) and the launch scripts under bin (e.g. LS.sh, LS.bat), take note of any changes you performed and apply them to the new factory files. However, if you launch the Server with custom scripts, revise the scripts based on the new deployment structure. Moreover, if LICENSE_SERVER is configured in lightstreamer_version_conf.xml, you may have to tune the configuration; please check the "compatibility notes" in the Server CHANGELOG for version 6.0.2 build 1797. - ADAPTERS: Deploy your existing Adapters after reading the CHANGELOG, to learn about any possible compatibility issues and if you need to recompile your code. We anticipate that Java Adapters which lean on the Server's internal support for logging will require some porting actions. You can use the aforementioned Upgrade Tool to convert the adapters.xml files: https://service.lightstreamer.com/ConfigUpgrade If you are using Remote Adapters, the upgrade on the Proxy Adapter side also requires an upgrade of the Remote Adapter SDK library. - CLIENTS: Lightstreamer 6.0.x is compatible with previous client libraries, so your existing clients should work with no issues. This will allow you to upgrade the server *before* upgrading the clients. When you are ready to upgrade the clients, read carefully through the CHANGELOG to learn about any possible compatibility issues and if you need to recompile your code. If you are using the .NET or Windows Phone or winRT SDK, you should move to the new .NET PCL SDK, which exposes the same interface. ----------------------------------------- Upgrading from 4.x or 5.x to This Version ----------------------------------------- If you have an existing installation of a previous version of Lightstreamer (either 4.x or 5.x older than 5.1.2) we suggest you to do a fresh install of Lightstreamer 6.1.0, then: - CONFIGURATION: Take note of the changes you performed on the various configuration files under conf (e.g. lightstreamer_conf.xml, lightstreamer_log_conf.xml) and apply your changes to the new factory configuration files. Do the same for the launch scripts under bin (e.g. LS.sh, LS.bat); however, if you launch the Server with custom scripts, revise the scripts based on the new deployment structure. Moreover, if LICENSE_SERVER is configured in lightstreamer_version_conf.xml, you may have to tune the configuration; please check the "compatibility notes" in the Server CHANGELOG for version 6.0.2 build 1797. For lightstreamer_conf.xml and lightstreamer_log_conf.xml the operation can be greatly simplified by doing it in two steps, porting the changes to the 5.1.2 format first (should be easy, as the config files have not changed radically), then using the online Configuration file Upgrade Tool to automatically convert Lightstreamer 5.1.2 configuration files to 6.1.0. The online Configuration File Upgrade Tool is available at: https://service.lightstreamer.com/ConfigUpgrade - ADAPTERS: Deploy your existing Adapters after reading the CHANGELOG, to learn about any possible compatibility issues and if you need to recompile your code. We anticipate that Java Adapters which lean on the Server's internal support for logging will require some porting actions. On the other hand, if you are using Remote Adapters, we suggest you to redeploy the "Proxy Adapter" part from scratch: take note of the changes you performed on the related or blocks in adapters.xml, then replace them with the new templates provided under DOCS-SDKs\adapter_remoting_infrastructure\doc and apply your changes to the new blocks. The upgrade on the Proxy Adapter side also requires an upgrade of the Remote Adapter SDK library. The porting of the various adapters.xml files can be greatly simplified by doing it in two steps, porting the changes to the 5.1.2 format first (should be easy, as these files have not changed radically), then using the aforementioned Upgrade Tool to automatically convert Lightstreamer 5.1.2 configuration files to 6.1.0: https://service.lightstreamer.com/ConfigUpgrade - CLIENTS: Lightstreamer 6.0.x is compatible with previous client libraries, so your existing clients should work with no issues. This will allow you to upgrade the server *before* upgrading the clients. When you are ready to upgrade the clients, read carefully through the CHANGELOG to learn about any possible compatibility issues and if you need to recompile your code. If you are using the .NET or Windows Phone or winRT SDK, you should move to the new .NET PCL SDK, which exposes the same interface.