Articles in this section

6.3 Managing i2b2 Hive Data

Avatar
Peter Rice
  • Updated
Follow

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

 

6.3.1 Hive Data

The Hive Data page captures the following general information about a hive.

Field

 Description

 

Domain Id
  • A unique id for the domain in which this hive resides.
  • This ID is encrypted when it is saved and stored in the database.

Yes

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

 


6.3.1.1 Edit Hive Data

Steps to 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 Navigation panel, click on Manage Hive.
  2. The Hive Overview page will display on the right.

 

 ADMIN_hiveManage.png

  1. Make the changes to the Hive Data and click on Save to save the changes.
Warning
Be very careful editing the Domain Id or Domain Name. Changes to either of these two fields will require you to edit the configuration and property files for all your cells, the i2b2 Admin, Web Client and Workbench.

  

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

6.3.2.1 Add Hive Parameters

Steps to 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.

In the Navigation panel, expand Manage Hive to display the available options.

 

 ADMIN_navPanel_hive.png

  1. Click on the Global Params option that appears in the Navigation panel.
  2. The Parameters List page will display on the right side of the window pane.

 

 ADMIN_hiveParamList_1.png

  1. Click on Add New Parameter. The Enter Parameter page will display.

 ADMIN_parameter_addNew.png

 

  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.
  3. The Parameters List page will display with the new parameter.
  4. In the Navigation panel click on Global Params to refresh the hierarchical tree and display the new parameter.

 

6.3.3.2 Edit Hive Parameters

Steps to Edit a Hive (Global) Parameter in i2b2

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 Navigation panel, expand Manage Hive to display the available options.

 ADMIN_navPanel_hive.png

  1. Expand the Global Params option.
  2. A list of existing hive parameters will display in the Navigation panel.
  3. In the Navigation panel, click on the name of the parameter you want to edit.
  4. The Edit Parameter page will display on the right.
  5. Make the changes to the parameter and click on Save to save the changes.

6.3.2.3 Delete Hive Parameters

Steps for Deleting 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 Navigation panel, expand Manage Hive to display the available options.

 ADMIN_navPanel_hive.png

  1. Expand the Global Params option.
  2. A list of existing hive parameters will display in the Navigation panel.
  3. In the Navigation panel, click on the name of the parameter you want to delete.
  4. The Edit Parameter page will display on the right.
  5. Click on Delete to remove the parameter.
  6. The parameter will be removed from the list of parameters on the Parameters List page.
  7. In the Navigation panel click on Global Params to refresh the hierarchical tree and verify the parameter no longer appears in the list.

 

Comments

0 comments

Please sign in to leave a comment.