Page History

page-info

:title}

This chapter describes the process for creating and managing user accounts in caIntegrator. It also discusses the processes for managing ownership and  access to studies in caIntegrator.  

This chapter includes the following topics.
{toc:minLevel=2}

{info:title=Note} The options for performing user management tasks are visible in caIntegrator on the left sidebar of the browser only if you have these Admin privileges.{info}

h2. Overview of Administering caIntegrator User Accounts Using UPT
{tip:title=New User?} If you are interested in registering an account in caIntegrator, see [Registering as a New caIntegrator User|caIntegrator:1 - Getting Started with caIntegrator#RegisteringasaNewcaIntegratorUser].{tip}

In caIntegrator, all tasks related to creating and managing user accounts can be performed only by a caIntegrator administrator using the CBIIT User Provisioning Tool (UPT) v. 4.2. The following sections discuss the use of the UPT for performing these tasks. For further information about UPT, see Chapter 3 of the [CSM 4.2 Programmer's Guide|https://gforge.nci.nih.gov/docman/view.php/12/18945/caCORE_CSM_v42_ProgrammersGuide.pdf]. 

The UPT is a separately installed application which serves as the user management interface for all National Cancer Institute CBIIT Life Sciences Distribution (LSD) applications, including caIntegrator. The UPT application is the central point for all user management functionality within caIntegrator. You can use UPT to add new users and to apply user group assignments to the caIntegrator database directly. The UPT groups can refer to predefined groups such as Study Manager or Study Investigator, which determine what roles the user has.

The following terms are used both in this chapter and in the UPT to define user-related roles:
* *User* – a person who is accessing caIntegrator. The user has an associated account and user ID.
* *User Group* – a group of users, typically grouped by organization and role, for example, "Columbia University Study Managers"
* *Protection Group* – a group of studies given a secure status and typically grouped by organization, for example, "Columbia University Protected Studies".

h2. Workflow for Creating User Access to caIntegrator
The following steps summarize the process for establishing user access to caIntegrator:
# A potential user requests a user account in caIntegrator. See [Registering as a New caIntegrator User|caIntegrator:1 - Getting Started with caIntegrator#RegisteringasaNewcaIntegratorUser].
# You, as a caIntegrator administrator, check if the *User* already exists in caIntegrator. If not, create the new user. See [#Creating a New caIntegrator User].
# Check if the requestor's *User Group* already exists in caIntegrator. If not, create a new *User Group. See [#Creating a New User Group].
# Check if the *Protection Group* (for example, "Columbia University Protected Studies"), containing the studies to which this user wants access currently exists. If not, create a new *Protection Group*. See [#Creating a New Protection Group]. 
{info:title=Protection Group Access} If the Protection Group already exists, contact the Organizational Contact person to confirm that it is OK to give this person access to this Protection Group.{info}
# Give the requestor's *User Group* access to the *Protection Group{*}. See [#Assigning a User Group to a Protection Group].
# Add the *User* to the *User Group{*}. See [#Adding a User to a User Group]. 

h3. Creating a New caIntegrator User
To create a new User in caIntegrator, follow these steps:
# Log into UPT as a caIntegrator Admin.
# Search to see if the user already exists.  Click the *User* menu option. 
# On the User page that opens, click *Select an Existing User*.
# Use the form and search for the user.  If you define no criteria, UPT returns a list of all caIntegrator users currently in the system. See the following figure for an example. 
!UPT search user80.png|vspace=4, border=1, alt="The example shows a list of current caIntegrator users in UPT after a user search"!
# If the user does not already exist (is not listed in the search results), then create a new user. To do so, select the *User* menu option again, then click *Create a New User{*}. This opens the page for creating a new caIntegrator user. 
# Enter details only for the following required fields:
** *User Login Name*
** *User First Name*
** *User Last Name*
** *User Password*
{note:title=Caution} If the requestor is an LDAP user, then the User Login Name must match the LDAP login ID AND the User Password field must be left blank.  If the requestor is not an LDAP user, then provide a password.{note}
# Click *Add* to confirm the new user.

h3. Creating a New User Group
You can assign a user group to a protection group. The advantage of working with a user group is that you do not have to assign roles to each user individually. You can assign users to a user group to which you assign a role, and then assign that user group to the protection group, or you can assign a role collectively to a protection group after it is created.

To create a new user group in caIntegrator, follow these steps:
# Login to UPT as caIntegrator Admin.
# First search for an existing group that the user wishes to join. Click the *Group* menu option.
# On the Group page that opens, click *Select an Existing Group{*}.
# Use the form and search for the group.  If you define no criteria, UPT returns a list of all caIntegrator groups currently in the system  
# If a user group does not already exist, then create a new user group. Click the *Group* menu option,  then click *Create a new Group{*}.
# On the form that opens, enter a unique *Group Name* and a description, if appropriate. Click *Add{*}.
{info:title=Naming Convention} The recommended naming convention for a new User Group is *_\[insert organization name\] Study \[insert role\]s{*}._  Example:  "Columbia University Study Managers".{info} 

h3. Creating a New Protection Group  
If you prefer that a study or group of studies have limited access, you can assign a user or user group to a particular protection group and assign roles which allow the users in the protection group study access. A protection group provides security or limited access for studies listed there. 

To create a new protection group in caIntegrator, follow these steps:
# Login to UPT as caIntegrator Admin.
# Click the *Protection Group* menu option.
# On the page that opens, click *Create a New Protection Group{*}. The page opens for defining PG Group details, shown in the following figure. 
# Enter a unique *Protection Group Name* and *Description*, if appropriate. Click *Add{*}.
{info:title=Naming Convention} The recommended naming convention is *_\[insert organization name here\] Protected Studies{_}{*}.  Example:  "Columbia University Protected Studies".{info}

h3. Assigning a User Group to a Protection Group
To give a user group access to a protection group (a group of protected studies), follow these steps:
# Login to UPT as caIntegrator Admin.
# Find the user group that you want to assign.  
# Click the *Group* menu option and click *Select an Existing Group{*}. 
# In the page that opens, click *Search{*}.  If you define no criteria, UPT returns a list of all caIntegrator groups currently in the system. An example is shown in the following figure. 
!UPT search groups80.png|vspce=4, border=1, alt="Example UPT page showing Group search results. See text."!
# Select the radio button next to the group name you want to assign to the protection group, and click *View Details*. This opens the Group Details page. An example is shown in the following figure. 
!UPT NCI Study Managers group80.png|vspace=4, border=1, alt="Example UPT page showing details for a selected group: group name, group description, group update date and a host of buttons for continuing to configure users and groups, such as associated users, protection groups, and so forth. See text."!
# Below the group details, click *Associated PG & Roles*. The page that opens, shown in the following figure, displays any PG to which the user group is already assigned. 
!UPT group PG and roles80.png|vspace=4, border=1, alt="Example UPT page that shows any PGs to which the selected user group is already assigned"!
# Below the group name, examine if the protection group of your choice is already listed there. If so, this means your user group is already assigned to the protection group of choice, and you can skip the remainder of the steps in this section.  If the Protection Group is not listed there, then click *Back{*}.
# Back on the User Group details page, click *Assign PG & Roles{*}. This opens the Group, Protection Group and Rules Association page where you can assign a role to the user.  caIntegrator roles are defined in the following table:
||*_Role Name_*||*_Role Definition_*||
|STUDY_MANAGER_ROLE|Assigning this role allows the user to modify existing studies, create new studies, and deploy existing studies.|
|STUDY_INVESTIGATOR_ROLE|Assigning this role allows the user to search the study, save queries about the study and perform analyses.|
|PLATFORM_MANAGER_ROLE|Assigning this role allows the user to create and delete array platforms for the entire caIntegrator installation.  *Caution{*}:  Array platforms are shared by all users and studies in the caIntegrator installation. A user with this role can affect the platforms that are used by by all users and studies in the caIntegrator installation.|
# If this user group is a group of study managers, then select STUDY_MANAGER_ROLE.  If this user group is a group of study investigators, then select  STUDY_INVESTIGATOR_ROLE. AFter making your selection, click *Assign{*}.
# Click *Update Association* at the bottom of the page. This completes the assigning of the user group to the protection group you chose.
{info:title=Roles Across Groups} If a *User* has the STUDY_MANAGER_ROLE role for more than one *Protection Group*, then any study that the *User* creates will be assign to each of those *Protection Groups{*}.{info}

h3. Adding a User to a User Group
To add a user to an existing user group, follow these steps:
# Log into UPT as caIntegrator Admin.
# Find the user that you want to assign to a user group.  Click the *User* menu option, then click *Select an Existing User{*}.
# Enter the name of the user you are looking for and click *Search{*}.  If you define no criteria, UPT returns a list of all caIntegrator users currently in the system, as shown in the following figure. 
!UPT search user80.png|vspace=4, border=1, alt="Example UPT page showing a list of current caIntegrator users. See text."!
# Select the radio button next to the name and click *View Details*. The User Details page open, showing brief details about the user you selected. 
# Click the *Associated Groups* button at the bottom of the page. This opens the page where you can assign a user to a group, as shown in the following figure. 
!UPT user and groups page75.png|vspace=4, border=1, alt="Example UPT page for assigning a user to user groups. See text."!
# Select one or more groups that you want the user to be in and click *Assign*.
# At the bottom of the page click *Update Association*. This completes the assigning of the user to the user group. Now the user will have access to any studies to which the user group has been given access.
{tip:title=User in Multiple Groups} You can add a user  to more than one user group.  For example, a user could be assigned to "Columbia University Study Managers" as well as to "Columbia University Study Investigators".{tip}

h3. Changing a User Password
To change a password for a user, follow these steps:
# Confirm if the user is an LDAP user or not.  If the user is an LDAP user, then this person must change their password using the NCI password change utility.  Skip the rest of these steps. If the user is not an LDAP user, then continue with the rest of these steps.
# Log into UPT as caIntegrator Admin.
# Find the user that you want to change.  Click the *User* menu option, then *Select an Existing User{*}.
# Enter the name of the user you are looking for and click *Search{*}. If you define no criteria, UPT returns a list of all caIntegrator users.
# Select the radio button next to the name and click *View Details*.
# In the page that opens, shown in the following figure, replace the *User Password* and *Confirm Password* fields with the new password.
!UPT user details change password80.png|vspace=4, border=1, alt="Example UPT page where you can edit user details, such as a password"!
# At the bottom of the page click *Update*.

{scrollbar:icons=false}