XNAT Docs Index

Related Pages

 Click here to expand...
Child pages
  • Applet parameters

This documentation is for XNAT versions 1.6.0 - 1.6.5. You can find the latest documentation for XNAT 1.7 at https://xnat.org/documentation

Skip to end of metadata
Go to start of metadata

The XNAT upload applet recognizes a number of parameters that can be used to tailor applet's behavior.

You can specify parameters for the applet using the Applet Configuration settings at the project or site level.

The table below describes each parameter recognized by the applet.

 

ParameterDefault valueDescription

allow-append-on-dupe-session-labels

true

When set to true, if the user uploads a DICOM session that has the same label as an existing session, the applet will alert the user and allow them to choose between appending their incoming data to that existing session, specifying a new session label, or cancelling the upload. When set to false, the applet requires the user to either specify a new label or cancel the upload.

See also: allow-overwrite-on-dupe-session-labels, warn-on-dupe-session-labels

allow-overwrite-on-dupe-session-labelsfalse

When set to true, if the user uploads a DICOM session that has the same label as an existing session, the applet will alert the user and allow them to choose between appending their incoming data to that existing session, overwriting the existing session, or provide a new session label.. When set to false, the applet requires the user to either specify a new label or cancel the upload.

See also: allow-append-on-dupe-session-labels, warn-on-dupe-session-labels

custom-properties-url 

A URL from which the applet can load a custom properties file. This can be any URL or resource path valid for the Class.getResourceAsStream() method.

Primarily for internal use.

dev-pass 

Specifies a password to access the server specified by the xnat-url parameter.

Primarily for development use.

dev-user 

Specifies a username to access the server specified by the xnat-url parameter.

Primarily for development use.

expected-modality 

If specified, checks whether the session contains any scans that match the expected modality. The value for this should be the same as the setting in the DICOM headers, e.g. MR, CT, etc. PET scans are an exception, in that both PT (the value normally stored in the DICOM header of a PET image frame) and PET are valid values.

This is primarily for use with the XNAT visits and protocols module.

See also: xnat-protocol, xnat-visit

fixed-size-streamingtrueIndicates whether the applet should use fixed-size or chunked streaming. In practice, this should always be set to true.
jsessionid 

Provides the JSESSIONID for an existing session on the target XNAT server.

This is already provided by the standard XNAT applet launch page, but can be supplied directly to the applet when running the applet code from a debugger.

Primarily for development use.

log4j-properties-url 

A URL from which the applet can load a custom log4j properties file. This can be any URL or resource path valid for the PropertyConfigurator.configure() method.

Primarily for internal use.

n-upload-threads4Specifies the number of upload threads–i.e., concurrent uploads–the applet should use when uploading the DICOM data to the XNAT server.
warn-on-dupe-session-labelstrue

When set to true, if the user uploads a DICOM session that has the same label as an existing session, the applet will alert the userto the duplicate label. The user's options at that point are dependent on the values of the allow-append-on-dupe-session-labels and warn-on-dupe-session-labels parameters (or their default values). When set to false, the applet requires the user to either specify a new label or cancel the upload.

Note that the same logic applies if the target project is set to auto-archive, regardless of the setting of this parameter.

See also: allow-append-on-dupe-session-labels, warn-on-dupe-session-labels

window-name 

Passes the name of the window hosting the applet into the applet. The applet uses this to load a new page into the window once the upload process is completed.

This is already provided by the standard XNAT applet launch page and is set to the window hosting the XNAT applet launch page.

xnat-admin-email 

The email address for the administrator of the target XNAT system.

This is already provided by the standard XNAT applet launch page.

xnat-project 

The project into which the imaging data should be imported.

This is already provided by the standard XNAT applet launch page and is provided by the user.

See also: xnat-scan-date, xnat-subject

xnat-protocol 

Specifies the protocol with which the uploaded imaging session should be associated.

This is primarily for use with the XNAT visits and protocols module.

See also: expected-modality, xnat-visit

xnat-scan-date 

The date on which the imaging data was acquired.

This is already provided by the standard XNAT applet launch page and is provided by the user, although, unlike the xnat-project and xnat-subject parameters, the scan date may actually be unknown or unspecified.

See also: xnat-project, xnat-subject

xnat-session-label A suggested or requested session label. This may be overridden if, e.g., the specified session label already exists.
xnat-subject 

The subject to which the imaging data should be assigned.

This is already provided by the standard XNAT applet launch page and is provided by the user.

See also: xnat-project, xnat-scan-date

xnat-url 

The URL of the target XNAT server.

This is already provided by the standard XNAT applet launch page.

xnat-visit 

Indicates the visit with which the uploaded imaging data should be associated.

This is primarily for use with the XNAT visits and protocols module.

  • No labels