Articles in this section

6.4 Managing i2b2 Cells

Avatar
Peter Rice
  • Updated
Follow

6.4 Managing i2b2 Cells

The i2b2 hive is comprised of a collection of cells representing unique functional units. The management of the cells is done in the i2b2 Administration Module within Manage Cells. The following functions for managing the cells are available.

  1. Add, edit, and delete cell(s)
  2. Add, edit, and delete cell parameter(s)


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

 

Note

The core i2b2 cells were installed earlier in this installation guide. Within each cell installation chapter was a section on Updating Cell Data in i2b2 Admin. If you chose to skip this step then you will need to update the Cell URL for the core cells you installed. The URL has to be updated with the location of the cell in your environment. You will not be able to log into the i2b2 Web Client or Workbench until this is done.

Rather than go back to each chapter to update the core cells you can go to the section in this chapter titled Edit Existing Cell.

 

 

6.4.1 Cell Data

The Cell Data page captures the following general information about a cell.

 

Field

Description

Required

Cell Id

A unique id for the cell.

Yes

Cell Name

The name of the cell.

Yes

Cell URL

The url contains the IP or domain name for where the cell is located.

Yes

Project Path

 

No

Method

The method of communication. The options are:

  • REST
  • SOAP
  • OTHER

Yes
       

 

6.4.1.1 Add a New Cell

Steps to Add a New Cell

The following steps outline the process of adding a new cell 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 Cells.
  2. The Manage Cells page will display on the right.

 ADMIN_cellsManage.png

  1. In the Manage Cells page click on Add New Cell. The page to enter a new cell will display.

 ADMIN_cellsAdd.png

  1. Enter the information for the cell you are adding.
  2. Click on Save to save the cell.
  3. The cell will be added to the list of cells on the Manage Cells page.
  4. In the Navigation panel click on Manage Cells to refresh the hierarchical tree and display the new cell.

6.4.1.2 Edit Cell Data

Steps to Edit Cell Data in i2b2

The following steps outline the process of editing a cell 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. Click on Manage Cells located in the navigation panel on the left.
  2. The Manage Cells page will display in the panel on the right.
    ADMIN_cellsManage.png
  3. In the left navigation panel, click on the name of the cell you want to edit.
  4. The Edit Cell page will display on the right.
    ADMIN_cellEdit_CRC.png
  5. Make the changes to the cell and click on Save to save the changes.

 

6.4.1.3 Delete a Cell

Steps to Delete Cell Data in i2b2

The following steps outline the process of deleting a cell 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. Click on Manage Cells located in the navigation panel on the left.
  2. The Manage Cells page will display in the panel on the right.ADMIN_cellsManage.png
  3. In the left navigation panel, click on the name of the cell you want to delete.
  1. The Edit Cell page will display on the right.

 ADMIN_cellEdit_CRC.png

  1. Click on Delete to remove the cell.
  2. The cell will be removed from the list of cells on the Manage Cells page.
  3. In the Navigation panel click on Manage Cells to refresh the hierarchical tree and verify the cell no longer appears in the list.

6.4.2 Cell Parameters

Parameters entered on a cell are known as Cell Parameters and are specific to the cell. The cell parameter only affects the cell in which it is entered on; it does not affect the other cells in the hive.

 

6.4.2.1 Add Cell Parameters

Steps to Add a Cell Parameter

The following steps outline the process of adding a parameter to a cell 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 Navigation panel, expand Manage Cells to display a list of cells.

 ADMIN_navPanel_cells.png

  1. Expand the name of the cell you want to add a parameter to.
  2. Click on the Params option that displays under the cell's name.
  3. The Parameters List page will display on the right side of the window pane.
  4. 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 Params to refresh the hierarchical tree and display the new parameter.

 

6.4.2.2 Edit Cell Parameters

Steps to Edit a Cell Parameter

The following steps outline the process of editing a cell 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 Cells to display a list of cells.

 ADMIN_navPanel_cells.png

  1. Expand the name of the cell that has the parameter you want to edit.
  2. Expand the Params option that displays under the cell's name.
  3. A list of parameters entered for that cell will display under its name in the Navigation panel.
  4. In the Navigation panel, click on the name of the parameter you want to edit.
  5. The Edit Parameter page will display on the right.
  6. Make the changes to the parameter and click on Save to save the changes.

 

6.4.2.3 Delete Cell Parameters

Steps to Delete a Cell Parameter

The following steps outline the process of deleting a cell 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 Cells to display a list of cells.

 ADMIN_navPanel_cells.png

  1. Expand the name of the cell that has the parameter you want to delete.
  2. Expand the Params option that displays under the cell's name.
  3. A list of parameters entered for that cell will display under its name in the Navigation panel.
  4. In the Navigation panel, click on the name of the parameter you want to delete.
  5. The Edit Parameter page will display on the right.
  6. Click on Delete to remove the parameter.
  7. The parameter will be removed from the list of parameters on the Parameters List page.
  8. In the Navigation panel click on 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.