i2b2 Release 1.7.12

Release Date: October 31, 2019

Release Summary

Release 1.7.12  contains  solutions for providing an easier install solution of i2b2, supporting various Authentication protocols and integration of REDCAP. Also included are  enhancements to i2b2Weblcient, new database scripts and bug fixes

Highlight of Features

Installation Note

The 1.7.12 Release Notes apply to you if you are upgrading your existing i2b2 system from an earlier version of the i2b2 software.

Type of InstallWhere you need to go next

Upgrading an existing i2b2 (currently installed at your site)

Please go to the  Upgrade Notes section for the details about upgrading your i2b2 software.

Upgrading your i2b2 in a SHRINE network

Please read the information in the  SHRINE Networks section before proceeding.

Installing a new instance of i2b2. (Never installed it before)

We recommend you refer to the i2b2 Installation Guide found on the i2b2 Community Wiki
The install guide will take you through the entire installation process.

Upgrade Notes

Information about upgrading i2b2 to version 1.7.12 can be found in this section of the release notes.

i2b2 Components

In release 1.7.12 the following i2b2 components contain changes and therefore need to be updated when upgrading your i2b2 environment.

Database Drivers

The JDBC drivers were updated to the following versions.

DriverNew Version
postgresql-42.2.5.jarPostgreSQL 42.2.5
mssql-jdbc-7.0.0.jre8.jarMS Sql Server 7.0.0

Upgrade Paths

The i2b2 now provides two options for upgrading your i2b2 server.

  1. Continue to download the source code provided in the zip file released on www.i2b2.org/software
  2. Install the precompiled JAR files onto your existing i2b2 server to upgrade it to 1.7.12.

Both are acceptable paths to upgrade your i2b2 server and depending on which you choose will determine where you need to go to obtain the appropriate files. The location of the upgrade files for each component is outlined below.

Upgrade Software

DescriptionWhere to find itRequirements
Upgrade i2b2 database to 1.7.12

Software page (i2b2 Website)

Download i2b2createdb-1712.zip file under Source Code
Upgrade i2b2 Web Client to 1.7.12

Software page (i2b2 Website)

Download i2b2webclient-1712.zip file under Source Code
Upgrade i2b2 Server to 1.7.12 (Source Code)

Software page (i2b2 Website)

Download i2b2core-src-1712.zip file under Source Code
Upgrade i2b2 Server to 1.7.12 (JAR files) Upgrade to latest version page (Community Wiki) See Technical Details section on the i2b2 Upgrades page and upgrade documentation on Upgrade to latest version page.

Database Changes

Release 1.7.12 involves a few changes to the i2b2 Database.  Included  totalnum counts to Ontology Terms in the demo data that is delivered with the software along with the  Stored procedures 

used for creating the counts.

Change Summary - Release 1.7.12

Did you know?

i2b2 Kernel (Core Software)

New Features and Improvements

Bug Fixes

Feature Details - Release 1.7.12

New Feature: Easier i2b2 Install

New Feature: More authentication protocol support (okta, NTLM v2)

New Feature: RedCap

1) Set Project Params (PM_PROJECT_PARAM)

REDCP_TOKEN (7B42348B7C51123432048B51EAA)


Get the API Key from Redcap.  Logon to Redcap on the right side under applications click API.   Than select Generate token, and use this token for the value for the key.



This is the name of the Data Collection Instruments to associate this project with, in this example it is set to the 'Profile'


Optional, Defaults to Y
Y - Every time a form is submitted the i2b2 metadata ontology get regenerated

N - Do Not regenerate the metadata ontology.   

NOTE:  When first setting up the i2b2/redcap this needs to be set to Y at least one or the ontology will not be created.


Optional, Defaults to \REDCAP\
What the root ontology is


Optional, Defaults to tree
How the ontology will be created

tree - All enumerated values, Yes/No will be children on the ontology

The only exception is items with checkbox, which will always be a popup

If this redcap form has the identified value set to true, than this ontology will be protected and only users with the following i2b2 access role will be able to access it.

2) On the redcap side, set the Data Entry Trigger, it is under Project Setup → in Enable optional modules and customizations, select Additional customizations → Data Entry Trigger, and enter:

http://{i2b2 url}/i2b2/services/QueryToolService/redcapPush

Click Test to verify connection

3) Submit a form and check to see if the ontology was created.

New Feature: Enhanced Find Terms

Find terms gives a sense of the hierarchy, and terms that are children of other search results are not returned.

New Feature: Improved Maximized Left Pane

In maximized mode, the left pane now makes all tabs accessible.

New Feature: Totalnum scripts

In the Release_1-7/NewInstall/Metadata/ run the ant script

ant -f data_build.xml create_metadata_tables_release_1-7 - This will create the stored procedures

New Feature: ACT Ontology