Skip to content

TSTool / Install KiWIS Plugin

This appendix describes how to install and configure the TSTool KiWIS Plugin.

Install TSTool

TSTool must be installed before installing the KiWIS plugin. Typically the latest stable release should be used, although a development version can be installed in order to use new features. Multiple versions of TSTool can be installed at the same time.

  1. Download TSTool:
  2. Run the installer and accept defaults.
  3. Run TSTool once by using the Start / CDSS / TSTool-Version menu on Windows (or run the tstool program on Linux). This will automatically create folders needed to install the plugin.

Install and Configure the TSTool KiWIS Web Services Plugin

TSTool must have been previously installed and run at least once.

  1. Download the tstool-kiwis-plugin software installer file from the TSTool KiWIS Download page. For example with a name similar to tstool-kiwis-plugin-1.0.0-win-202301050440.zip.
  2. If installing the plugin in user files and if TSTool was not run before, run TSTool once to automatically create user folders and files needed by the plugin.
  3. Copy the owf-tstool-kiwis-plugin folder from the zip file to the following folder:
    1. If installing in user files (NN is the TSTool major version):
      • Windows: C:\Users\user\.tstool\NN\plugins\
      • Linux (~ indicates the user's home folder): ~/.tstool/NN/plugins/
    2. If installing in system files on Linux (opt), install in the following folder:
      • Linux: /opt/tstool-version/plugins/
  4. If an old version of the plugin was previous installed, delete the old jar file or move to the plugins-old/ folder (same level as the plugins folder) to archive. Only one copy of the plugin jar file can be found in the plugins folder to avoid software conflicts. If the KiWIS plugin features are not functioning properly, it may be due to conflicting jar files. The Commands(Plugin) menu will usually contain duplicate menus if multiple jar files are found in the plugins folder. Currently, the dep/ folder is empty because the plugin has no dependencies beyond the core TSTool software.
  5. Configure one or more datastore configuration files according to the KiWIS Data Web Services Datastore documentation.
  6. Test web services access using TSTool by selecting the datastore name that was configured and selecting time series.
  7. If there are issues, use the View / Datastores menu item to list enabled datastores.
  8. If necessary, see the Troubleshooting documentation.

On Windows, the installation folder will be similar to the following:

windows-plugins

KiWIS Plugins Folders on Windows (see also the full-size image)

TSTool will be enhanced in the future to provide a "plugin manager" to help with these tasks.