NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Revised based on reply from Udit Sehgal.
Excerpt
hiddentrue

dm_register_collection

You can use a CLU command to create an empty If your user account has the Write or Own permission level on an existing collection in DME. With the same command, you can create a parent collection for the empty collection. This command has the following prerequisites for the existing collection in which you intend to create the empty collection or the parent collection of the empty collection:

  • Your user account has the Write or Own permission level on the existing collection.
  • That existing collection has been configured to contain another collection. 

use a CLU command to update the metadata of that collection. 

To update the metadata of a To create an empty collection:

  1. Consider the metadata requirements for the type of collection that you intend to createupdate
    • 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 <description.json> <destination-path>

    The following table describes each parameter:

    ParameterDescription
    <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.update.

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

For example, the following command creates a Project_New updates the Project1 collection within the PI_Lab1 collection and applies to that new collection , based on the metadata in the my-collection.json file:

Code Block
dm_register_collection my-collection.json /Example_Archive/PI_Lab1/Project_NewProject1

The JSON file must contain metadata for the new collection, Project_New. If the parent collection, PI_Lab1, does not already exist, then the JSON file must also contain metadata for that collection. Project1.  

For instructions on performing a similar tasks task in the GUI, refer to Registering Data Updating Metadata via the GUI.