NIH | National Cancer Institute | NCI Wiki  

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. In your file 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": "my-second-attribute-name",
            "value": "my-second-attribute-value"
          }
        ]
    }
  2. Include Page
    shared step - create or update parent collection while registering data file
    shared step - create or update parent collection while registering data file
  3. Run the following command:

    code
    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 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 system to the Project_New collection in DME:

code
Panel
borderColorsilver
borderStylesolid
Clipboard
AllowLineWraptrue

dm_register_dataobject_multipart

/cygdrive/c/Users/JaneDoe/my-metadata.json

/Example_Archive/PI_Lab1/Project_New/Data.txt

/cygdrive/c/Users/JaneDoe/data.txt