i2B2 Admin Help Documentation
Version 1.8.1
Updated 05/2024
PDF versions available here

Table of Contents
1. Admin Plugin Introduction
1.1 Accessing Admin Module
2. Managing i2b2 Users
2.1 User Data
2.1.1 Add a New User
2.1.2 Edit a User in i2b2
2.1.3 Delete a User in i2b2
2.2 User Parameters
2.2.1 Add a User Parameter
2.2.2 Edit a User Parameter
2.2.3 Delete a User Parameter
3. Managing i2b2 Projects
3.1 Project Data
3.1.1 Add a New Project
3.1.2 Edit a New Project
3.1.3 Delete a New Project
3.2 Project Parameter
3.2.1 Add a Parameter to a Project
3.2.2 Edit a Parameter for a Project
3.2.3 Delete a Parameter for a Project
3.3 Project Data Source
3.3.1 Add a Data Source to a Project
3.3.2 Edit a Data Source for a Project
3.4 Project Users
3.4.1 Define a Project User Roles
3.4.2 Project User Parameters
4. Managing i2b2 Hive Data
4.1 Hive Data
4.1.1 Edit Hive Data
4.2 Hive Parameters
4.2.1 Add a Hive (Global) Parameter
4.2.2 Edit a Hive (Global) Parameter
4.2.2 Delete a Hive (Global) Parameter

1. Admin Plugin Introduction

Now that you have finished installing the i2b2 cells and clients the next step is to setup your users and projects in the i2b2 Administration Module. This chapter will contain various sections on how to save data and parameters for the users, projects and hive. There is also a section on the different Authentication Methods supported by the i2b2.
The main goals of the admin module is to help:

1. Manage users and permissions

2. Create projects and manage user access to projects

3. Define HIVE settings

1.1 Accessing Admin Module

The i2b2 Administration Module can be accessed as a plug in.

1. Click "Analysis Tools"

Open

1. Select "Admin" as the Category

Open

1. Click Admin Dashboard

Open

1. This will load the i2b2 Administration Module displaying the User tab.

2. Managing i2b2 Users

Everyone who uses the i2b2 has to be setup as an i2b2 user in the i2b2 Administration Module. The management of these users is done under Users and the following functions for managing your users are available.

1. Add, edit, and delete user(s) and user's permission setting

2. Add, edit, and delete user parameter(s)

The steps on how to use these features are defined in one of the sections that follow

2.1 User Data

The User Data page captures the following general information about a user.

2.1.1 Add a New User

The following steps outline the process of adding a new user in the i2b2 Administration Module.
Assumption: The following steps assume you are already logged into the i2b2 Administration Module. If you do not know how to login please see the chapter titled i2b2 Administration Module
Install.

1. In the Admin Dashboard, click on Users. It is the default view. The AGG_SERVICE_ACCOUNT is automatically added through the i2b2 Installation guide.

Open

1. Click "+ADD NEW USER" button. The page to add users will display.

Open

1. Enter the information for the user you are adding.

1. Click on Save to save the user. The user will be added to the list of users on the Manage page.

2.1.2 Edit a User in i2b2

The following steps outline the process of editing a user in the i2b2 Administration Module.
Assumption: The following steps assume you are already logged into the i2b2 Administration Module. If you do not know how to login please see the chapter titled i2b2 Administration Module
Install.

1. In the Admin Dashboard, click on Users. It is the default view.

Open

1. Click the pencil icon in the row of the name of the user you want to edit.

1. The User page will display.

Open

1. Make the changes to the user and click on Save to save the changes.

2.1.3 Delete a User in i2b2

The following steps outline the process of deleting a user in the i2b2 Administration Module.
Assumption: The following steps assume you are already logged into the i2b2 Administration
Module. If you do not know how to login please see the chapter titled i2b2 Administration Module Install.

1. In the Admin Dashboard, click on Users. It is the default view.

Open

1. Click the trash icon in the row of the name of the user you want to edit.

1. Confirm the action. The user will be removed from the list of users on the Users page.

2.2 User Parameters

Parameters entered on a user are known as User Parameters and are specific to the user. The user parameter only affects the user in which it is entered on; it does not affect other users and it is not specific to any one project.
User Parameters • Specific to the user in which it is defined. • Does not affect other users. • Is not specific to any one project.

2.2.1 Add a User Parameter

The following steps outline the process of adding a parameter to a user from within the i2b2 Administration Module.
Assumption: The following steps assume you are already logged into the i2b2 Administration Module. If you do not know how to login please see the chapter titled i2b2 Administration Module
Install.

1. In the Admin Dashboard, click on Users. It is the default view.

Open

1. Click the pencil icon in the row of name of the user you want to add a parameter to.

1. Click on the Parameters (optional) option that displays next to the User's tab.

Open

1. The Parameters List page will display.

Open

1. Click on the Add button. A new row will display.

Open

1. Enter the name of the parameter, the value for the parameter and the data type for the parameter.

1. Click on Save to save the new parameter.

1. The Parameters List page will display with the new parameter.

Open

2.2.2 Edit a User Parameter

The following steps outline the process of editing a user parameter in the i2b2 Administration Module.
Assumption: The following steps assume you are already logged into the i2b2 Administration Module. If you do not know how to login please see the chapter titled i2b2 Administration Module
Install.

1. In the Admin Dashboard, click on Users. It is the default view.

Open

1. Click the pencil icon in the row of the name of the user you want to add a parameter to.

1. Click on the Parameters (optional) option that displays next to the user's tab.

Open

1. The Parameters List page will display. A list of parameters entered for that user will display.

1. Click the pencil icon in the row of the name of the parameter you want to edit.

1. The Edit Parameter fields will display for that row.

Open

1. Make the changes to the parameter and click on the Save icon to save the changes.

2.2.3 Delete a User Parameter

The following steps outline the process of deleting a user parameter in the i2b2 Administration Module.
Assumption: The following steps assume you are already logged into the i2b2 Administration Module. If you do not know how to login please see the chapter titled i2b2 Administration Module
Install.

1. In the Admin Dashboard, click on Users. It is the default view.

Open

1. Click the pencil icon in the row of the name of the user you want to delete a parameter for.

1. Click on the Parameters (optional) option that displays next to the user's tab.

Open

1. The Parameters List page will display. A list of parameters entered for that user will display.

1. Click the trash icon in the row of the name of the parameter you want to delete.

Open

1. Confirm the action. The user will be removed from the list of parameters for that user.

3. Managing i2b2 Projects

After a user is setup in the i2b2 Administration Module they need to be given access to one or more projects before they can log into the i2b2 Web Client or Workbench. The management of your project data is done in the i2b2 Administration Module within Manage Projects. The following functions for managing the projects are available.
Project Data

1. Add, edit, and delete project(s)

2. Add, edit, and delete project parameter(s)

3. Add, edit data sources

Project Users

1. Add and delete project user(s)

2. Add and edit project user roles

3. Add, edit, and delete project user parameter(s)

3.1 Project Data

The Project Data page captures the following general information about a project.

3.1.1 Add a New Project

1. In the Admin Dashboard, click on Projects.

Open

1. Click "+ADD NEW PROJECT" button. The page to add project-details will display.

Open

1. Click Save and Continue.

1. Add optional Project specific Parameters. See 3.2 Project Parameters.

1. Add Data Sources. See 3.3 Project Data Source.

1. See 3.4 to Add Users to the Project. See 3.5 Add User's Project Roles, and see 3.6 User's Project Parameters.

3.1.2 Edit a New Project

1. In the Admin Dashboard, click on Projects.

Open

1. Click the pencil icon in the row of the name of the project you want to edit.

Open

1. Click Save and Continue

3.1.3 Delete a New Project

1. In the Admin Dashboard, click on Projects.

Open

1. Click the trash icon in the row of the name of the user you want to edit.

1. Confirm the action. The project will be removed from the list of projects on the Project page.

3.2 Project Parameter

Parameters entered on a project are known as Project Parameters and are specific to the project. The project parameter only affects the project in which it is entered on; it does not affect the other projects in the hive or any one user in the project.

3.2.1 Add a Parameter to a Project

1. In the Admin Dashboard, click on Projects.

Open

1. Click the pencil icon in the row of the name of the project you want to edit.

Open

1. Click on the Parameters (optional) option that displays next to the project details tab.

Open

1. The Parameters List page for the project will display. A list of parameters entered for that project will display.

1. Click "Add" to add a new parameter.

3.2.2 Edit a Parameter for a Project

1. In the Admin Dashboard, click on Projects.

Open

1. Click the pencil icon in the row of the name of the project you want to edit.

Open

1. Click on the Parameters (optional) option that displays next to the project details tab.

1. The Parameters List page will display. A list of parameters entered for that project will display.

1. Click the pencil icon in the row of the name of the parameter you want to edit.

1. The Edit Parameter fields will display for that row.