KNIME Server 4.16 is a feature release of the 4.x release line. All clients that have worked with KNIME Server 4.15 will continue to work with KNIME Server 4.16 without restrictions.
|To find out which version of KNIME Server you are currently running, you can check the Administration pages on the WebPortal.|
Introduction to the update process
This document guides you through the steps that are needed to upgrade an existing KNIME Server installation from version 4.15 to 4.16 or update by applying a bugfix to version 4.16.
If you have any questions or need assistance with the update process, please contact your dedicated KNIME support specialist.
Since version 4.11, new installations of KNIME Server are based on Apache Tomcat, rather than Apache TomEE which was used in previous releases.
|With the release of KNIME Server 4.13.0, we discontinue support for TomEE based installations. It is not possible to upgrade a TomEE based KNIME Server to version 4.13.0 or higher. Instead, a fresh installation has to be performed.|
If your current KNIME Server installation is already Tomcat based, you can follow the upgrade procedure as outlined below.
You have already KNIME Server 4.15.x or KNIME Server 4.16.x running.
A KNIME Server installation based on Tomcat application server
For the sake of readability, this documentation uses
Client & Executor
KNIME Analytics Platform clients with KNIME ServerSpace 4.8+ otherwise it will not be able to talk to the Server.
KNIME Analytics Platform 5.2 as Executor with the corresponding KNIME Executor Connector extension version 4.16 installed on the Server side.
Even though all the data on the Server should be preserved during the update it is highly recommended to create a backup of all important data (see KNIME Server Administration Guide for backup information).
With KNIME Server 4.12 the email configuration moved from the knime.xml to the
Application server upgrade/update
KNIME Server 4.14.0 requires Java 11 to run. In case you are using an older version of KNIME Server and it
is still running on Java 8, please first update to a Java 11 JDK (e.g. from here),
and then update the
Start by downloading the following files and make sure that the owner of these files is your KNIME user:
Next backup these files before starting the update process:
knime.xmlfile located in
<apache-tomcat>/conf/Catalina/localhost/Please be aware that the name of the file might be different if the
.warfile had a different name (e.g.
Failure to backup this file will result in losing access to your scheduled jobs since it contains the secret key that is used to encrypt the schedules.
server.xmlfile located in
Then follow these steps:
Stop KNIME Server.
On Windows: If you have KNIME Server installed as a service, stop KNIME Server and Executor.
If you don’t have KNIME Server installed as a service, then run the
shutdown.batfile located in
On Linux: If you have KNIME Server installed as a service, stop KNIME Server by running the
systemctl stop knime-server.servicecommand
If you don’t have KNIME Server installed as a service, then run the
shutdown.shfile located in
Delete the existing folder
<apache-tomcat>/webapps/knime. You may not have a folder with this name located in the
webappsfolder. If this is the case, delete the folder that matches the file name of the
.warfile located in the
webappsfolder. E.g. if you see a
webportal.warfile in the
webappsfolder, delete the
<filename>.warfile located in the
webappsfolder to a different folder. Then copy the new downloaded
war-4.16.x.y.warfile to the
webappsfolder and rename it to
Check if the
knime.xmlfile that you backed up before still exists. If not copy the backup to the previous location.
Copy the downloaded file
<apache-tomcat>/lib. Delete the existing old
<knime-tomcat>.jarfile that was already in that directory. Make sure to rename the new file to knime-tomcat.jar.
Updating the Executor to KNIME Analytics Platform 5.1.0 or higher
|If you want to use KNIME Analytics Platform 5.1.0 or higher as an executor on Linux you must make sure that an X Display is available. Otherwise the executor may crash when creating images in KNIME nodes. See next section to learn how to install X Display.|
Due to some larger changes, it is not possible to upgrade to KNIME Analytics Platform 5.1.x or higher, from version 4.7.x or lower.
Therefore, if you have KNIME Executor 4.7.x or lower you need to install KNIME Executor 5.1.x from scratch.
Before starting the KNIME Executor installation process create a backup of the
<executor-folder> renaming it to
After you successfully install the desired version of KNIME Executor, rename the
new folder containing the Executor installation to the old folder name.
Then proceed with the installation of KNIME Executor by downloading the KNIME Executor full build from here and extracting it.
Please refer to the KNIME Server Installation Guide for more details about installing a KNIME Executor.
Migrating previous settings
When switching to a new executor, be sure to migrate any (custom) settings from the previous executor. Here are common configurations to check:
Some settings of the
knime.inifile may be configured in the executor service, but if present, please migrate these settings:
# executor profiles -profileLocation <your server's URL> -profileList <list of profiles, e.g. executor,python> # [...] # executor memory (line starting with -Xmx), e.g. -Xmx60G # [...] # Server's message queue -Dcom.knime.enterprise.executor.msgq=<your queue address> # [...] # any custom entries, e.g. http proxies
Some community extensions are not yet or no longer available on the newest KNIME version. For a full list of available community extensions, please see here.
You may find a proxy configuration file at
<old-executor>/configuration/.settings/org.eclipse.core.net.prefs. If so, please migrate this file to the new executor. In order to start the new executor automatically, ensure that the executor folder has the correct owner and access permissions (especially on Linux).
Install X Display for KNIME Executor version 5.1.0 or higher on Linux
|If you want to use KNIME Analytics Platform 5.1.0 or higher as an executor on Linux you must make sure that an X Display is available. Otherwise the executor may crash when creating images in KNIME nodes.|
The recommended way is using xvfb which is a virtual X Server for otherwise headless application (such as a KNIME Executor).
On Ubuntu systems, run
sudo apt install xvfb
On RedHat systems, run
sudo yum install xorg-x11-server-Xvfb
systemdtemplates which can be found in the root of the executor installation into your system. Since this may override your existing systemd configuration (mostly
/etc/systemd/system/knime-executor.service.d/override.conf) make a backup first.
sudo cp -rv <knime_executor>/systemd/. /
If you made any modifications to the copied files make sure to re-apply the changes to the new files (mostly
/etc/systemd/system/knime-executor.service.d/override.conf). Do not replace the new files with the old ones!
sudo systemctl daemon-reload
Xvfbservice and configure the same operating system user as for the
knime-executorservice by running
sudo systemctl edit Xvfb.service
and supplying the following contents
[Service] User=<same user as for the knime-executor.service>
sudo systemctl enable Xvfb.service sudo systemctl start Xvfb.service
Updating to KNIME Analytics Platform 4.7.x or lower
|This is only available for KNIME Analytics Platform version 4.4.x or higher. For other cases see previous KNIME Server documentation|
If possible, start the executor installation in graphical mode (using the correct installation user!). If you have internet access, go to File → Update KNIME… and it will suggest updating to the new version. Follow the steps in the wizard. If you don’t have direct internet access, you must download the zipped update sites from the commercial downloads page. Then register the ZIP files in File → Preferences → Install/Update → Available Software Sites and go to File → Update KNIME…
Under Linux, if you cannot start the graphical user interface, you can use the
update-executor.sh script that is in the root of the executor installation.
Call the script on the command line and provide a list of update sites that contain the new versions of the installed extensions and all installed extension will be updated (given that an update is available):
If you get error messages when executing
update-executor.sh about missing
"installable units", make sure that you have provided all necessary update
If you want to selectively update only certain extensions, you have to build the
update command yourself. An update is performed by uninstalling (
-i) an extension at the same time:
./knime -application org.eclipse.equinox.p2.director -nosplash -consolelog -r <list-of-update-sites> -i <list-of-features> -u <list-of-features> -d <knime-installation-folder>
For the given command, the parameters have the format specified in the Installing additional extensions section of the KNIME Server Administration Guide.
In case you want to use custom settings from your old KNIME Executor’s
knime.ini file, please copy only the lines
-vmargs to the new
knime.ini. The only exception to this are the four lines related to
Server Managed Customizations (
-profileLocation…), in case those are set.
The remaining lines above
-vmargs contain paths to resources that have been
changed in the new release, so they are not compatible.
Also note that it is now recommended to move the lines related to Server Managed Customizations to Executor’s service definition. This will help upgrading to future releases on installation where no GUI is available.
For fresh installations, please note that a
server.xml file (
from an older installation cannot be copied over due to some larger changes. Any
custom changes applied to your existing
server.xml need to be manually copied over
to the new
server.xml. For upgrades the existing
server.xml continues to work, and does not
need any adjustments.
Configuration of the updated KNIME Server
KNIME Server license
The KNIME Server license continues working with the new Server. If you haven’t received a license file or if it is not working correctly, please contact KNIME support or your dedicated KNIME account manager.
Enabling execution via Apache Qpid
KNIME Server 4.11 introduced an integrated message broker for communication between KNIME Server and KNIME Executor, based on Apache Qpid (https://qpid.apache.org/). This can be thought of as using an architecture that corresponds closely to distributed KNIME Executors, but runs on a single host, which is used by both KNIME Server and KNIME Executor.
Unlike distributed KNIME Executors, it is not necessary to install a separate message broker such as RabbitMQ. Instead, Apache Qpid is bundled as part of all KNIME Server installations. New installations of KNIME Server use Qpid by default. Older installations might still use RMI, which has been removed with KNIME Server 4.13.
If you are still using RMI, you need to switch your installation to Qpid. Changes are required in two locations:
Activate queue in
knime-server.config. The file can be found in
<knime-server-repository>/config/knime-server.config. Set the parameter
In addition, comment out the line
com.knime.server.executor.knime_exe= by placing a # character at the start of the
In the KNIME Executor installation directory, add the following line to the
knime.ini file, anywhere after the
Alternatively, you can also add this line to the Executor’s service definition.
Unlike the RMI-based execution, using the Qpid message broker requires to startup KNIME Server and
KNIME Executor separately. For starting up KNIME Server, you can still use the startup.sh/.bat file located in
In case the Executor startup script is not present, you can start the Executor from command line by running
./knime -nosplash -consolelog -application com.knime.enterprise.slave.KNIME_REMOTE_APPLICATION
For setting up the KNIME Server service, please follow the steps outlined in the KNIME Server Installation Guide. Installing the Executor as a service follows the same procedure as described for distributed KNIME Executors.
For increased security, we recommend to run both services as a different users.
Note that when switching from RMI to Qpid, the old
preferences.epf file in
not used anymore. In order to set preferences on the Executor (e.g. database drivers or Python configuration),
please use a preference profile as described in the
KNIME Server Admin Guide.
Server temp directory
Switching to Qpid also uses a different temp directory than RMI. On Linux, this defaults to
/tmp, which might have
size restrictions. In order to manually set a different temp directory, please add the following to the knime.ini file
of the KNIME Executor, anywhere below the
In some environments, it is necessary to explicitly open a port for connections to Qpid on localhost (even though
Server and Executor are running on the same host). By default, the port is 5672. This can be changed in the
Server host name in /hosts
By default, the host name of the machine is available in
/etc/hosts/. If this is not the case, KNIME Server will not
work using Qpid. This can be resolved by adding the server’s host name to
Due to a change in Tomcat responses sent by KNIME Server 4.11 and 4.12 are not compressed even though compression is
configured in the
server.xml. In order to enable compression again, you have to add the attribute
noCompressionStrongETag=false to all
<Connector> elements in your
... <Connector noCompressionStrongETag="false" compressibleMimeType="..." compression="on"/> ...
If you create a new server installation using the KNIME Server Installer for 4.13.0 this attribute will be added automatically.
All schedules are lost after updating
One important step during update process is the backup of the
so that it can be copied back into the KNIME Server installation folder. The
knime.xml file contains a secret key for encrypting the communication between
the server and the installation folder. If this is not restored before starting
the server, the server will not be able to load jobs and schedules previously created.
Access to KNIME WebPortal version > 4.11 is not possible
Access gives error 404
If you cannot access the URL of the KNIME WebPortal version > 4.11
and it fails with error 404, usually indicates that during update or installation process the Context Root used to define the KNIME WebPortal URL was left empty (
This is not possible starting with the release of KNIME WebPortal version 4.11+
for which it is necessary to always specify a Context Root.
Please refer to the KNIME Server Installation Guide.
Access gives error 500
If you cannot access the URL of the KNIME WebPortal version > 4.11
and it fails with error 500, usually indicates that the update did not work as expected.
Please contact KNIME support team via email@example.com to get this fixed.
Update of KNIME Executor via command line is not possible
This is a known bug when updating from a KNIME Server version 4.11.1. This bug is fixed starting with KNIME Server version 4.11.2.
To solve the issue you need to follow these steps:
Create a copy of the file named
-profileLocationoption from the
Update the KNIME Executor via command line
After a successful update, overwrite your
If this solution does not work, please contact KNIME support team via firstname.lastname@example.org
Workflows deployed on the server cannot be executed
If the following error message appears:
Unable to load workflow, it was created with a future version of KNIME
The KNIME Analytics Platform client with which you are connecting to the KNIME Server and with which the server was built needs to have a lower or equal version to the KNIME Executor. If this is not the case, please ask your KNIME Server Administrator to update the KNIME Server and/or KNIME Executor to the release version of the KNIME Analytics Platform client you are using locally.
If a missing node is reported, instead, check if the node is already installed and if the version of the respective extension is the same in both the KNIME Analytics Platform client and the KNIME Executor.
Finally, if your scripting (R or Python) snippets fail, it is possible that the respective packages are missing on KNIME Server. Please refer to the respective guides to install Python and R packages. Please also make sure the user under which you install those packages is the same user running the KNIME Executor.
Connection to KNIME Executor hosts after switching to Qpid is not possible
Make sure the hostname of the KNIME Server is mentioned in the
Check that the following ports are accessible on
localhost. They do not need (and in fact should not) to be accessible from other systems (usually this is the case).
With RabbitMQ: For KNIME Server and for the KNIME Executor that is setup on a separate machine (default 5672)
Starting with QPid, KNIME Executor needs to be started manually. Please follow the instructions in the KNIME Server Installation Guide to do so.
It might be necessary to change the user running the service. Please follow the instructions in the KNIME Server Installation Guide to do so.
Reading from my local file system after update to KNIME Server 4.11+ is not possible
Starting with KNIME Analytics Platform version 4.2, which is the KNIME Executor version for the KNIME Server 4.11 we are, by default, not allowing access to the local file system on the KNIME Server via the new File Util nodes. You can enable this again as described here.
Please note that this only affects nodes that are part of the revised file handling framework.
The authentication field is empty
Please update the
knime-tomcat.jar as described in the
Application server update section.
This must be done before restarting the KNIME Server.
Log4J 2.14 appearing after updating KNIME Executor
Eclipse does not remove old or uninstalled plugins from the hard disk unless garbage
collection is run. This may cause unused plugins and jar files, such as
continue to persist on the hard disk even if they are unused. To remove the old
plugins, including unused versions of log4j run the following command inside the
KNIME Executor directory.
./knime -application org.eclipse.equinox.p2.garbagecollector.application \ -nosplash -consolelog
Changelog (KNIME Server 4.16)
KNIME Server 4.16.0
(released December 6, 2022)
SRV-3760: Update Tomcat to 9.0.68
SRV-3720: Support generic HTTP requests and responses for jobs
SRV-3726: Partially executed job may have "finished at" set from start
KNIME Server 4.16.1
(released February 7, 2023)
SRV-3739: Update Microsoft Graph libraries for Azure AD OIDC authentication
SRV-3721: Call Workflow Action is triggered again after the executed job is opened in RWE
SRV-3765: Moving/Copying Components on Server always overwrites snapshots
SRV-3766: Retries after unsuccessful scheduled job execution are only half the configured number
SRV-3772: Job Schedules Permissions can no longer be changed
SRV-3774: Restoring jobs with credentials takes much longer since 4.14
KNIME Server 4.16.2
(released February 15, 2023)
SRV-3777: Can’t edit jobs in remote workflow editor for KNIME Server
KNIME Server 4.16.3
(released March 29, 2023)
SRV-3776: Add access token parsing to authenticator
SRV-3775: Race condition when retrieving logs from executors
SRV-3783: Swagger pages link to wrong support website
KNIME Server 4.16.4
(released May 17, 2023)
SRV-3782: Enable adding node details to notifications sent from WebPortal
WEBP-923: ConcurrentModificationException while executing to next page
KNIME Server 4.16.5
(released July 19, 2023)
SRV-3799: KNIME Server Connector fails to connect if KnimeCookieProcessor is set
SRV-3794: Clicking on workflow group in AP Explorer results in exception in Console view
SRV-3750: Wrong state logged for jobs in job-pool
SRV-3392: Can’t login from AP on Windows if user or password contains umlaut
SRV-3798: Update CXF to 3.6.1
SRV-3797: Update Jackson to 2.15.1
SRV-3788: Update KNIME Server to Tomcat 9.0.76
KNIME Server 4.16.6
(released September 14, 2023)
SRV-3813: Update dependencies in order to fix potential security vulnerabilities
SRV-3815: Update Tomcat to 9.0.80
SRV-3808: Main SwaggerUI does not work
SRV-3811: AP doesn’t throw exception when updating the job fails
SRV-3810: Loading workflow with a \+ in it will result the executor to be considered as a consumer
SRV-3812: Webportal doesn’t show share 'Link without login' when enabled via user groups
WEBP-959: Enable "download" report button again