Working with XNAT Plugins


This documentation is a work in progress and will be updated in 2021 with example plugins and deeper development guidance.

The XNAT Plugin Framework is the preferred way of adding customizations such as new services, new APIs, new datatype schemas, or customized UI elements. Housing your customizations in plugins not only helps isolate and track your code and configurations, it also enables a much more rapid upgrade path when keeping your core XNAT up to date. However, there are limitations and caveats to working with plugins, which we will attempt to highlight as we walk through their development methods.

This section provides a road map to working with plugins in XNAT, 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 readme.md file.

$label.name