i2b2 Web Client
Space shortcuts
Space Tools

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

Framework

Your deployment of the i2b2 web client will have a directory which contains all the JavaScript code related to the i2b2 web client Framework. The default location of this directory is /js-i2b2.
The main directory structure is as follows:

Directory

Description

/js-i2b2

Root directory for the Cell

/js-i2b2/hive

Directory containing the generalized web client framework

/js-i2b2/cells

Directory containing each Cell's implementation code



Hive and Core Cells

Within each cell exists several directories that are used to store the cell's files. Although every cell is different, the described standard should be followed. The example below (utilizing the Ontology Cell) shows how a cell's files will be organized within a directory:

Directory

Description

/js-i2b2/cells/ONT

Root directory for the Cell

/js-i2b2/cells/ONT/sdx

Directory containing code to manage various SDX data-types

/js-i2b2/cells/ONT/ajax

Directory containing (AJAX) communication code for Cell servers

/js-i2b2/cells/ONT/views

Directory containing view code

/js-i2b2/cells/ONT/ctrls

Directory containing controller code

/js-i2b2/cells/ONT/assets

Non-code files needed by the Cell such as HTML templates or images



Modules and Plug-ins

Each code module is free to create its own directory structure however you must place all CSS files and icon images within a subdirectory called assets in order for the web client's framework to be able to use them correctly.