NIH | National Cancer Institute | NCI Wiki  

This page family describes how to register collections or files in DME using the Command Line Utilities (CLU). If your user account has the Write or Own permission level on an existing collection in DME, you can register data into that collection in the following ways:

  • If that existing collection has been configured to contain another collection, you can add a collection. 
  • If that existing collection has been configured to contain data files, you can add files.

You can also use the CLU to create an empty collection. 

The character limit for each metadata value is 2700.

The following table compares the functionality available with each command: 

CommandCommand Allows You To File SizeMetadata Extraction1

dm_register_dataobject 

(Using dm_register_dataobject and Updating Data File Metadata via the CLU)

Register a new file with metadata.

or

Update metadata of an existing file.

Up to 2 TB from Globus, AWS S3, or Google Cloud storage

or

Up to 10 GB from local system

Yes, for local system

dm_register_dataobject_presigned 

(Using dm_register_dataobject_presigned)

Register a new file with metadata.Up to 2 GB (recommendation) from local systemNo

dm_register_dataobject_multipart 

(Using dm_register_dataobject_multipart)

Register a new file with metadata.Up to 2 TB from local systemNo

dm_register_collection

(Creating an Empty Collection via the CLU and Updating Collection Metadata via the CLU)

Register a new collection with metadata.

or

Update metadata for an existing collection.

NANA

dm_register_directory

(Registering Directory Contents from Your Local System via the CLU)

Register a new collection from a specified directory (including subdirectories and files) with metadata.Up to 2 TB from local systemYes

Footnote 1: In the Metadata Extraction column, a "Yes" indicates you can extract metadata from the header of TIFF or BMP image files.

5 Comments

  1. Anonymous

    What is presigned?

    What if I have a large file?

    1. Hi Anonymous. Thanks for asking.

      I have revised this wiki page to indicate the file size limit or recommendation for each command.

      The Using dm_register_dataobject_presigned page provides information about that command.  

      Meanwhile, feel free to reach out to NCIDataVault@mail.nih.gov with any questions. 

      Thanks,

      Ruth

  2. Ruth, what do we mean by metadata extraction ?

    1. Hi Sunita. Thanks for the review feedback. I'll add a footnote for that column shortly. 

    2. I have added a footnote for the Metadata Extraction column. Do any of the remaining columns need any footnotes?