Page History

...

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:

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

...