/
1.8.3 Release Notes

1.8.3 Release Notes

Important links

 Relevant Documentation:

1.8.3 Release Notes

i2b2 1.8.3 Release features new enterprise-ready administration and monitoring and a new breakdown engine in the web client!

  • Enhanced administrative dashboards, user monitoring, role and parameter management, expanded query insights, and improved web client usability and navigation.

  • Enhanced Web Client with redesigned breakdown visualizations, centralized theming, configurable layouts, and project-driven UI customization.

  • Multiple bug fixes and workflow optimizations have been implemented to improve overall system consistency, stability, and reliability.

Highlight of Features

Top New Features

Description

 

 

Description

 

 

i2b2 Webclient Admin tools - Administration & Configuration; Activity & Usage Monitoring plugin 

image-20260608-153054.png

 

 

  • Expanded Admin Tool with enhanced user management, authentication configuration, project parameter support, locked-user management, and session controls

  • New Monitor Dashboard for tracking user activity, query trends, login statistics, top users, and project usage metrics

Major Query Status & query breakdowns Redesign

image-20260608-153107.png

 

  • Redesigned Query Status with modular visualizations including bar charts, pie charts, line graphs, maps, timelines, NIH enrollment tables, table summaries, and CSV export

  • Enhanced Web Client Configuration with centralized CSS theming, configurable tab layouts, and project-driven UI settings.

Improvements to the Login UI 

image-20260608-153123.png

 

The i2b2 login now includes configurable messaging, password visibility toggle, and improved styling.

New Web Client Configurations

image-20260624-154304.png

 

Centralized web client styling and tab configuration, and added configurable Query Status navigation, enabled project-driven UI options, and improved parameter configuration handling.

 

Bug Fixes and miscellaneous changes

image-20260623-203237.png

 

  • Bug Fixes across Query Tool Admin Tool, Admin Dashboard, 

  • Performed shared UI cleanup, centralized layout and Query Status handling, modernized Admin Tool state management, added Leaflet-based mapping infrastructure, and removed deprecated or unused code and assets.

Detailed Documentation on New Features

Admin tool - Administration & Configuration 

  • Enhanced user, project, and authentication management workflows with improved navigation, role assignment, LDAP and Global Authentication Configuration support, and streamlined user editing/deletion behavior

  • Expanded parameter management with inline editing, configurable parameter prototypes, predefined data types, default values, filtering, and enhanced parameter visibility options

  • Added administrative monitoring features for locked users, active sessions, and project-level user details, along with broader Admin Tool usability and interface improvements 

image-20260701-130534.png

Admin tool - Activity & Usage Monitoring plugin 

  • New administrative dashboards and monitoring capabilities with metrics for active sessions, login activity, user and role counts, newly created accounts, and project-level user activity tracking

  • New query reporting and analytics with configurable time-based metrics, monthly summaries, top query users, project query statistics, and 12-month query trend analysis

  • New query management interface with advanced filtering, auto suggest project navigation, interactive query grids, query detail popups, SQL viewing support, and obfuscated query count handling

image-20260608-154137.png

 

image-20260608-154149.png

 

Improvements to the Login UI 

  • Redesigned Login UI with updated branding and layout improvements

  • Added configurable login messaging and show/hide password support

  • Improved login usability with repeated-click protection and enhanced SSO/button styling

New Web Client Configurations

  • Added centralized CSS theming, color management, and configurable tab/layout positioning

  • Expanded project-driven UI and Query Status configuration capabilities

  • Improved parameter handling with enhanced support for boolean, multiline, and configurable UI options

Please note that also legacy plugin subsystem has been removed. The YUI2 library is no longer maintained and has potential security exploits. 

Major Query Status & Query Breakdowns Redesign

The i2b2 web client now includes a modular visualization framework integrated with Query Status and Query Report, allowing query breakdowns to be mapped to multiple visualization types. Users can switch between visualizations within each breakdown view, expanding reporting capabilities beyond traditional bar charts and enabling flexible display of custom SQL breakdown data.

Default Visualizations

i2b2 1.8.3 includes several new or enhanced breakdown visualization options, including bar charts, pie charts, NIH-style enrollment tables, summary tables, and breakdown data CSV export support.

65e72c09-205a-4ad0-8ffd-7a16e8705f03.png
1ff0f102-9bca-4e10-bddc-942f25a07bbf.png

 

image-20260609-163118.png

 

image-20260609-163053.png

 

 

image-20260609-163551.png

 

image-20260609-163402.png

 

Optional Visualizations

i2b2 1.8.3 also includes several optional data visualizations that can be enabled through custom SQL breakdowns and mapped via the breakdowns.json configuration file, such as a line chart.

Table Bar Chart visualization

The Table Bar Chart visualization combines tabular summaries with inline bar charts for large-category breakdowns, with optional diagnosis category support using precomputed tables for improved performance.

image-20260608-154233.png

Mapping Visualizations to Breakdown

i2b2 1.8.3 supports configurable mapping of query breakdowns to one or more visualization modules through JSON-based Query Status configuration files. The framework also supports advanced “Super Module” visualizations capable of rendering multiple breakdown results within a single interface area, providing flexibility for custom visualization development.

Creating New Breakdown Visualizations 

i2b2 1.8.3 supports development of custom breakdown visualizations through modular Query Status components registered in config.json.

Configuring the Query Report

Query Report output and visualization display can be configured through ReportConfig.json, while report styling and printed content can be customized through the QueryReport.html template.

Displaying Query Status in a Separate Tab

i2b2 1.8.3 allows Query Status to be displayed in a separate tab, providing additional space for viewing breakdown visualizations. The default tab placement can be configured through the /js-i2b2/i2b2_tabs.json layout configuration file, which uses a lightweight Golden Layout–based configuration structure.

Server-side Changes

  • Enhanced user administration with user creation, update, deletion, password handling, role assignment listings, inactive-role filtering, and project-filtered user/manager/administrator views.

  • Enhanced user authentication and password handling including legacy password migration to SHA-256, complex-password rule parsing, and support for creating or updating users without requiring a password.

  • Updated query-master behavior including generated SQL in query-master responses and SQL Server query-master ID retrieval.

  • Updated project and database path handling across CRC, Ontology, and Workplace services, including normalized project paths, ontology concept lookup parameters, and project deletion targeting.

  • Cleaned up login and session reporting by excluding administrative events from login-history and session retrieval results.

New server calls

Server call

Area

Purpose

Server call

Area

Purpose

get_user_login

PM

Retrieves user login history from pm_user_login. Added as a new PM service call.

get_user_session

PM

Retrieves currently active sessions from pm_user_session. Added with active-session support.

logout

PM

Expires a user session by updating pm_user_session

unlock_user

PM

Unlocks a locked user account.

get_lock_user / locked-user retrieval

PM

Retrieves locked users. Added with unlock-user support.

CRC datasource query support

CRC

Adds datasource-aware query handling / lookup behavior for CRC queries.

Existing server calls modified

Server call

Area

What changed

Server call

Area

What changed

get_all_user

PM

Updated to work with project filtering and entry-date filtering; later fixed to exclude deleted users.

get_all_admin

PM

Updated to support project filtering and active-role filtering.

get_all_manager

PM

Updated to support project filtering and active-role filtering.

get_all_roles

PM

Modified to return all expected users and excludes deleted role rows.

Login-related get call

PM

Modified to return admin requests by the login call. 

Database Changes

Added new entries to QT_QUERY_RESULT_TYPE and QT_BREAKDOWN_PATH to support additional visualizations and query result types.

  • QT_QUERY_RESULT_TYPE:

    • ADMIN_QUERY_DASHBOARD_CLASS_XML entry stores a hidden admin-only dashboard breakdown

    • PATIENT_NIH_ENROLLMENT_XML entry to support NIH Enrollment visualization in ACT and ACT-OMOP projects.

  • QT_BREAKDOWN_PATH:

    • Added corresponding QT_BREAKDOWN_PATH SQL definitions for custom dashboard metrics and updated PATIENT_AGE_COUNT_XML to override the default age breakdown SQL.

Changelog

Database Drivers

The JDBC drivers were updated to the following versions.

Server Type

oracle

Postgresql

mssql

Driver Version

ojdbc11jar

postgresql-42.7.8.jar

mssql-jdbc-12.8.1.jre8.jar

Download the JDBC authentication DLL from https://github.com/microsoft/mssql-jdbc/releases page and place it in your Java bin directory. For example:\Program Files\Java\jre1.12.x_xxx\bin\

Supported Db Server versions

Server Type

SQL Server

Oracle

PostgresSQL

Supported Version/s

2012+ (tested with up to 2022)

23.3

11 to 14 (9 and 10 work for querying, but not data export)

Supported software versions

Application Type

Java

Wildfly

Apache HTD

Apache Ant

Apache Axis2

PHP                                           

Supported Version/s

21 (both Oracle and OpenJDK supported)

37.01

2.0 (RHEL 6) and 2.2 ( RHEL 7)

1.9.6

2

7.2.27 or higher (including PHP 8.x)                                              

Supported Operating Systems 

AlmaLinux / Rocky Linux 8 and 9
Windows server 2016 -2019

Unofficially, MacOS and other flavors of Linux are likely to work.

Bug Fixes

Web Client

  • Fixed PDF lab value, announcement display, and Query Status loading issues.

  • Resolved duplicate ontology tree and Admin Tool parameter display issues.

  • Corrected project data source overwrite and Request Status Log display issues.

  • Fixed Data Request file generation failures caused by special characters.

  • Prevented editing of protected service accounts.

Server

  • Fixed breakdown and result-type display issues including missing result types, SQL breakdown project-ID substitution, and unintended obfuscation defaults.

  • Strengthened security and session validation by validating RPDO requester sessions, preventing managers from retrieving other projects’ query history, and replacing predictable message identifiers with securely generated values.

Database

  • Postgres compatibility improvements: corrected PostgreSQL schema targeting and missing PostgreSQL database/schema qualifiers.

Notes for Developers

If you change the xsd (REST API message definitions), then you will need to regenerate gensrc via JAXB in Java 8. In the i2b2-core cell directory for which you're regenerating the XSD-Java, run the ant target "jaxb_gen" on Java 8 and then build as usual using Java 21.