NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Next »

If your user account has the Write or Own permission level on an existing collection in DME, and if that existing collection has been configured to contain data files, you can register a data file into that collection. 

The dm_register_dataobject_multipart command gets a pre-signed URL from DME and uses it to register data directly into the NCI Data Vault, instead of through DME. If the file is 50 MB or larger, the command registers the file using a multipart presigned URL. If the file is smaller than that threshold, the command registers the file using a single part presigned URL.

To register a data file:

  1. In your file system, create a JSON file that specifies the metadata for the new data file. Click the following link to view the syntax:

    { 
        "metadataEntries": [
          {
            "attribute": "description",
            "value": "my-dataObject-description"
          },
          {
            "attribute": "my-second-attribute-name",
            "value": "my-second-attribute-value"
          }
        ]
    }
  2. In your JSON file, if you want to create a parent collection for the data file you are registering (or update the metadata of a parent collection), also specify the metadata for the parent collection. Click the following link to view the syntax:  
    {
        "metadataEntries": [
            {
             "attribute": "description",
             "value": "my-file-description"
            },
            {
             "attribute": "my-second-attribute-name",
             "value": "my-second-attribute-description"
            }
        ],
        "createParentCollections": true,
    	"parentCollectionsBulkMetadataEntries": {
    		"pathsMetadataEntries": [{
    			"path": "/Example_Archive/PI_Lab1/Project_New",
    			"pathMetadataEntries": [{
    					"attribute": "collection_type",
    					"value": "Folder"
    				},
    				{
    					"attribute": "example info",
    					"value": "123456"
    				}]
    		}]
    	}
    }
  3. Run the following command:

    dm_register_dataobject_multipart <description.json> <destination-path> <source-file>

    The following table describes each parameter:

    ParameterDescription
    [-h]If you want to print a usage (help) message for this command, specify this option.
    <description.json>
    A path to the JSON file that specifies the metadata for the new data file.
    <destination-path>
    A path within DME, including the name of the file you intend to register. Specify where you want the system to create the new data file. (If you specify an existing data file, this command updates the metadata for that data file. For details, refer to Updating Data File Metadata via the CLU.)
    <source-file>

    If you are registering from your file system, use this parameter to specify the file that you want to register.

For example, the following command registers the data.txt file from the JaneDoe folder in the file system to the Project_New collection in DME:

dm_register_dataobject_multipart /cygdrive/c/Users/JaneDoe/my-metadata.json /Example_Archive/PI_Lab1/Project_New/Data.txt /cygdrive/c/Users/JaneDoe/data.txt
  • No labels