webclient.help.admin.htm Maven / Gradle / Ivy
i2b2 Administration
Welcome to the i2b2 Administration module of the project management interface.
The pages within i2b2 Admin are designed to assist with workflow and overall ease of use, individuals can easily save data and parameters for the hive, projects and users.
Manage Hive
View domain information and capture cell data and global parameters.
Manage Project
General information about the project as well as project specific cell data, parameters, and user access and roles.
Manage Users
General information about a user.
Manage Approvals
Captures general information used to authorize projects.
Project Requests
View information about submitted project requests.
The navigation bar on the left side of the page can be used to access individual pages.
Table of Contents
Logging on to the admin application
Logging on to the admin application
Go to the site http://jbossHost/admin
1. You will see a login screen. Log in with a user you know has ADMIN role.
For those installing for the first time, use the default ADMIN user of ‘i2b2’ and password of ‘demouser’.
2. Once logged on you will be presented with the admin setup page. You should see the following:
3. Click the ‘Hive” in the PM Navigation. This is where you can modify the domain, cells and global parameters. Click on ‘Domain’ to see the domain information.
Navigation Bar
A navigation bar will remain on the left side of all the pages. This can be used if a user wants to quickly access a particular page.
Figure 1 Navigation Bar
Pages
Individual pages will be used to capture information throughout the project management module. These pages will be specific to the data that is collected.
Page Heading
At the top of each page will be a tab that contains the name of the page and its location.
In the example shown below, the heading tells us the user is on the project parameters page for the “demo” project.
Figure 2 Page Heading
Setup
To assist with workflow and overall ease of use, individuals will now be able to easily save data and parameters for the hive, projects and users. An outline of what can be stored in the PM database and the related functionality is listed below.
Global Setup
In i2b2 Project Management, global data refers to information that is not specific to any one hive, project, or user. The information setup here is used by all.
Global Parameters
■ Parameters that are to be used by all hives and projects will be defined in the global parameters page.
■ The data will be stored in the PM_GLOBAL_PARAMS table.
Figure 3 Global Parameters Page
Users Setup
In order to use the i2b2 application a user has to be setup in project management and given access to one or many projects. In addition, variables can be setup for a user that can be used across multiple projects or specific to one project.
User Data
■ General information about the user will be stored in the PM_USER_DATA table.
■ The user_id will be referenced in other tables such as PM_USER_PARAMS and PM_PROJECT_USER_ROLES.
Figure 4 User Data Page
User Parameters
■ Parameters entered here are specific to the user and are not specific to any one project.
■ The information will be stored in the PM_USER_PARAMS table.
Figure 5 User Parameters Section
User Project Roles
■ The project user page captures information regarding which users have access to the project and their role.
■ The information will be stored in the PM_PROJECT_USER_ROLES table.
● Detailed information about user roles can be found in the project section of this document.
Hive Setup
Hive Data
■ The domain page captures general information about the hive.
■ Information captured includes the domain id, domain name, environment, and help URL.
■ The information will be stored in the PM_HIVE_DATA table.
Figure 6 Hive Data (Domain) Page
Hive Parameters
■ Parameters entered here are specific to the hive (domain) and are not specific to any one project or user.
■ The hive parameters can be added from the hive (domain) data page. Once you click on the domain an additional section for entering the parameters will appear at the bottom of the page.
■ The information will be stored in the PM_HIVE_PARAMS table.
Figure 7 Hive Parameters Section
Cell Data
■ The cell data page captures information and registers the cells associated to the hive.
■ The information will be stored in the PM_CELL_DATA table.
Figure 8 Cells Data Page
Cell Parameters
■ Parameters entered here are specific to the cell and are not specific to any one project or user.
■ The cell parameters can be added from the cell data page. Once you click on a cell an additional section for entering the parameters will appear at the bottom of the page.
■ The information will be stored in the PM_CELL_PARAMS table.
Figure 9 Cell Parameters Section
Project Setup
A hive can have multiple projects setup.
Project Data
■ The project data page captures general information about the project.
■ The information will be stored in the PM_PROJECT_DATA table.
Figure 10 Project Data Page
Project Parameters
■ Parameters entered here are specific to the project.
■ The project parameters can be added from the project parameters page.
■ The information will be stored in the PM_PROJECT_PARAMS table.
Figure 11 Project Parameters Page
Project Users
■ The project users’ page captures information regarding which users have access to the project and their role. (see the next section for detailed information regarding roles)
■ The information will be stored in the PM_PROJECT_USER_ROLES table.
Figure 12 Project Users Page
Project User Roles
Each user will have at least two roles per user_id and product_id combination. These two roles can be further defined as a Data Protection role and a Hive Management role.
The data protection role/path establishes the detail of data the user can see while the hive management role/path defines their level of functionality the user has in a project.
Data Protection Track
Role
Access Description
DATA_OBFSC
OBFSC = Obfuscated
The user can see aggregated results that are obfuscated (example: patient count).
The user is limited on the number of times they can run the same query within a specified time period. If the user exceeds the maximum number of times then their account will be locked and only the Admin user can unlock it.
DATA_AGG
AGG = Aggregated
The user can see aggregated results like the patient count.
The results are not obfuscated and the user is not limited to the number of times they can run the same query.
DATA_LDS
LDS = Limited Data Set
The user can see all fields except for those that are encrypted.
An example of an encrypted field is the blob fields in the fact and dimension tables.
DATA_DEID
DEID = De-identified Data
The user can see all fields including those that are encrypted.
An example of an encrypted field is the blob fields in the fact and dimension tables.
DATA_PROT
PROT = Protected
The user can see all data, including the identified data that resides in the Identity Management Cell.
Hive Management Track
Role
Access Description
USER
Can create queries and access them if he/she is the owner of the query.
MANAGER
Can create queries and can access queries created by different users within the project.
ADMIN
Can see anything in the Hive except identified data.
● Additional roles can be added to the PM_PROJECT_USER_ROLES table but there will not be any recognized hierarchy to those roles.
Project User Parameters
■ Parameters entered here are specific to the user and the project.
■ The project’s user parameters can be added from the project users’ page. Once you click on a project an additional section for entering the user parameters will appear at the bottom of the page.
■ The information will be stored in the PM_PROJECT_USER_PARAMS table.
Figure 13 Project Users Parameters Section