A bookmark allows you to quickly access a collection or data file of interest. If your user account has the Read permission level on any collection or data file in DME, you can create a bookmark on that collection or data file.
To add a bookmark:
In your file system, create a JSON file that specifies the path within DME for the bookmark, as follows:
{ "path" : "/Path/To/Bookmark" }
Run the following command:
dm_add_bookmark [optional parameters] <bookmark_name> <description.json>
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 add_bookmark-response-header.tmp in your home directory.
[-o <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 saves the status as add_bookmark-response-message.json.tmp in your home directory.
<bookmark_name> The name that you want the system to display in the GUI for the bookmark. In this name, the system allows the plus character (+) or the pound character (#), but avoid using other special characters or spaces. <description.json> A path to the JSON file that specifies the path for the bookmark. - To view the bookmark in the GUI, log out of DME and log in again. Refer to Logging In via the GUI.
For example, consider the following command:
dm_add_bookmark MyCollection /cygdrive/c/Users/JaneDoe/my-bookmark.json
With the following code in the specified my-bookmark.json file, the command creates a bookmark named MyCollection and associates it with the PI_Lab1 collection:
{ "path" : "/Example_Archive/PI_Lab1" }
If your user account has the system administrator or group administrator role, the dm_add_bookmark command also allows you to add a bookmark for another user and set permissions for that user at the same time. For information, refer to Adding a Bookmark and Permissions via the CLU.
For instructions on performing a similar tasks in the GUI, refer to Creating a Bookmark via the GUI.