Page History

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. 

The character limit for each metadata value is 2700.

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 local 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": "collectionexample_typedate", "value": "Folder" } ] }

   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": "project20201231", "valuedateFormat": "my-project-nameyyyyMMdd" }, { "attribute": "collection_type", "value": "Folder" } ], "createParentCollections": true, "parentCollectionsBulkMetadataEntries": { "defaultCollectionMetadataEntries": [{ "attribute": "collection_type", "value": "Folder" }] } }] }

3. 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.

4. Include Page
   shared step - update parent collection while updating collection or data file shared step - update parent collection while updating collection or data file

5. Run the following command:

   Panel
   borderColor silver borderStyle solid
   Clipboard AllowLineWrap true dm_register_collection [optional parameters] <description.json>

   Run the following command:

   Code Block
   dm_register_collection <description.json> <destination-path>

   
   

   The following table describes each parameter:

   Parameter	Description
   [-h]	If you want to print a usage (help) message for this command, specify this option.
   [-D <REST-response>]	An optional parameter, specifying a path and filename in your local system. The system always creates a response file: If you specify this parameter, the system saves the response from the server to the specified file in the specified location. If you omit this parameter, the system saves the file as collection-registration-response-header.tmp in your home directory.
   [-o <output-json-file>]	An optional parameter, specifying a path and filename in your local system. The system always creates an output file:  If you specify this parameter, the system saves the output to the specified file in the specified location. If you omit this parameter, the system saves the output as collection-registration-response-message.json.tmp in your home directory. If the command is successful, the output file is empty.
   <description.json>	A path to within a local system, including the name of the JSON file that specifies the metadata for the new collection you intend to update.
   <destination-path>	A path within DME, including the name of the collection you intend to createupdate. Specify where you want the system to create the new collection.(If you specify a collection that does not already exist, the command creates a new collection. For details, refer to Creating an Empty Collection via the CLU.)

   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:

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. For instructions on performing similar tasks in the GUI, refer to Registering Data via the GUI. Project1.