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. If the file is larger than ten GB, register it from a Globus endpoint or an AWS S3 bucket rather than from your file system. (To update metadata, refer to Updating Data File Metadata via the CLU.)
To register a data file:
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 registering from your file system, specify the metadata that you want to include. Click the following link to view the syntax:
|
To extract metadata from the header of TIFF or BMP image files, include the following line:
|
If you are registering from a Globus endpoint, specify that endpoint, the file path on that endpoint, and the metadata that you want to include. Click the following link to view the syntax:
|
If you are registering from AWS S3, specify the S3 bucket, path, access key, secret access key, region, and the metadata that you want to include. Click the following link to view the syntax:
|
Run the following command:
|
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:
|
[-o <output-json-file>] | An optional parameter, specifying a path and filename in your file system. The system always creates an output file:
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 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] | A path to a file in your file system:
|
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:
|
If you registered the file from a Globus endpoint, you can view the progress of the registration in the GUI. For instructions, refer to Viewing Registration Status.