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: Replaced "file system" with "local system" for HPCDATAMGM-1598.

...

To register a data file:

  1. In your file local system, create a JSON file that specifies the metadata for the new data file. Click the following link to view the syntax:

    Panel
    borderColor#C0C0C0
    borderStylesolid
    Expand
    titleSyntax
    Code Block
    { 
        "metadataEntries": [
          {
            "attribute": "description",
            "value": "my-dataObject-description"
          },
          {
            "attribute": "example_date",
            "value": "20201231",
            "dateFormat": "yyyyMMdd"
          }
        ]
    }
  2. 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.

  3. Include Page
    shared step - create or update parent collection while registering data file
    shared step - create or update parent collection while registering data file
  4. Run the following command:

    Panel
    borderColorsilver
    borderStylesolid
    Clipboard
    AllowLineWraptrue

    dm_register_dataobject_multipart <description.json> <destination-path> <source-file>


    The following table describes each parameter:

    ParameterDescription
    [-h]If you want to print a usage (help) message for this command, specify this option.
    <description.json>
    A path to the JSON file that specifies the metadata for the new data file.
    <destination-path>
    A path within DME, including the name of the file you intend to register. Specify where you want the system to create the new data file. (If you specify an existing data file, this command updates the metadata for that data file. For details, refer to Updating Data File Metadata via the CLU.)
    <source-file>

    If you are registering from your file local system, use this parameter to specify the file that you want to register.

For example, the following command registers the data.txt file from the JaneDoe folder in the file local system to the Project_New collection in DME:

...