Skip to end of metadata
Go to start of metadata

Through the Plugin Manager, you can install new plugins or install updates to existing ones.

Table of content:s

Installing a plugin for Taverna Workbench

Installing a New Plugin

After you have found the plugin you were searching for, it is relatively easy to install it:

1. Tick the check box next to the plugin.
2. Click the Install button at the bottom of the dialog.

Installing an Update to a Plugin

To check if there are any updates available:

1. Select Updates and plugins from the Advanced menu.

2. A pop up window will appear listing all the installed plugins (including the standard ones and the third party ones you may have installed).
3. If there is an update available for any of the installed plugins, you will see a message "An update is available for this plugin" below the plugin.
4. Select this plugin from the list.
5. To install the update, click the Install button on the right hand side.
6. It is always advisable to restart Taverna after updating a plugin.

Taverna checks from time to time to see if there are updates to any of the installed plugins. If there are, a green arrow download icon will appear in the toolbar of the Workbench. Clicking it will take you straight to the Plugin Manager.

Installing plugins for command line tool

Installing plugins for the Taverna Commandline tool is a manual process, requiring editing of plugins/plugins.xml inside the Command line Tool's home directory, e.g. the equivalent of $HOME/.taverna-cmd-core-2.5.0/plugins/plugins.xml. See the plugin author's documentation or the plugins/plugin.xml of the workbench that has the plugin installed. Try to ensure that the <dependency> only includes the execution bit of the plugin, for instance my-activity rather than my-activity-ui. If you include the latter, the command line tool will download and initiate parts of the Workbench, which could slow down the command line launch and in some cases fail workflow execution.

The domain-specific editions of Taverna Commanline tool come bundled with the domain-specific plugins already installed. These instructions are needed only if you need to install additional plugins.

The remainder of this section explains an example of how to adapt a plugin section from the Taverna Workbench to work with the Taverna Commandline.

After installing a plugin (e.g. API Consumer) for the Taverna Workbench, /home/johndoe/.taverna-core-2.5.0/plugins.xml file contains a new <plugin> section for the installed plugin.

In order to install this plugin into the command line, we'll need to copy the whole <plugin> section for the new activity to /home/johndoe/.taverna-cmd-core-2.5.0/plugins/plugins.xml. If this file does not exist, run executeworkflow once without any parameters.

Edit /home/johndoe/.taverna-cmd-core-2.5.0/plugins/plugins.xml to add the new <plugin> section, but ensure that *-activity-ui is removed, and replaced by *-activity. In the above example this is easy, as we just need to delete the first <dependency> block and keep the next one:

If you copy the plugin definition as-is from the workbench without removing the *-ui dependencies, the download will be much slower as it will include parts of the Workbench, which may cause instability issues for the command line tool

To download and install the plugin, run executeworkflow without parameters again. If no errors are shown, then /home/johndoe/.taverna-cmd-core-2.5.0/repository will contain net/sf/taverna/t2/activities/apiconsumer-activity and other dependencies, and workflows using the plugin can now be executed using executeworkflow.

If you want to make the plugin installation persistent for all users on the machine, then recursively copy with overwrite /home/johndoe/.taverna-cmd-core-2.5.0/plugins and /home/johndoe/.taverna-cmd-core-2.5.0/repository to the Taverna installation, e.g. /opt/taverna-cmd-core-2.5.0. Note that users would have to delete their /home/alice/.taverna-cmd-core-2.5.0/plugins folder to see this global installation.

Labels
  • None