Page History

If your If your user account has the Read, Write , or Own permission level on a collection, the following command allows you to download on an existing collection in DME, and if that existing collection has been configured to contain data files, you can register a data file in that collection to your file system:

dm_download_dataobject [optional parameters] <source-path> <destination-file>

...

into that collection. 

The character limit for each metadata value is 2700.

To register a data file:

1. In your local 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 borderStyle solid
   Expand title Syntax Code Block { "metadataEntries": [ { "attribute": "description", "value": "my-dataObject-description" }, { "attribute": "example_date", "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:

   Panel
   borderColor silver borderStyle solid
   Clipboard AllowLineWrap true dm_register_dataobject_multipart <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.

...

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 do not specify this parameter, the system saves the file as download-dataobject-response-header.tmp in your home directory.

...

<source-path>

...

<destination-file>

...

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

The following example downloads a sample.txt file from the Project_Orig collection in DME to a JaneDoe folder in Windows.