NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Replaced "/cygdrive/c/Users/JaneDoe" with "/NCI/JaneDoe" after discussion with Udit.

If your user account has the Write or Own permission level on an existing collection in DME, and if that existing collection has been configured to contain data files, you can register a data file into that collection. The dm_register_dataobject_multipart command gets a pre-signed URL from DME and uses it to register data directly into the NCI Data Vault, instead of through DME. If the file is 50 MB or larger, the command registers the file using a multipart presigned URL. If the file is smaller than that threshold, the command registers the file using a single part presigned URL.

The character limit for each metadata value is 2700.

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  Click the following link to view the syntax:

    true
    Panel
    borderColor#C0C0C0
    borderStylesolid
    Expand
    titleSyntax
    Code Block
    Code Block
    collapse
    { 
        "metadataEntries": [
          {
            "attribute": "description",
            "value": "my-dataObject-description"
          },
          {
            "attribute": "
    my-second-attribute-name
    example_date",
            "value": "
    my-second-attribute-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:

    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 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:

code
Panel
borderColorsilver
borderStylesolid
Clipboard
AllowLineWraptrue

dm_register_dataobject_multipart

/

cygdrive/c/Users

NCI/JaneDoe/my-metadata.json

/Example_Archive/PI_Lab1/Project_New/Data.txt

/

cygdrive/c/Users

NCI/JaneDoe/data.txt