Troubleshooting and FAQs

If you come across an issue with the XNAT Desktop Client that is not addressed in this page, please use our bug report form found above: Contact Us > Report A Bug

Frequently Asked Questions: 

My Linux installation of the XNAT Desktop Client is not working

If your Linux installation appears to fail on startup, look for an error message like this in your DevTools console (viewable by clicking "Toggle DevTools" in the DevTools menu). 

This means that your local AppImage is unable to locate the path to the embedded JRE that ships with the Desktop Client. This is fixable by updating your LD_LIBRARY_PATH setting to point to a locally installed JRE instead. This is a simple process: 

1. Locate your local JRE installation and set the JAVA_HOME environment variable 

$ JAVA_HOME=$(java -XshowSettings:properties -version 2>&1 | grep java.home | sed -n -e 's/^.* = //p')

2. Make sure your downloaded XNAT Desktop Client appImage is executable. (Replace x.x.x with the version number of your downloaded app, i.e. "3.2.0")  

$ chmod +x /path/to/XNAT-Desktop-Client-x.x.x.AppImage

3. Set your LD_LIBRARY_PATH to point to the folder that contains "libjvm.so". Note the addition of "/lib/server" in the path below. (Your directory structure will depend on your local JRE install.) 

$ LD_LIBRARY_PATH=${JAVA_HOME}/lib/server/:${LD_LIBRARY_PATH}./XNAT-Desktop-Client-x.x.x.AppImage

After this fix, the Desktop Client should start up without issues. 

I forgot my XNAT Username / Password. How can I log in?

The Desktop Client does not have tools that allow you to reset your XNAT user credentials. To do that, go to your XNAT's login page in a web browser and click "Forgot login or password?" or contact your XNAT administrator. 

I can't download image session files from XNAT 1.6.5 (or earlier)

The XML Catalog format has changed slightly from XNAT 1.6 to XNAT 1.7, and the Desktop Client application is not currently compatible with the older version.  

I can't install the Desktop Client on my Virtual (Mac / Win / Linux) Environment

The Desktop Application requires an embedded JRE, which for some reason is not supported in any of the virtual environments that we have tested. We spent quite a while attempting to get to the bottom of this without success. This is a known issue, but not expected to be fixed. 

Why am I getting errors uploading some image sessions to XNAT but not others?

The XNAT Desktop Client waits until it has confirmation of image sessions being received and built before declaring success. If you see an error log like this, where individual files are successfully uploaded but then XNAT fails to report successful session building, this may be what happened.

If you are seeing errors in the session-building process, contact your XNAT administrator to ensure that your image session modality is properly set up in XNAT. The example error screen shown above resulted from Ultrasound data being sent to an XNAT where that datatype had not yet been installed. The data was sitting in the Prearchive and was able to be archived after successfully enabling the datatype.