NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: For HPCDATAMGM-1056: Added help (-h) parameter.

...

  1. Consider the metadata requirements for the type of collection that you intend to create: 
    • What are the required attributes for this collection type?
    • What are the acceptable values and default values for each attribute?
  2. In your file system, create a JSON file that specifies the metadata for the new collection, as follows:

    Code Block
    {
        "metadataEntries": [
            {
             "attribute": "project",
             "value": "my-project-name"
            },
            {
             "attribute": "collection_type",
             "value": "Folder"
            }
        ]
    }
  3. In your JSON file, if you want to create a parent collection for the empty collection, also specify the metadata for the parent collection, as follows:

    Code Block
    {
        "metadataEntries": [
            {
             "attribute": "project",
             "value": "my-project-name"
            },
            {
             "attribute": "collection_type",
             "value": "Folder"
            }
        ],
        "createParentCollections": true,
        "parentCollectionsBulkMetadataEntries": 
            {
            "defaultCollectionMetadataEntries": 
                [{
                "attribute": "collection_type",
                "value": "Folder"
                }]
            }
    }
  4. Run the following command:

    Code Block
    dm_register_collection [-h] <description.json> <destination-path>

    The following table describes each parameter:

    ParameterDescription
    -hIf 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 collection.
    <destination-path>
    A path within DME, including the name of the collection you intend to create. Specify where you want the system to create the new collection.

    The command registers the metadata specified in <description.json> to the <destination-path> in DME. 

...