NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Using the User Authorization Tool

include page

Administrators use the User Authorization tool to manage data access by users, user groups, protection groups, and roles.

...

To access and use the User Authorization Tool, you must be a TCIA an NBIA administrator.

  1. Log in to TCIA.
  2. Select Admin > User Authorization Tool.
    The User Authorization Tool appears, open to the User tab.
    User tab of the User Authentication Tool

...

Include Page
Managing Users 6.5
Managing Users 6.5

BREAK!

Once a user submits data, an administrator adds the user to TCIA. The administrator must create the user in LDAP to manage data access privileges.

Info
titleWhat to do if the user is not in LDAP

Contact the Help Desk to request that a user be added to LDAP.

Managing users involves:

...

6.5

...

Adding a User to TCIA

  1. Select Admin > User Authorization Tool.
    User tab of the User Authentication ToolImage Removed
  2. Select the User tab.

  3. Click Add User buttonImage Removed.
    The User Details dialog box appears.
    Entering User DetailsImage Removed
  4. Add the user's Login Name. The login name is not case-sensitive.
  5. Add a valid Email address of the user.
  6. To activate the user, select Active Status. To deactivate the user in TCIA, clear Active Status.

  7. Click Save buttonImage Removed to save the changes. 
    The user is added to TCIA and the table on the User tab.

Return to top of page

Finding a User

To find a user on the User tab, narrow the list by adding one or more characters to one or more column header boxes.

In the following example, the displayed users have 5523 as part of their login name and nlsc in their email address.

Example of a column searchImage Removed

Return to top of page

Updating User Information

  1. Select Admin > User Authentication Tool.
  2. Select the User tab.
  3. Click Edit User iconImage Removed.
    The User Details window appears.
    Entering User DetailsImage Removed

  4. Update the Email address as needed. The Login Name cannot be updated.

  5. For an active user, maintain Active Status. To deactivate the user in TCIA, clear Active Status.

  6. Click Save to save the changes.
    The user information is updated in the table.

Return to top of page

Deactivating a User

A user cannot be deleted from TCIA, only deactivated.

...

Select the User tab.

...

...

Click Edit User iconImage Removed.
The User Details window appears.
Entering User DetailsImage Removed

...

Clear the Active Status box and then click Save.
The user's Active Status value changes to False.

Return to top of page

Managing Protection Groups

A TCIA administrator uses the Protection Group tab to add protection groups and assign protection elements to limit data access and visibility by image collection and site(s).

Info
titleProtection elements are created automatically
TCIA automatically creates protection elements when data is submitted based on the image collection and site(s).

Managing protection groups involves:

Adding a Protection Group

  1. From the Protection Group tab, click Add Protection Group.
    The Add Protection Group window appears.
    Adding a Protection GroupImage Removed

    The following table lists and describes protection group information.

    Name

    Description

    Protection Group Name

    Start the name with "NCIA” and enter your name of choice.

    Info
    titleNo Special Characters

    Do not use special characters such as # or \ in group names.

    Protection Group Description

    Add a description (optional).

  2. Click Save buttonImage Removed to save the changes. 
    The protection group is added to the table.

Return to top of page

Associating Protection Elements with a Protection Group

Once you create the necessary protection group(s), assigning the associated protection element(s) is the beginning of setting up security for a collection's visibility in TCIA. The protection element identifies the collection, as well as the site, associated with the data.

Info
titleData Access and Protection Elements
If the protection element is set to Public, a user can be assigned the Public role and have access. For limited access to the data, assign a user to a protection group and a role that allows the user data access.

To associate a protection element with a protection group

  1. On the Protection Group tab, find the protection group.
  2. Click Assign Protection Group iconImage Removed in the Assign Protection Element column.
    The Add Protection Element(s) to Protection Group window appears.
    Assigning Protection Elements to a Protection GroupImage Removed
  3. Click Available Protection Elements.

  4. Select the elements to be associated with the protection group.

    Info
    titleNarrowing a List

    To narrow a list, type the name or part of the name next to the magnifying glass icon (Magnifying Glass Icon to narrow list of Protection ElementsImage Removed).

  5. Click Add buttonImage Removed to save the changes.

  6. The Associated Protection Element(s) column lists the elements that you added.

    In the following example protection element, NCIA.SportInjury//ACL

    • NCIA.SportInjury is the collection.
    • ACL is the site.

      Info
      titleMultiple Sites

      If there are multiple sites for a collection, you might want to create a protection group for each site. This process would grant access to verify submissions per site.

Return to top of page

Removing Protection Elements from a Protection Group

  1. Click Remove Protection Element IconImage Removed in the Remove Protection Element(s) column.
    The Remove Protection Element(s) from Protection Group window appears.
    Remove Protection Elements from Protection GroupImage Removed
    The Protection Group Name cannot be changed.
  2. Click Included Protection Elements, and select the elements to remove.

    Info
    titleNarrowing a List

    To narrow a list, type the name or part of the name next to the magnifying glass icon (Magnifying Glass Icon to narrow list of Protection ElementsImage Removed).

    Click x to return without saving.

  3. Click Remove buttonImage Removed to save the changes. 
    The protection element(s) is no longer listed in the Associated Protection Elements column.

Return to top of page

Finding a Protection Group

On the Protection Group tab, you can perform a global search or a column search both described in the following table.

Tip

 You can perform both searching techniques to further filter a list, but do not forget to clear the search boxes to expand the list.

...

You can search for a term or part of a term in all the protection group columns in the table. All protection groups with the characters you entered are returned.

In the following example, a Global Search of colonography finds protection groups with the word in the Protection Group name and the Associated Protection Elements.

Global Search for Protection GroupImage Removed

...

You can also find protection groups in the table by adding a term to a column header or more than one column header to further narrow the list.

In the following example, bbb in the Protection Group column and demo in the Description column, displays two results.

Column Search for Protection GroupImage Removed

Return to top of page

Updating a Protection Group Description

  1. On the Protection Group tab, find the protection group you want to update.
  2. Click Edit Protection GroupImage Removed.
    The Protection Group Details window appears.

  3. Update the group description.
    Note that you cannot update the protection group name.

  4. Click Save buttonImage Removed to save the changes.

Return to top of page

Deleting a Protection Group

  1. On the Protection Group tab, find the protection group you want to delete.
  2. Click Edit Protection GroupImage Removed.
    The Protection Group Details window appears.

  3. Click Delete buttonImage Removed.
    The row is removed from the table.

Return to top of page

Managing User Groups

TCIA administrators create user groups to limit data access and visibility by protection group and user role. Before or after creating user groups, you can assign users and roles to protection groups.

Managing user groups involves:

Viewing Protection Groups and Roles Associated with a User Group

  1. Select Admin > User Authentication Tool.
  2. Select the User Group tab.

    User Group tab in the User Authentication ToolImage Removed

  3. Click the arrow in the first column to see the protection group(s) and role(s) associated with the user group in that row.
    User Group tab, first two columnsImage Removed
    The row expands to show the protection group(s) and role(s) associated with that user group.
    User Group tab, protection groups and roles visibleImage Removed

Return to top of page

Modifying Protection Groups and Roles for a User Group

  1. View the protection group(s) and role(s) for a selected user group.
  2. Click Edit Association buttonImage Removed.
    The Modify Authorization for Selected User Group window appears.
    Modify Authorization for Selected User GroupImage Removed
  3. To change the roles associated with this protection group, open the Role list. Click or clear the checkboxes you want to add or remove, respectively. Click Update Role buttonImage Removed.
  4. To remove this protection group from this user group, click Remove PG buttonImage Removed.

Return to top of page

Assigning a Protection Group and Role to a User Group

You can associate a user group with a protection group and one or more roles.

To assign a protection group and role to a user group

  1. Select Admin > User Authentication Tool.
  2. Select the User Group tab.

    User Group tab in the User Authentication ToolImage Removed

  3. In the row associated with the user group whose access you want to specify, click Plus buttonImage Removed.
    The Add Protection Group to Selected User Group window appears.

  4. Open the Protection Group list and click one protection group to select it. 

    Info
    titleNarrowing a List

    To narrow the list of protection groups, type the name or part of the name next to the magnifying glass icon (Magnifying Glass Icon to narrow list of Protection ElementsImage Removed). All protection groups with the characters you entered are returned.

    Add Protection Group to Selected User Group window with the Protection Group list openedImage Removed 
    The list closes and shows your selection in the window.

  5. Open the Role list and and click the box to the left of each role you want to assign to the selected protection group. 

    Info
    titleNarrowing a List

    To narrow the list of roles, type the name or part of the name next to the magnifying glass icon (Magnifying Glass Icon to narrow list of Protection ElementsImage Removed). All protection groups with the characters you entered are returned.

    Add Protection Group to Selected User Group window with the Role list openedImage Removed
    The list closes and shows your selection(s) in the window.

  6. Click Save buttonImage Removed.
    The user group is now associated with the selected protection group and roles.

Return to top of page

Deleting a User Group

Deleting a user group does not delete the users in it.

To delete a user group

  1. Select Admin > User Authentication Tool.
  2. Select the User Group tab.

    User Group tab in the User Authentication ToolImage Removed

  3. In the row of the user group you want to delete, click Cut iconImage Removed.
    The Delete the Following Group? window appears.
  4. Click Delete buttonImage Removed.
    The user group no longer appears in the list.

Return to top of page

Adding Protection Groups and Assigning Roles

A TCIA administrator creates protection groups to limit data access and visibility by image collection and site(s). Administrators add users to protection groups and can then further manage their access by assigning them one or more roles. Users can only access the protection group data in the way that the role specifies.

For example, John Smith needs to be a curator within the Mouse Astrocytoma protection group, so user johnsmith is assigned to protection group TCIA Mouse Astrocytoma with the role of CURATOR.

Topics in this section include:

Adding a Protection Group

  1. Select Admin > User Authentication Tool.
  2. Select the Protection Group tab.
  3. Scroll down to the bottom of the page and click Add Protection Group buttonImage Removed.
    The Protection Group Details window appears.
    Protection Group Details windowImage Removed
  4. Enter a name for the new group and optionally, a description.

    Info
    titleNo Special Characters

    Do not use special characters such as # or \ in group names.

  5. Click Save buttonImage Removed.
    The protection group appears on the Protection Group tab.

Return to top of page

Assigning a User to a Protection Group with Roles

Info
titleSuper Administrator

If you are a Super Administrator for one protection group, your privileges extend to all of the protection groups.

To assign a user to a protection group and assign roles

...

Select the User Authorization tab.

TCIA User Authorization ToolImage Removed

...

Select a user from the list.
A page listing the protection groups and access roles associated with the selected user opens.
User Authorization tab of the User Authorization toolImage Removed

...

Click Add Protection Group and Access Role buttonImage Removed.
The Grant Access to Selected User window opens.
Grant Access to Selected User pageImage Removed

...

From the Role list, select the access role that the user should have in that protection group.
The following table lists and describes the access roles available in TCIA.

...

Access the User Authorization Tool to manage users

...

Add or modify curation data

...

Super Administrator role for deletions

...

Manage collection descriptions

...

Access the Quality Control (QC) Tool

...

Public role for searching

...

Super Administrator role for approving deletions

...

Access the Submission Reports option to verify submissions.

...

The row is added to the table.

Info
titleWorking with the table

To adjust how the table is sorted, click the arrows in the column header. To narrow the list, type the name or part of the name in the column header. You can also enter information in multiple column headers to further narrow the list.

Return to top of page

Changing a User's Access Role Within a Protection Group

  1. Select Admin > User Authentication Tool.
  2. Select the User Authorization tab.

    TCIA User Authorization ToolImage Removed

  3. Select a user from the list.
    A page listing the protection groups and access roles associated with the selected user opens.
    User Authorization tab of the User Authorization toolImage Removed

  4. In the row of the protection group you want to change, click Update Access iconImage Removed.
    The Grant Access to Selected User dialog box opens.

    Grant Access to Selected User, UpdateImage Removed

  5. To change the user's access to roles in this protection group, click the down arrow to open the Role list. Select the boxes next to roles you want to assign to the selected user. Clear the boxes next to roles you do not want the user to have. Click Update buttonImage Removed to save your changes.

    To delete a role, open the Role list, select a role, and click Delete buttonImage Removed.

    The User Authentication tab appears.

Return to top of page

Resolving Errors in the User Authorization Tool

The following table lists and describes how to resolve error messages returned by the User Authorization Tool (UAT). Error messages appear in a red box.

Info
titleInfo Messages

Messages in a blue box, such as Info: Request sent to server. or Info: Sent., indicate that a request was sent to the server to save, update, or delete an item.

...

You performed a search and there were no results. Enter different search criteria.

If a selected user has not been assigned to a protection group with a role, you will receive the following message:

Error: No data found from server.

...

Error: Error occurred while retrieving data from server. Check the server connection please.

Error code: <a number>

...

Include Page
Managing Protection Groups 6.5
Managing Protection Groups 6.5

Return to top of page

Managing User Groups

Include Page
Managing User Groups 6.5
Managing User Groups 6.5

Return to top of page

Adding Protection Groups and Assigning Roles

Include Page
Adding Protection Groups and Assigning Roles 6.5
Adding Protection Groups and Assigning Roles 6.5

Return to top of page

Resolving Errors in the User Authorization Tool

Include Page
Resolving Errors in the User Authorization Tool 6.4
Resolving Errors in the User Authorization Tool 6.4

Return to top of page