Working with XNAT Plugins

This documentation is a work in progress and will be updated frequently. Please check back for more information and updates in the days to come. If you have any requests or suggestions, please send us an email.

XNAT 1.7 introduces a new way of extending XNAT through the use of plugins. Previous versions of XNAT used the setup and update scripts to integrate custom code directly into the deployed XNAT web application. This caused issues with maintaining and updating the deployed applications, since the custom code became difficult to distinguish from the core XNAT release code. By contrast, each plugin is packaged in its own discrete archive container that can be deployed separately and distinctly from the deployed application. Updating and even removing custom functionality is as simple as removing the plugin from the XNAT plugins folder.

This section provides a road map to working with plugins in XNAT 1.7, including:

 XNAT Administrators will download and install your plugins using this standard process: Deploying Plugins in XNAT. If your plugin code requires any deviations from this process, you should make that clear in your plugin's file.