Versions Compared

Key

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

...

If you use the NBIA Data Retriever CLI with the -v, -f, or -q options, and want to access restricted collection(s), put these options after the user credential parameters.

OptionDescription
--agree-to-licenseBypass manually entering input to agree to license when the download begins.  
-c, -C, --cli, --CLIIndicates running as a CLI app
-cd, -CD, --CD or –cdRun with classic directory naming, which organizes files in a child folder under the destination folder as follows:Collection Name > Patient ID > Study Instance UID > Series Instance UID
-d, -D <download directory>Required. The user must have write permission for the directory specified with this option.
-dd, -DD, --DD or –ddRun with descriptive directory naming, which is the default. A descriptive directory name organizes the files in a child folder under the destination folder as follows: Collection Name > Patient ID > Study Date + Study ID + Study Description (54 char max) + last 5 digits of Study Instance UID > Series Number + Series Description (54 char max) + last 5 digits of Series Instance UID
-f, -FSkip the series the user does not have access to. Force the user to download the series if the user has access. Default is false.
-l <credential file>

Required when the manifest file has series from restricted collections.

Optional when the manifest file has series from public collections only.

-m, -M, --md5, –MD5 Enable validation of the checksums of the downloaded files. Default is that checksums will not be validated.
-p, -P <password>Optional
-q, -QQuiet. Default is false.
-u, -U <user name>Optional
-v, -VVerbose. Default is false.

...