Installing and Using a Module

This documentation is only intended for XNAT 1.6. For XNAT 1.7 Plugin installation documentation, see: Deploying Plugins in XNAT

Installing a Module

The XNAT add-on architecture allows users to extend a default XNAT instance by adding features such as:

  • New data types
  • New screens and pages in the XNAT interface
  • Overriding existing screens and pages in the XNAT interface
  • Adding custom RESTful services
  • Adding custom tabs to various property pages, including the system configuration and project properties settings

These features are added using Plug-ins or Modules.  Modules are installed at build time by integrating the XNAT 1.6 base with features contained in the downloaded modules.

Downloading Plug-ins and Modules from Marketplace

Helpful instructions for downloading a plug-in or module from Marketplace can be found on the Download Instructions page. Once you have your plug-in or module, you should install it

Installing a Module

Modules are packaged as a JAR or ZIP file. To install a module, you simply place the package in the appropriate location and update your XNAT installation.

  1. Copy the module to your <XNAT_BUILDER_HOME>/modules folder.
  2. Stop tomcat if it is running.
  3. Update xnat and deploy to tomcat using ./bin/ -Ddeploy=true
  4. cd to your projects directory using cd <XNAT_BUILDER_HOME>/projects/xnat/
  5. Update your database using psql -U xnat -d xnat -f sql/xnat-update.sql
  6. Start tomcat

Using a Plug-in or Module

Plugins and Modules allow a user to add a diverse set of features and functionality to a default XNAT instance. Because of that, it is nearly impossible to provide generic documentation on how to use plugins or modules in general. Please consult the documentation found in the add-on's details page to learn how to use specific features provided.