Setting Project Defaults for Desktop Client Behavior

The Desktop Client reads your selected project's preferences and modifies its upload behavior accordingly. See below for a list of settings and where you can customize them. You can either change these settings via REST calls, or via Project Settings with the DXM Settings Plugin installed.

Project Customizations for the Desktop Client

Setting	Description	Options	How to Modify
`require-date`	If set to true, a user must know and enter the date of each image session before that session can be uploaded	true false (default)	PUT - /data/projects/<PROJECT_ID>/config/applet/require-date
`allow-create-subject`	If set to true, all uploading users have permission to create new subjects in your project during the upload process	true (default) false	PUT - /data/projects/<PROJECT_ID>/config/applet/allow-create-subject
`allow-bulk-upload`	If set to true, users can use the Bulk Upload feature of the desktop client to upload groups of image sessions	true (default) false	PUT - /data/projects/<PROJECT_ID>/config/applet/allow-bulk-upload
`default-subject-labeling-scheme`	If set, the Bulk Upload process will default to the use of the specified labeling schemes for all subjects. See Subject and Session Labeling Schemes for Uploads. (Users can always select a different scheme or provide manual entries.)	manual auto dicom_patient_name dicom_patient_id	PUT - /data/projects/<PROJECT_ID>/config/applet/ default-subject-labeling-scheme
`default-session-labeling-scheme`	If set, the Bulk Upload process will default to the use of the specified labeling schemes for all sessions. See Subject and Session Labeling Schemes for Uploads. (Users can always select a different scheme or provide manual entries.)	manual auto dicom_accession_num dicom_patient_id	PUT - /data/projects/<PROJECT_ID>/config/applet/ default-session-labeling-scheme

Installing and Using the DXM Settings Plugin

The DXM Settings Plugin is an extremely lightweight utility that exposes these settings in the Project Settings UI. It is supported by XNAT versions 1.7.6 and up.

1. Download the plugin

2. Upload the plugin to your XNAT server and move it into your XNAT home plugins folder

CODE

$ mv ./dxm-settings-plugin-1.0.jar /data/xnat/home/plugins

(Substitute your XNAT_HOME directory path for "/data/xnat/home" as needed. )

3. Restart Tomcat

CODE

$ sudo systemctl restart tomcat9.service

(The syntax of this command may differ based on your install environment)

4. Log in to your XNAT and navigate to a project

5. Click "Project Settings" and select the "Upload Client Settings" tab

You can change any of these settings and click "Save Changes" to have them apply to all subsequent upload actions.