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: For each single-line code, replaced the Code Block macro with a Panel macro and Text to Copy macro.

...

  1. Consider the metadata requirements for the type of collection that you intend to update: 
    • 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 collection, as follows:

    Code Block
    {
        "metadataEntries": [
            {
             "attribute": "project",
             "value": "my-project-name"
            },
            {
             "attribute": "notes",
             "value": "my-project-notes"
            }
        ]
    }
  3. Include Page
    shared step - update parent collection while updating collection or data file
    shared step - update parent collection while updating collection or data file
  4. Run the following command:

    code
    Panel
    borderColorsilver
    borderStylesolid
    Clipboard
    AllowLineWraptrue

    dm_register_collection

    [optional

    parameters]

    <description.json>

    <destination-path>


    The following table describes each parameter:

    ParameterDescription
    [-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 within a file system, including the name of the JSON file that specifies the metadata for the collection you intend to update.
    <destination-path>
    A path within DME, including the name of the collection you intend to update. (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 updates the Project1 collection within the PI_Lab1 collection, based on the metadata in the my-collection.json file:

code
Panel
borderColorsilver
borderStylesolid
Clipboard
AllowLineWraptrue

dm_register_collection

my-collection.json

/Example_Archive/PI_Lab1/Project1


The JSON file must contain metadata for the collection, Project1.  

...