Uploading Data via StoreXML

Since XNAT's data structure is XML-based, users can easily upload and download XNAT data in XML format from anywhere in the application. However, when uploading new XML definitions, there are a few caveats to be aware of.

Using the Upload XML function in the UI

Users with appropriate permissions can upload XML definition documents from anywhere in the XNAT UI by clicking on Upload > XML in the top navigation. This brings up a simple UI with just a few controls that allows users to select and upload a single XML file.

If the "Allow Data Deletion" parameter is set to true, then any XML definition you upload will overwrite any existing record with the same accession ID.

The XML Uploader uses XNAT's StoreXML service to parse your XML document and create or modify records in your XNAT database. XML definitions can be uploaded for projects, subjects, or any subject assessor.

Troubleshooting Tips

  • Ensure that the XML file structure is what XNAT expects to receive.
  • Ensure that if you are making reference to an experiment data type, that that data type has been installed in your local XNAT.
  • If duplicating an XML record from another XNAT, ensure that you are not making references to files or resources that sit outside your local XNAT's URL.
  • Subject XML data from existing XNATs, such as XNAT Central, contains clinical experiment data as well. This data cannot be included in your upload when creating a new subject in your local XNAT.
  • Uploading an XML definition for an MR session does not upload any scan or resource files.

Using the StoreXML Service via a Scripted Tool

XNAT administrators can download XNAT Client Tools that include a version of StoreXML. This will allow you to script an upload of multiple records at once. See: XNAT Web Services Client Tools.