--- title: Overview description: "**i2B2 Admin Help Documentation** *Version 1.8.1* *Updated 05/2024 [PDF versions available here](https://i2b2.atlassian.net/wiki/spaces/webclient/pages/223118480/Web+Client+Help)* Table of Contents [1. Admin Plugin Introduction](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29796) [1.1 Accessing Admin Module](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29797) [2. Managing i2b2 Users](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29798) [2.1 User Data](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29799) [2.1.1 Add a New User](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29800) [2.1.2 Edit a User in…" url: "https://i2b2.org/docs/6-3-i2b2-new-admin-help-documentation-may-2024/" updated: "2026-09-15" category: i2b2 Installation Guide / Chapter 6. Initial Setup of i2b2 in Admin / 6.3 i2B2 NEW Admin Help Documentation May 2024 --- # Overview **i2B2 Admin Help Documentation** *Version 1.8.1* *Updated 05/2024 [PDF versions available here](https://i2b2.atlassian.net/wiki/spaces/webclient/pages/223118480/Web+Client+Help)* Table of Contents [1. Admin Plugin Introduction](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29796) [1.1 Accessing Admin Module](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29797) [2. Managing i2b2 Users](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29798) [2.1 User Data](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29799) [2.1.1 Add a New User](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29800) [2.1.2 Edit a User in i2b2](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29801) [2.1.3 Delete a User in i2b2](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29802) [2.2 User Parameters](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29803) [2.2.1 Add a User Parameter](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29804) [2.2.2 Edit a User Parameter](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29805) [2.2.3 Delete a User Parameter](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29806) [3. Managing i2b2 Projects](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29807) [3.1 Project Data](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29808) [3.1.1 Add a New Project](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29809) [3.1.2 Edit a New Project](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29810) [3.1.3 Delete a New Project](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29811) [3.2 Project Parameter](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29812) [3.2.1 Add a Parameter to a Project](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29813) [3.2.2 Edit a Parameter for a Project](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29814) [3.2.3 Delete a Parameter for a Project](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29815) [3.3 Project Data Source](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29816) [3.3.1 Add a Data Source to a Project](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29817) [3.3.2 Edit a Data Source for a Project](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29818) [3.4 Project Users](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29819) [3.4.1 Define a Project User Roles](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29820) [3.4.2 Project User Parameters](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29821) [4. Managing i2b2 Hive Data](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29822) [4.1 Hive Data](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29823) [4.1.1 Edit Hive Data](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29824) [4.2 Hive Parameters](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29825) [4.2.1 Add a Hive (Global) Parameter](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29826) [4.2.2 Edit a Hive (Global) Parameter](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29827) [4.2.2 Delete a Hive (Global) Parameter](#id-6.3i2B2NEWAdminHelpDocumentationMay2024-_Toc29828) # 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" ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706200.png) 1. Select "Admin" as the Category ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706142.png) 1. Click Admin Dashboard ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706202.png) 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. | **Field** | | **Description** | **Required** | | --- | --- | --- | --- | | User Name | • • | A unique id for the user. It is used when logging into the i2b2 Web Client, Workbench and Admin. | Yes | | User Full Name | • • • | The name of the user. This name will appear in the i2b2 Web Client and Workbench when they log in. The name will also appear in the i2b2 Admin under Manage Users in the Navigation panel. | Yes | | User Email | • | At this time, this field is not implemented in the i2b2 core cells and clients. | No | | User Password | • • | The password the user will enter when logging into the i2b2 Web Client, Workbench and Admin. The password will be encrypted when it is saved to the i2b2 database. | Yes | | Is Admin | • • • | A **Yes** response means the user is an administrator. This means they can log into the i2b2 Admin and will have access to all the cells, projects and users. A **No** response means the user is not an administrator. They cannot log into the i2b2 Admin. The default setting is **No** | Yes | ##### 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. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706202.png) 1. Click "+ADD NEW USER" button. The page to add users will display. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706153.png) 1. Enter the information for the user you are adding. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706154.png) **Warning** If **Is Admin** is set to *Yes* then the user will be able to log into i2b2 Admin Module. This means they are able to access information for ALL users, projects and cells. 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. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706204.png) 1. Click the **pencil icon** in the row of the **name of the user** you want to edit. 1. The *User* page will display. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706144.png) 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. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706204.png) 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. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706204.png) 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. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706144.png) 1. The **Parameters List** page will display. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706166.png) 1. Click on the **Add button**. A new row will display. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706156.png) 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. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706147.png) ##### 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. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706204.png) 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. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706148.png) 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. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706168.png) 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. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706204.png) 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. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706148.png) 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. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706170.png) 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. | **Field** | **Description** | **Required** | | --- | --- | --- | | Project ID | A unique identifier for the project. | Yes | | Project Name | - The name of the project. - Visible to users in the i2b2 Web Client and Workbench | Yes | | Project Wiki | Currently not implemented in the i2b2 Web Client or Workbench. | No | | Project Key | Enter the encryption key that is used during the encryption / decryption process. | No | | Project Description | A brief description of the project. At this time it is only visible in the i2b2 Admin. | No | | Project Path | | No | ##### 3.1.1 Add a New Project 1. In the Admin Dashboard, click on **Projects.** ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706204.png) 1. Click "+ADD NEW PROJECT" button. The page to add **project-details** will display. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706157.png) 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.** ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706204.png) 1. Click the **pencil icon** in the row of the **name of the project** you want to edit. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706157.png) 1. Click Save and Continue ##### 3.1.3 Delete a New Project 1. In the Admin Dashboard, click on **Projects.** ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706204.png) 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. | Project Parameters | • | Specific to the ***project*** in which it is defined. | | --- | --- | --- | | | • | Does not affect other projects. | | | • | Will affect all users who have access to the project. | ##### 3.2.1 Add a Parameter to a Project 1. In the Admin Dashboard, click on **Projects.** ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706204.png) 1. Click the **pencil icon** in the row of the **name of the project** you want to edit. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706157.png) 1. Click on the **Parameters (optional)** option that displays next to the project details tab. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706158.png) 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.** ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706204.png) 1. Click the **pencil icon** in the row of the **name of the project** you want to edit. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706157.png) 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. 1. Make the changes to the parameter and click on the **Save** icon to save the changes. ##### 3.2.3 Delete a Parameter for a Project 1. In the Admin Dashboard, click on **Projects.** ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706204.png) 1. Click the **pencil icon** in the row of the **name of the project** you want to edit. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706157.png) 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 **trash icon** in the row of the **name of the parameter** you want to remove. 1. Confirm the action. The parameter will be removed from the list of project parameters on the *Project* parameters page. ### 3.3 Project Data Source ##### 3.3.1 Add a Data Source to a Project 1. In the Admin Dashboard, click on **Projects.** ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706204.png) 1. Click the **pencil icon** in the row of the **name of the project** you want to edit. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706157.png) 1. Click Save and Continue. The Project parameters page will display. Click Save and Continue. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706160.png) 1. The **Data Source** page will display. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706171.png) 1. Enter details for the CRC, ONT, and WORK data sources. Click Save and Continue. ##### 3.3.2 Edit a Data Source for a Project 1. In the Admin Dashboard, click on **Projects.** ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706204.png) 1. Click the **pencil icon** in the row of the **name of the project** you want to edit. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706157.png) 1. Click Save and Continue. The Project parameters page will display. Click Save and Continue. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706160.png) 1. The **Data Source** page will display. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706171.png) 1. Edit the details for the CRC, ONT, and WORK data sources. Click Save and Continue. ### 3.4 Project Users Each user will have at least two roles per *user_id* and *project_id* combination. These two roles can be further defined as a **Data Protection role** and a **Hive Management role**. The data protection role establishes the detail of data the user can see while the hive management role defines the level of functionality the user has in a project. The following tables summarize the roles in a hierarchical order of least to most access. **Data Protection Roles** | **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. | | **Role** | **Access Description** | | 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 Roles** | **Role** | **Access Description** | | --- | --- | | USER | Can create queries and access them if he / she is the owner of the query. | | MANAGER | Can create queries as well as access queries created by different users within the project. | ##### 3.4.1 Define a Project User Roles 1. In the Admin Dashboard, click on **Projects.** ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706204.png) 1. Click the **person icon** in the row of the **name of the project** you want to add users to. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706206.png) 1. On the User **Association** page for a given project, search by the username. 1. The username will be displayed on the table below. 1. Click the **pencil icon** next to a user to modify their user role for the project. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706162.png) 1. Select the **Admin Path**, and **Data Path.** ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706208.png) 1. Click done to Save. ##### 3.4.2 Project User Parameters | Project User Parameters | • | Specific to the user ***and*** the project in which it is defined. | | --- | --- | --- | | | • | Does not affect other users within the project. | | | • | Does not affect other projects the user has access to. | 1. In the Admin Dashboard, click on **Projects.** ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706204.png) 1. Click the **person icon** in the row of the **name of the project** you want to add project users parameters to. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706206.png) 1. On the User **Association** page for a given project, click the **pencil icon** next to a user to modify their user role for the project. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706162.png) 1. Select the Parameters tab 1. Click done to Save. # 4. Managing i2b2 Hive Data The i2b2 hive and associated web services are the infrastructure used to integrate a collection of cells. The management of your Hive data is done in the i2b2 Administration Module within **Manage Hive**. The following functions for managing the hive are available. 1. Edit hive data *(Domain ID, Help URL, Domain Name, and Environment)* 2. Add, edit, and delete hive *(global)* parameter(s) The steps on how to use these features are defined in the sections that follow. ### 4.1 Hive Data The Hive Data page captures the following general information about a hive. | **Field** | **Description** | **Required** | | --- | --- | --- | | Help URL | A link to an external website that may contain additional information on using the i2b2 in your environment. This link is only used in the i2b2 Workbench and is not available from within the i2b2 Webclient. *(in the workbench heading there is a button labeled* **i2b2***; clicking on this button will launch the website entered at this field.)* | No | | Domain Name (View Only) | The name of the domain in which this hive resides. This is the same name that is entered in your Web Client and Admin config files as well as the Workbench properties file. | Yes | | Environment | The type of environment this hive resides. The options are: Development Production Test | Yes | **Note** The hive is created when you are installing the i2b2 server. You cannot add or remove a hive from within i2b2 Admin; however you can edit the hive's data. ##### 4.1.1 Edit Hive Data The following steps outline the process of editing the Hive Data 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 **Hive.** ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706204.png) 1. Click on **Hive Domain Settings**. This is the default view. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706164.png) 1. Make the changes to the Hive Data and click on **Save** to save the changes. ## 4.2 Hive Parameters Parameters entered on a project are known as **Hive** or **Global Parameters** and are *specific to the hive (domain)*. A hive parameter is not specific to any one cell, project or user. #### *4.2.1 Add a Hive (Global) Parameter* The following steps outline the process of adding a parameter to the hive 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 **Hive.** ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706204.png) 1. Click on **Global Parameters (Optional)**. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706164.png) 1. The **Parameters List** page will display. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706173.png) Click on **Add New Parameter**. The *Enter Parameter* page will display. 1. Enter the name of the parameter, the value for the parameter and the data type for the parameter. 2. Click on **Save** to save the new parameter. 7. The *Parameters List* page will display with the new parameter. #### *4.2.2 Edit a Hive (Global) Parameter* The following steps outline the process of editing a hive 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 **Hive.** ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706204.png) 1. Click on **Global Parameters (Optional)**. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706164.png) 1. The **Parameters List** page will display. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706173.png) 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. 1. Make the changes to the parameter and click on the **Save** icon to save the changes. #### *4.2.2 Delete a Hive (Global) Parameter* The following steps outline the process of deleting a hive 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 **Hive.** ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706204.png) 1. Click on **Global Parameters (Optional)**. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706164.png) 1. The **Parameters List** page will display. ![](https://i2b2.org/wp-content/uploads/i2b2-installation-guide/attachments/214704687/214706173.png) Click the **trash can icon** in the row of the **name of the parameter** you want to remove. 5. Confirm the action. The parameter will be removed from the list of hive (global) parameters on the page.