NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Replaced "file system" with "local system" for HPCDATAMGM-1598.

...

  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 local system, create a JSON file that specifies the metadata for the collection, as follows:

    Code Block
    {
        "metadataEntries": [
            {
             "attribute": "project",
             "value": "my-project-name"
            },
            {
             "attribute": "example_date",
             "value": "20201231",
             "dateFormat": "yyyyMMdd"
            }
        ]
    }
  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
    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 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 file 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 within a file local 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. 

...