NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

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

This guide explains how to use the administrative features of TCIANBIA.

Panel
titleTopics in this Guide

Table of Contents
minLevel2

Administration Functions Overview

Administration privileges for TCIA are assigned by The Cancer Imaging Archive Support group, who can be reached at help@cancerimagingarchive.net or +1.385.275-8242 (ASK-TCIA).

Security applies to all administration tools in TCIANBIA. When you log into TCIANBIA, only the administration tools for which you have been granted permissions are visible in the Admin menu. Their use is described on this page.

Return to top of page

Creating a New

...

NBIA User

Only a TCIA an NBIA administrator can create new users for TCIANBIA.

Before TCIA Before NBIA users can be created, an administrator with access to the User Authorization Tool must register the NCIA application and assign an admin user to the NCIA application there. The  The administrator can then assign users to TCIA to NBIA and roles to each user. The following table describes the role structure in TCIANBIA.

Role

Functionality

NCIA.READ

Search capability

NCIA.MANAGE_VISIBILITY_STATUS

Privilege to access QC Tool

NCIA.VIEW_SUBMISSION_REPORT

Privilege to access Verify Submission

NCIA.MANAGE_COLLECTION_DESCRIPTION

Privilege to edit a collection description

NCIA.SUPER_CURATOR

Privilege to approve the deletion of image series

NCIA.DELETE_ADMIN

Privilege to execute the deletion of images approved for deletion

The roles you assign allow a user to perform tasks in TCIA. Additionally, an administrator can perform the following tasks:

...

For more information about creating new TCIA users/user groups and performing other tasks in the User Authorization Tool, see the User Authorization Tool documentation.

Return to top of page

Using the QC Tool

Include Page
Using the Quality Control Tool 6.5.2
Using the Quality Control Tool 6.5.2

Return to top of page

Deleting Image Series

As an administrator, you can assist in the two-tier process of deleting TCIA data. To do so, you must have been granted specific roles. For more information about the roles and the deletion processes, see TCIA 6 - NBIA Administrator's Guide and Manually Deleting Image Series.

Approving Image Deletions

Include Page
Approving Image Deletions 6.5
Approving Image Deletions 6.5

Return to top of page

Manually Deleting Image Series

Include Page
Manually Deleting Image Series 6.5
Manually Deleting Image Series 6.5

Return to top of page

Viewing Submission Reports

Include Page
Viewing Submission Reports 6.5
Viewing Submission Reports 6.5

Return to top of page

Accrual Report

Include Page
Accrual Report 6.5
Accrual Report 6.5

Return to top of page

Image Submission Report

Include Page
Image Submission Report 6.5
Image Submission Report 6.5

Return to top of page

Annotation Submission Report

Include Page
Annotation Submission Report 6.5
Annotation Submission Report 6.5

Return to top of page

Editing a Collection Description

Include Page
Editing a Collection Description 6.5
Editing a Collection Description 6.5

Return to top of page

Managing Workflow Items

Include Page
Managing Workflow Items 6.5
Managing Workflow Items 6.5

Return to top of page

Managing Saved Queries

You can review and delete queries saved by users in TCIA.

Info
titlePermissions

This administrative feature is available only to logged in users who have "manage visibility" privileges, as defined in UPT. For more information, see Registering a New TCIA User.

Reviewing Saved Query Information

To review a saved query

  1. Select Admin > Manage Saved Queries.
    The Manage Saved Queries page appears listing all the queries saved by TCIA users.
    Manage Saved Queries page
  2. The following information is listed for each query.

    Info
    iconfalse
    titleSorting the table

    By default the table is sorted by Query Name, but you can also sort by the Last Executed or Query Creator columns.

    Column NameDescription
    Query Name

    Click the name of the query to display the Criteria Selected by the user. The selected field name(s) and data are listed.

    Query Name Criteria Selected Image Modified

    Last ExecutedLists the date and time that the query was run.
    New Data Available
    New Data icon. Exclamation pointImage Modifiedindicates that new data is available.
    Query CreatorUser name of the person who saved the query.

Deleting a Saved Query

To delete a saved query

  1. Select Admin > Manage Saved Queries.
    The Manage Saved Queries page appears.
    Manage Saved Queries page
  2. Check the box next to the Query Creator column of a query to be removed. You can delete multiple queries at once.

    Info
    titleRemoving All Saved Queriese

    To remove all of the saved queries, check the box next to column name, Query Creator. All queries are selected.

    Delete Saved Queries page

  3. Click Remove Selected Items.
    You are prompted to confirm the deletion and the selected queries are removed.

Return to top of page

Using the User Authorization Tool

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

Topics in this section include:

Accessing the User Authorization Tool

To access and use the User Authorization Tool, you must be a TCIA 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

Return to top of page

Managing Users

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:

Adding a User to TCIA

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

  3. Click Add User button.
    The User Details dialog box appears.
    Entering User Details
  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 button 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 search

Return to top of page

Updating User Information

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

  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.

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

  3. Find the user you want to deactivate.

  4. Click Edit User icon.
    The User Details window appears.
    Entering User Details

  5. 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).

...

Adding a Protection Group

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

    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 button 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.

...

  1. On the Protection Group tab, find the protection group.
  2. Click Assign Protection Group icon in the Assign Protection Element column.
    The Add Protection Element(s) to Protection Group window appears.
    Assigning Protection Elements to a Protection Group
  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 Elements).

  5. Click Add button 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 Icon in the Remove Protection Element(s) column.
    The Remove Protection Element(s) from Protection Group window appears.
    Remove Protection Elements from Protection Group
    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 Elements).

    Click x to return without saving.

  3. Click Remove button 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.

Type of SearchPerforming a Search
Global Search

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 Modified
Column Search

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 Modified

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 Group.
    The Protection Group Details window appears.

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

  4. Click Save button 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 Group.
    The Protection Group Details window appears.

  3. Click Delete button.
    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 Tool

  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 columns
    The row expands to show the protection group(s) and role(s) associated with that user group.
    User Group tab, protection groups and roles visible

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 button.
    The Modify Authorization for Selected User Group window appears.
    Modify Authorization for Selected User Group
  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 button.
  4. To remove this protection group from this user group, click Remove PG button.

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.

...

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

    User Group tab in the User Authentication Tool

  3. In the row associated with the user group whose access you want to specify, click Plus button.
    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 Elements). All protection groups with the characters you entered are returned.

    Add Protection Group to Selected User Group window with the Protection Group list opened 
    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 Elements). All protection groups with the characters you entered are returned.

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

  6. Click Save button.
    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.

...

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

    User Group tab in the User Authentication Tool

  3. In the row of the user group you want to delete, click Cut icon.
    The Delete the Following Group? window appears.
  4. Click Delete button.
    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.

...

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 button.
    The Protection Group Details window appears.
    Protection Group Details window
  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 button.
    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.

...

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

    TCIA User Authorization Tool

  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 tool

  4. Click Add Protection Group and Access Role button.
    The Grant Access to Selected User window opens.
    Grant Access to Selected User page

  5. From the Protection Group list, select the group to which you want to assign the user.
  6. 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.

    Anchor
    accessrole
    accessrole
    Access Role
    Description of Access Role
    NCIA ADMIN

    Access the User Authorization Tool to manage users

    NCIA CURATE

    Add or modify curation data

    NCIA DELETE_ADMIN

    Super Administrator role for deletions

    NCIA MANAGE_COLLECTION_DESCRIPTION

    Manage collection descriptions

    NCIA MANAGE_VISIBILITY_STATUS

    Access the Quality Control (QC) Tool

    NCIA READ

    Public role for searching

    NCIA SUPER_CURATOR

    Super Administrator role for approving deletions

    NCIA VIEW_SUBMISSION_REPORT

    Access the Submission Reports option to verify submissions.

  7. Click Save to save the changes.

    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 Tool

  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 tool

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

    Grant Access to Selected User, Update

  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 button to save your changes.

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

    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.

UAT Error MessageResolving a UAT Error
Error:  No data found from server.

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: Session expired. Please log in again.You logged in but your session was too long and the session expired. You need to log in again.

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

Error code: <a number>

An unexpected error occurred. The error code shows a return http status code that may or may not be useful for debugging.

Return to top of page