Page tree
Skip to end of metadata
Go to start of metadata


In order for XNAT to work properly, it needs to know where to look for the files it needs. This is where you can configure the paths where XNAT should look, as well as configure some other file system related options. These options are configured on your initial setup. Each of these file system paths and their utility is discussed  in further detail in the documentation for Understanding the Components of XNAT

File System Settings


Setting

It can be dangerous to change file path settings in a running XNAT.


SettingProperty NameDescription
Archive PatharchivePathThis should be the location of the XNAT archive. This is where all the image files for sessions that have been added to XNAT are stored. Modifying this on systems that have already been set up can cause problems, so editing of this is disabled. This path can either be relative, or absolute, and should use the appropriate slashes for your file system.
Cache PathcachePathThis should be the location where you want XNAT to cache image session data. This path can either be relative, or absolute, and should use the appropriate slashes for your file system.
Prearchive PathprearchivePathThis should be the location of the XNAT prearchive. This is where new imagine sessions are stored while awaiting review before they are archived. This path can either be relative, or absolute, and should use the appropriate slashes for your file system.
FTP PathftpPathThis is the path where the XNAT FTP Server (no longer available) would write files to. This path can be set to a dummy value if you aren't setting up the FTP Server. This can either be a relative or absolute path, and should use the appropriate slashes for your file system.
Build PathbuildPathThis property is not currently used by the XNAT webapp itself, but may be used by pipelines. This path can either be relative, or absolute, and should use the appropriate slashes for your file system.
Pipeline PathpipelinePathThis should be the location of your pipeline scripts. This path can either be relative, or absolute, and should use the appropriate slashes for your file system.
ZIP ExtensionszipExtensions

This should be a comma-separated-list of all the file extensions that XNAT should treat as zips. It will use the ZipUtils class and the ZIP CompressionMethod when encountering these files. Other extensions (.tar and .gz) are handled separately.

When listing the zip extensions, you should not include periods. The default list of zip extensions is "zip,jar,rar,ear,gar,mrb".

Checksums?checksums

This switch box controls whether checksums should be calculated for each image file as it's archived. Activating this provides greater assurance of data integrity, but may add significant overhead to the archive process. It is enabled by default.

Site-wide config properties can be accessed via REST at /xapi/siteConfig/values/{property-name}.

Site-wide config properties can be access programmatically in Velocity via $siteConfig.{property-name}.