Torrent Suite SoftwareAdministration Guide

Torrent Suite Software space on Ion Community

Administration Guide TOC

Install Analysis Plugins

Analysis plugins are customized scripts, invoked off at the end of the analysis pipeline, which can provide secondary data analysis or other custom functionality. Plugins may be distributed by Ion Torrent or can be developed and customized by end users.

The Torrent Browser Plugin Store

In the Torrent Browser Plugin Store , you can search for plugins of interest, download them in your Torrent Browser, and run them on your analyses. These plugins are not developed by Ion Torrent.

You can install a plugin from the store automatically or manually. Each plugin page provides an XML link for automatic installation and a zipped offline installer for manual installation. These links are shown in the example plugin page below.

For more information on the Torrent Browser Plugin Store, visit the store at this link, Torrent Browser Plugin Store , or see The Torrent Browser Plugin Store User Guide .

Automatic installation from the Torrent Browser Plugin Store

Follow these steps for automatic installation of a plugin from the Torrent Browser Plugin Store :

1. In the Torrent Browser Plugin Store , go to the page for the plugin to be installed.
   
   
   
   

2. Scroll to the bottom of the page, and find the XML link with these directions: "Copy and paste this link into your Torrent Browser under the 'Config' tab after clicking the 'Add' button in the plugin section to auto install theplugin."

   An example XML link is the following: http://torrentcircuit.iontorrent.com/warehouse/download/feedfile/Ex.xml

   Copy this link.
   
   
   
   

3. In your Torrent Browser, click the gear menu (near the top right) and select Plugins :
   
   
   
   
   
   
   
   
4. In the Plugins tab, click the Install or Upgrade Plugin button:
   
   
   
   
   
   
   
   

5. In the Install via URL tab, paste the plugin's XML link into the empty field, and click Download .

   
   
   
   
   

   After installation is complete, you must click the Enabled checkbox to make the plugin available to users.
   
   
   
   

Manual installation of a Torrent Browser Plugin Store package

Follow these steps to download a plugin's installation package for manual installation:

1. In the Torrent Browser Plugin Store , go to the page for the plugin to be installed.
   
   
   
   
2. Scroll to the bottom of the page, and find the table with this explanation: " Links to the plugin archives are provided below for manual installation." Click the Offline Installer link.
   
   
   
   
   
   
3. Save the download to your machine.
   
   
   
   
4. In your Torrent Browser, go to the Admin Plugin section, and click the Install or Upgrade Plugin button.
   
   
   
   
5. In the Install via Zip upload tab, click the Select file button. Browse to the Offline Installer you just downloaded, and select it.
   
   
   
   
   
   
6. Click the Upload file button. The installation begins.
   
   
   
   

7. After installation is complete, you must click the Enabled checkbox to make the plugin available to users.

Enable an installed plugin

Follow these steps to enable an installed plugin:

1. Click the Torrent Browser Admin gear menu, and select Plugins . The installed plugins are displayed.
   
   
   
   
   
   
2. Click the Enabled checkbox for new plugins, to make them available to users.
   
   Click the Auto-Run checkbox for plugins that you want to be run on every analysis run.
   
   

Enable or disable automatic plugin execution

Click the Enabled checkbox for the plugin to enable the plugin to run automatically after pipeline analysis processing. Uncheck the checkbox to disable automatic plugin exection.

When the plugin Auto-Run status is enabled, the plugin is run at the end of every analysis job.

Plugins that require manual input, for instance for options or user information, cannot be Auto-Run.

Delete a plugin

To delete a plugin:

1. Click the Torrent Browser Admin gear box and select Plugins .
   
   
   
   
2. For the plugin you want to remove, click the gear box menu for that plugin and select Uninstall :
   
   
   
   

Not all plugins offer a Configure option.

---