i2b2 Web Client
Space shortcuts
Space Tools
i2b2 Web Client webclient

Versions Compared

Old Version 4

changes.mady.by.user Janice Donahoe

Saved on

compared with

New Version 5

changes.mady.by.user Janice Donahoe

Saved on

Key

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

...

All deployments of the i2b2 web client will require modification of the Hive Connection configuration file. This configuration file is located at /i2b2_config_data.js. An example file is as follows:

{
   urlProxy: "http://localhost/services/proxy/Service.asmx/webProxy" ,
   urlFramework: "js-i2b2/",
   //-------------------------------------------------------------------------------
   // THESE ARE ALL THE DOMAINS A USER CAN LOGIN TO
   lstDomains: [
   { domain: "HarvardDemo",
      name: "VM Java 1.3 RC5",
      project: "Demo2",
      debug: true,
      urlCellPM: "http://services.i2b2.org/PM/rest/PMService/"
   },
   { domain: "HMS_JAVA" ,
      name: "Harvard Demo (Java 1.2)",
      debug: true,
      urlCellPM: "http://services.i2b2.org/PM/rest/PMService/"
   }
   //--------------------------------------------------------------------------------
}



The first configuration attribute urlProxy must be changed for every deployment. It should be set to point to your web proxy cell. In all cases it must be the same base URL (hostname and port) as the website that serves the default.htm file. For more information on the web Proxy communication with the hive please see the document called Web Client Architecture Guide.

...

The framework is aware of various code modules after they are registered in the main component list configuration file. This list is located within the /js-i2b2/i2b2_loader.js file in a section containing JSON-based configuration information which has the following structure:

: \ [\]
   }
  }
];

// THESE ARE ALL THE CELLS THAT ARE INSTALLED ONTO THE SERVER
i2b2.hive.tempCellsList = [
   { code: "PM",
   forceLoading: true // <------- this must be set to true for the PM cell!
   },
   { code: "ONT" } ,
   { code: "CRC" } ,
   { code: "ANALYSIS" ,
      forceLoading: true,
      forceConfigMsg: {
      params

Wiki Markup



This JSON structure is used to register a list of cells / plug-ins that are able to be loaded if the user has been authorized to use them (via the data returned from the Project Management cell during successful login). The above code listing has information for registering the following cells / modules (in order):

...


This file would have the following structure:

:\[ "ExampHello.js" ],
   css:\[ "ExampHello.css" ],
   config: {
      // additional configuration variables that are set by the system
      short_name: "Hello World",
      name: "Example #1 - Hello World",
      description: "This plugin cell demonstrates how to register your plugin
                 with the i2b2 thin-client framework and display simple HTML.",
      category: ["celless", "plugin", "examples"],
      plugin: {
         isolateHtml: false,
         html: {
            source: 'injected_screens.html',
            mainDivId: 'ExampHello-mainDiv'
         }
      }
   }
}

// This file contains a list of all files that need to be loaded dynamically
// for this module. Every file in this list will be loaded after the module's Init()
// function is called
{
   files

Wiki Markup
Wiki Markup



The configuration file has three main parts to it:

...

i2b2 Web Client webclient