Page History
...
The data export runs in the background and the file is generated in a specified folder defined in the HIVE_CELL_PARAMS (see Configuration below). Data file generation status is displayed under the Status column under Data Request Manager
Status is updated as the
...
data file is processed, from Submitted to File in Progress to File Available. When the file is available,
...
an e-mail notification may be sent to the site’s configured Data Request Email Address (for example, a data manager or project mailbox), depending on local configuration. The process for giving the user access to the file
...
is site-specific.
Example Export files (all data are fake)
...
| Parameter Name | Example Value | Notes |
|---|---|---|
| Data Request Template | This user {{{USER_NAME}}} in project {{{PROJECT_ID}}} requested ... | Template text for the body of the data request message; supports placeholders like{{{USER_NAME}}} and {{{PROJECT_ID}}}.request notification email. This email is sent to the site’s configured Data Request Email Address someone@somewhere.org. Supports template variables. |
| Data Request Email Address | someone@somewhere.org | Email address that receives the data export notifications. This is typically a data manager or project mailbox E-mail address of the Data Manager, where the data request e-mail will be sent. |
| Data Request Letter | "Results of the i2b2 request entitled - '{{{QUERY_NAME}}}', ..." | Template text for the e-mail to the user announcing the successful completion of the data export; supports placeholdersexport-completion notification email body, to be sent to the configured Data Request Email Address (not directly to the requesting user). Supports variables like {{{QUERY_NAME}}}. |
| Data Request Subject | i2b2 Data Request | Subject line used for both the datarequest e-mail. |
| Info |
|---|
The e-mail address for the data request letter (sent when export is complete) is entered in the Query Options Email box at the time of data request submission |
Template substitution variables (parameters/placeholders inside VALUE)
notification email and the export-completion notification email. |
Template Substitution Variables
| Variable | Description | Example / Source |
{{{USER_NAME}}} | Display name or username of the requester | Jon Smith |
{{{FULL |
_NAME}}} |
| The full legal name |
| of the requester |
Jon Smith| Jonathan Smith | ||
{{{QUERY_STARTDATE}}} | Timestamp when the query was submitted | 2025-09-19 |
{{{ |
QUERY_ |
ENDDATE}}} |
| Timestamp when the file was generated | 03/11/2026, 4:47 PM |
ACT{{{QUERY_NAME}}} | Name/title of the query |
| executed | Hypertension Adults | |
{{{QUERY_MASTER_ID}}} | Internal i2b2 Query Master ID | 5412 |
Hypertension Adults{{{QUERY_ |
INSTANCE_ID}}} |
2025-09-19 09:42| Internal i2b2 Query Instance ID | 7721 |
{{{ |
PROJECT_ID}}} |
| i2b2 |
| project ID (e.g., ACT, DEMO) | ACT |
5412{{{PATIENT_COUNT}}} | Number of patients |
| /records returned | 1999 | |
{{{RESULT_INSTANCE_ID}}} | Specific ID for the result instance | 99432 |
1999
Design and Architecture
The i2b2 breakdown architecture is modified to support the data table definition and new breakdown types for User created data requests. The database tables have been modified to support the data table definitions.
...
