NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Replaced "/cygdrive/c/Users/JaneDoe" with "/NCI/JaneDoe" after discussion with Udit.
Excerpt
hiddentrue

dm_add_bookmark

Note

This page is a work in progress.

Include Page
shared info - bookmark intro
shared info - bookmark intro
This command also allows the system administrator or group administrator to If your user account has the group administrator or system administrator role, the dm_add_bookmark command also allows you to add a bookmark for another user . The administrator can also set and set permissions for that user at the same time.

Code Block
dm_add_bookmark <bookmark_name> <description.json> [REST-response]

The following table describes each parameter:

...

With the same command, you can provide permissions for a group of users, or for a user account that does not exist as a DME user yet. 

  1. In your local system, create a JSON file that specifies the path within DME for the bookmark. For general usage information about the dm_add_bookmark command, refer to Adding a Bookmark via the CLU. As an administrator, you can specify additional parameters (userId and permission) in the JSON file

...

  1. :

    Code Block
    {
     "path" : "/Path/To/Bookmark",
     "

...

  1. userId" : "

...

  1. user ID 

...

  1. or group name

...

  1. "

...

  1. ,
     "permission": "The permission to set for the path, in ALL CAPS"
    }

    The

...

  1. system accepts the following capitalized values for the permission field:

    • OWN
    • WRITE
    • READ
  2. Run the dm_add_bookmark command as described in Adding a Bookmark via the CLU. The system responds as follows:

    • If your JSON file specifies a bookmark path for an existing DME user, but does not specify a permission level for that user, then the system leaves the existing permission level as it is.

...

    • If your JSON file specifies an NIH user account that does not exist as a DME user yet, and specifies a permission level for that user, the system creates that user in DME with the specified permission level.
    • The system creates the user in the DOC with which you are affiliated, and does not set a base path.
  1. Ask the specified user or group of users to

...

  1. log out of DME and log in again.

...

  1.  

For instructions on performing similar tasks in the GUI, refer to example, consider the following pagescommand:

...

Panel
borderColorsilver
borderStylesolid
Clipboard
AllowLineWraptrue

dm_add_bookmark MyCollection /NCI/JaneDoe/my-bookmark.json


With the following code in the specified my-bookmark.json file, the command gives the doejohn9 user Write access to the PI_Lab1 collection, creates a bookmark named MyCollection for that user, and associates the bookmark with the PI_Lab1 collection:

Code Block
{
 "path" : "/Example_Archive/PI_Lab1",
 "userId" : "doejohn9",
 "permission": "WRITE"
}

...