Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel

Contents

Table of Contents

 


Upload An Image Session

Introduced with XNAT 1.5, the import service is a customizable upload implementation for importing data into XNAT. XNAT comes with several pre-configured import implementations, but can be configured via java to meet any need.

...

Info

All parameters are optional, though the 'dest' is highly encouraged

 

overwrite

...

  • none (DEFAULT): Do not overwrite existing xml or files
  • append: Add content to existing xml & file system, but do not overwrite existing files
  • delete: Upload new data, and overwrite any existing files. 
quarantine

...

  • false (DEFAULT): follow project settings for whether new/modified archive content should go into quarantine
  • true: override project settings and place new/modified archive content in quarantine.
triggerPipelines

...

  • true (DEFAULT): run the AutoRun pipeline for any archived sessions which are modified/created by this import
  • false: Do not run the AutoRun at this time
src

...

Only used when attempting to import a previously uploaded file. You can specify multiple src attributes or separate them with commas. Example:

  • /user/cache/resources/X/files/X.zip
dest

...

Specifies intended destination. If it is empty, it will review the uploaded content and attempt to put it in the right place (or leave it in the prearchive Unassigned).

  • /prearchive
    • It will try to determine the proper project from the DICOM/ECAT headers.


  • /prearchive/projects/PROJECT
  • /prearchive/projects/PROJECT/timestamp
  • /prearchive/projects/PROJECT/timestamp/session
    • Importing to this url would allow you to merge additional content with previously uploaded content.


  • /archive
    • It will try to determine the proper project from the DICOM/ECAT headers.


  • /archive/projects/PROJECT
  • /archive/projects/PROJECT/subjects/SUBJECT
  • /archive/projects/PROJECT/subjects/SUBJECT/experiments/LABEL
    • Importing to this url would allow you to merge content with previously archived data.
import-handler

...

Defaults to standard import logic

...

("SI"). Client can specify a key using free-form text

...

which the server maps to a different implementation of the import logic. See above.

http-session-listener

...

Used by the web based zip uploader

  •  free-form text: which should uniquely identify this upload process. If this is used, an http-session variable will be created using this text as the attribute ID, and will contain process/status information.
inbody

...

Used to tell the server that the body of the message is the actual file

...

. This shouldn't be necessary if all upload tools set the Content-Type header appropriately.  But, many do not.  If your upload is failing and you can't figure out why, try setting this to true

  • true: the body of the message is the actual file
project

...

For use when not using dest attribute

...

...

  • PROJECT_ID




Refresh The Archive Catalog XML

...