NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: For each single-line code, replaced the Code Block macro with a Panel macro and Text to Copy macro.

...

  1. In your file system, create a JSON file that specifies a list of source and destination locations, as follows:

    Code Block
    {
     "moveRequests": [
      {
       "sourcePath": "<full path in DME to the file/collection to be moved>"
       "destinationPath": "<full path in DME to the new file/collection>"
      },
      {
       "sourcePath": "<full path in DME to the file/collection to be moved>"
       "destinationPath": "<full path in DME to the new file/collection>"
      }
     ]
    }
  2. Make sure that each sourcePath and destinationPath pair in the JSON file meets the following criteria:
    • In the value of your destinationPath, the last part (collection name or data file name) is new.

    • In the value of your destinationPath, the parent collection already exists.

  3. Run the following command:

    code
    Panel
    borderColorsilver
    borderStylesolid
    Clipboard
    AllowLineWraptrue

    dm_rename

    [optional

    parameters]

    <move-description.json>


    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 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 rename-response-header.tmp in your home directory.
    [-o <rename-status-file>]

    An optional parameter, specifying a path and filename in your file system. The system always creates a status file:

    • If you specify this parameter, the system saves the status to the specified file in the specified location.
    • If you omit this parameter, the system prints the status to standard output and saves the status as rename-response-message.json.tmp in your home directory.

    The status includes a result for each request (each source path and destination path pair). If the system was able to satisfy the request, the result is true. Otherwise, it's false. The status file provides an explanatory message in these cases.

    The status also includes an overall result. If all request statuses are true, then the overall result is true. Otherwise, it's false.

    <move-description.json>A path to the JSON file containing the source and destination locations.

For example, consider the following command:

code
Panel
borderColorsilver
borderStylesolid
Clipboard
AllowLineWraptrue

dm_rename

/cygdrive/c/Users/JaneDoe/my-move-list.json


With the following code in the my-move-list.json file, the command renames a collection from Project_Orig to Project_New and then renames a file from File_Orig to File_New:

...