Developers Getting Started With i2b2
Space shortcuts
Space Tools
Developers Getting Started With i2b2 getstarted

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NAMEVALUE
RPDO_78

EXEC i2b2synthea8.dbo.usp_rpdo2 @TABLE_INSTANCE_ID=78 @RESULT_INSTANCE_ID={{{RESULT_INSTANCE_ID}}} @MIN_ROW=0 @MAX_ROW=10000

...


Data file format/location and Email parameters set-up:

...

HIVE_CELL_PARAMS

Export File The generated Data file format, location and email server parameters are configurable in the HIVEthe HIVE_CELL_PARAMS. 

Info

The <Filename> parameter  in the QT_BREAKDOWN_PATH  definition will override the default value specified in the HIVE_CELL_PARAMS. 

Wildfly must be restarted for changes to the HIVE_CELL_PARAMs to take effect.

...

Cell IDParameter NameExample ValueNotes
CRCedu.harvard.i2b2.crc.exportcsv.datamanageremailuserid@partners.orgEmail address used for sending request/export e-mails
CRCedu.harvard.i2b2.crc.smtp.hostsmtp.partners.orgSMTP host
CRCedu.harvard.i2b2.crc.smtp.port25SMTP port
CRCedu.harvard.i2b2.crc.smtp.ssl.enabledFALSETRUE will enable SSL
CRCedu.harvard.i2b2.crc.smtp.authFALSETRUE will enable SMTP authentication
CRCedu.harvard.i2b2.crc.smtp.usernamenoneSMTP username (required for SMTP authentication)
CRCedu.harvard.i2b2.crc.smtp.passwordnoneSMTP password (required for SMTP authentication)
CRCedu.harvard.i2b2.crc.smtp.enabledFALSETRUE will enable e-mails
CRCedu.harvard.i2b2.crc.smtp.from.fullnameData ManagerName that e-mails will be sent from.
CRCedu.harvard.i2b2.crc.smtp.from.emaildatamanager@site.orgE-mail address that e-mails will be sent from.
CCedu.harvard.i2b2.crc.smtp.subjecti2b2 Data RequestSubject line for e-mails.
CRCedu.harvard.i2b2.crc.exportcsv.defaultescapecharacter"Escape character for export files
CRCedu.harvard.i2b2.crc.exportcsv.maxfetchrows-1Maximum number of rows to export, or -1 for no limit
CRCedu.harvard.i2b2.crc.exportcsv.defaultlineend\nLine ending for export files
CRCedu.harvard.i2b2.crc.exportcsv.defaultseperator\tField separator for export files
CRCedu.harvard.i2b2.crc.exportcsv.resultfetchsize50000Number of records retrieved during each database fetch.
CRCedu.harvard.i2b2.crc.exportcsv.filename{{{PROJECT_ID}}}/{{{DATE_yyyyMMdd}}}_{{{FULL_NAME}}}.tsvParameterized template for export file names. If the extension is .zip, the file is zipped.
CRCedu.harvard.i2b2.crc.exportcsv.defaultquotechar"Quote character for export files
CRCedu.harvard.i2b2.crc.exportcsv.workfolder/tmp/i2b2Folder on the i2b2 server for data exports
CRCedu.harvard.i2b2.crc.exportcsv.zipencryptmethodnoneEncryption method for the exported ZIP file. One of STANDARD, NONE, or AES.

Export query definition variables

These variables can be used in HIVE_CELL_PARAMS entries and in query export definitions: 

...

Value

...

Description

...

{{{USER_NAME}}}

...

Current user running query

...

{{{PROJECT_ID}}}

...

The project name

...

{{{RANDOM_xxx}}}

...

A random integer where xxx is the max integer size

...

{{{DATE_xxx}}}

...

Date/Time format, where xxx can be from the table below.  The string yyyy-MM-dd would output dates that look like 2022-07-26

...

{{{QUERY_NAME}}}

...

Query Name

...

{{{QUERY_STARTDATE}}}

...

Query Start date/time

...

{{{QUERY_ENDDATE}}}

...

Query End date/time

...

{{{PATIENT_COUNT}}}

...

Number of patients. 

...

{{{FULL_NAME}}}

...

Fullname of user who ran query

...

{{{QUERY_MASTER_ID}}}

...

The query Master ID

...

{{{QUERY_RUNTIME}}}

...

Time to run the query

...

Table of allowable characters in {{{DATE_xxx}}} strings:

pad next
ValueDescriptionValueDescription
GeraKhour-of-am-pm (0-11)
uyearkclock-hour-of-am-pm (1-24)
yyyy4-digit yearHhour-of-day (0-23)
Dday-of-yearmminute-of-hour
M/Lmonth-of-yearssecond-of-minute
dday-of-monthSfraction-of-second
Q/qquarter-of-yearAmilli-of-day
Yweek-based-yearnnano-of-second
wweek-of-week-based-yearNnano-of-day
Wweek-of-monthVtime-zone ID
Eday-of-weekztime-zone name
e/clocalized day-of-weekOlocalized zone-offset
Fweek-of-monthXzone-offset 'Z' for zero
aam-pm-of-dayxzone-offset
hclock-hour-of-am-pm (1-12)Zzone-offset
p

Request and Export Results:

...

Developers Getting Started With i2b2 getstarted