View Source

dm_register_dataobject

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 upload a data file to that collection.

To register a data file:

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.

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:

{ 
    "metadataEntries": [
      {
        "attribute": "description",
        "value": "my-dataObject-description"
      },
      {
        "attribute": "my-second-attribute-name",
        "value": "my-second-attribute-value"
      }
    ]
}

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:

{ 
  "source": {
    "fileContainerId": "globus-shared-endpoint-uid",
    "fileId": "file-path-on-shared-globus-endpoint"
  },
  "metadataEntries": [
    {
      "attribute": "description",
      "value": "my-file-description"
    }, 
    {
      "attribute": "my-second-attribute-name",
      "value": "my-second-attribute-description"
    }
  ]
}

Run the following command:

dm_register_dataobject [optional parameters] <description.json> <destination-path> [source-file]

The following table describes each parameter:

Parameter	Description
[-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 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 file 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 upload. Specify where you want the system to create the new data file.
[source-file]	A path to a file in your file system: If you are uploading from your file system, use this parameter to specify the file that you want to upload. If you are uploading from Globus, omit this parameter.

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

dm_register_dataobject /cygdrive/c/Users/JaneDoe/my-metadata.json /Example_Archive/PI_Lab1/Project_New /cygdrive/c/Users/JaneDoe/data.txt

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

If you uploaded the file from a Globus endpoint, you can view the progress of the upload in the GUI. For instructions, refer to Viewing Globus Upload Status.