How does backwards compatibility work with Keyavi?

Date Published: 07/17/2023

Keyavi 2.1+ (Keyavi Desktop application)

Keyavi administrators 

Keyavi is designed to be backwards compatible with the previous version of the Keyavi Desktop application to one release back. This means that a new Keyavi back-end API will work with an older Keyavi application (agent) of the previous version (only one version back). In other words, a 2.3 Keyavi deployment (back-end API) will work with a 2.2 Keyavi application. However, a 2.1 version of the Keyavi application would not be supported (since only one version back is supported). 

However, the opposite is not true. A new agent will not necessarily work with an older back-end deployment. In other words, a 2.2 Keyavi deployment will not work with a 2.3 Keyavi application. 

Important: During the upgrade process, it is recommended to upgrade the backend API prior to installing the new application. The agent should not be "newer" than the back-end.