NIH | National Cancer Institute | NCI Wiki  

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 character limit for each metadata value is 2700.

To register a data file:

  1. In your local 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": "example_date",
            "value": "20201231",
            "dateFormat": "yyyyMMdd"
          }
        ]
    }
  2. For each date attribute, specify one of the following date formats, and specify the date value in that format:

    • yyyyMMdd
    • yyyy.MM.dd
    • yyyy-MM-dd
    • yyyy/MM/dd
    • MM/dd/yyyy
    • MM-dd-yyyy
    • MM.dd.yyyy

    The system parses your date using the date format you specify. Then however, if the date attribute has a metadata validation rule in a different format, the system stores the date in the format specified by that rule.

  3. 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"
    				}]
    		}]
    	}
    }
  4. 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 local 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 local system to the Project_New collection in DME:

dm_register_dataobject_multipart /NCI/JaneDoe/my-metadata.json /Example_Archive/PI_Lab1/Project_New/Data.txt /NCI/JaneDoe/data.txt

  • No labels