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 both of the following conditions are true, you can register a data file into an existing collection in DME: 

  • If your
Excerpt
hiddentrue

dm_register_dataobject

...

  • user account has the Write or Own permission level

...

  • on that existing collection.
  • If that existing collection has been configured to contain data files

...

To register a data file:

If the file is larger than two GB, refer to Using dm_register_dataobject_multipart

The character limit for each metadata value is 2700.

To register a data file:

  1. In your local

  2. Choose whether to upload synchronously (from your file system) or asynchronously (from a Globus endpoint). 
    • To upload from your file system, plan to use the source file parameter to specify the file that you want to upload.
    • To upload from Globus, plan to use a JSON file to specify the file that you want to upload. 
  3. In your file system, create a JSON file that specifies the metadata for the new data file. The contents of this file depend on the source of your data :

    If you are uploading from your

    file

    system, specify the metadata that you want to upload. Click the following link to view the syntax

    , as follows:

    Code Block
    collapsetrue
    { 
        "generateUploadRequestURL" : true,
        "metadataEntries": [
          {
            "attribute": "description",
            "value": "my-dataObject-description"
          },
          {
            "attribute": "
    my-second-attribute-name
    example_date",
            "value": "
    my-second-attribute-value" }
    20201231",
        
    ] }

    If you are uploading from Globus, specify the Globus endpoint, the file path on that endpoint, and the metadata that you want to upload. Click the following link to view the syntax:

    Code Block
    collapsetrue
    {
     
      
    "source":
     
    { "fileContainerId
    "dateFormat": "
    globus-shared-endpoint-uid",
    yyyyMMdd"
        
    "fileId":
     
    "file-path-on-shared-globus-endpoint"
     
    }
    ,
    
    
     
    "metadataEntries":
     
    [
      
    { "attribute": "description", "value": "my-file-description" }, { "attribute": "my-second-attribute-name", "value": "my-second-attribute-description" } ] }
    ]
    }
  4. 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.

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

    code
    Panel
    borderColorsilver
    borderStylesolid
    Clipboard
    AllowLineWraptrue

    dm_register_dataobject

    _presigned [optional parameters] <description.json>

    <destination-path>

    [source-file]

    <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.
    [-D <REST-response>]

    An optional parameter, specifying a path and filename in your 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 dataObject-registration-response-header.tmp in your home directory.
    [-o <output-json-file>]

    An optional parameter, specifying a path and filename in your 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 dataObject-registration-response-message.json.tmp in your home directory. 

    If the command is successful, the output file is empty.

    <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 uploadregister. Specify where you want the system to create the new data file.
    [source<source-file]file>

    A path to a file in your file system:

    If you are uploading from your file system, use this parameter to specify the

    local system, specifying the data file that you want to

    upload

    register.

  7. If you are uploading from Globus, omit this parameter.

For example, the following command uploads 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

/cygdrive/c/Users

_presigned /NCI/JaneDoe/my-metadata.json

/Example_Archive/PI_Lab1/Project_New

/

cygdrive/c/Users

NCI/JaneDoe/data.txt

For instructions on performing similar tasks in the GUI, refer to Registering Data via the GUI

...