An iRIS upgrade involves an upgrade to the iRIS database schema as well as the code on the application server. An update may sometimes involve running several upgrade scripts, but otherwise will be an update to the application code.
Initial steps
1. Before beginning an update/upgrade, a full backup should be taken of the iRIS database. On the application server, a backup of the iRIS ROOT folder is also recommended. By default, the ROOT folder normally located at the following path:
C:\iMedRIS\apache-tomcat-x.x.x\webapps\ROOT\
2. Download the update/upgrade files from the SFTP location. There will be a ROOT-<version>.zip folder as well as a database scripts folder.
3. When ready to begin, stop the Apache Tomcat service on the iRIS application server. The Windows Services console can be opened from the Start menu by searching for “services”:
4. After the Apache Tomcat service has been stopped, proceed to begin the “Database Upgrade” section.
Database Upgrade
Starting with the iRIS 13.01 July 2025 release, Flyway has been integrated in iRIS to automatically run any necessary database upgrade scripts. This change currently only applies to iRIS environments that are on an existing 13.01 version. If your iRIS environment is on the 13.01 version already, skip over the database upgrade section. The database upgrade scripts will be run automatically during the Tomcat startup process and all log output related to this process will show up in the Tomcat catalina log file.
If your iRIS environment is not on the 13.01 version already, proceed with manually running the database upgrade scripts up to the 1710 version, then proceed to the “Applying New ROOT Folder on Application Server” section. All of the 13.01 database upgrade scripts will be run automatically during the Tomcat startup process.
1. The iRIS database uses a table named SYSTEM_DB_STATUS to track iRIS version in the database. Each row in the table corresponds to an iRIS version. Use the following query to check the current version of the database:
select * from SYSTEM_DB_STATUS order by UPDATE_VERSION asc
2. Compare the returned results of the query against the Final DB Script Number column in the below table to identify any iRIS versions that do not yet have the latest scripts.
Upgrade - Will involve running an entire set of scripts for a version and possibly previous versions if the upgrade spans multiple versions. It may also involve running several remaining scripts for a previous version.
Update - Will involve running remaining scripts for a version and possibly remaining scripts for one or more versions. Most previous 13.01 versions will already have all the final scripts, so if the database already shows 1842, then it won’t be necessary to run any upgrade scripts. Proceed on to the "Applying New ROOT Folder on Application Server" section of the guide.
iRIS Version | First DB Script Number | Final DB Script Number | Comments |
|---|---|---|---|
| 10.03.2 | 1100 | 1158 | |
| 10.03.2Dev | 1175 | 1180 | |
| 11.01 | 1200 | 1273 | |
| 11.01Dev | 1300 | 1326 | |
| 11.02 | 1350 | 1426 | |
| 11.02.01 | 1500 | 1546 | |
| 12.01 | 1600 | 1676 | All errors in script 1600 should be ignored |
| 12.02 | 1700 | 1710 | Oracle scripts only go up to 1709 for 12.02 |
| 13.01 | 1800 | 1850 | 13.01 is called “2021” internally in Bitbucket and in the script folders |
3. Follow this process for running upgrade scripts:
- First, run any remaining upgrade scripts for previous versions, by order of version. For example, if it is identified that 12.01 and 12.02 have remaining upgrade scripts that need to be run, run all missing upgrade scripts for 12.01, and then do the same for 12.02. The upgrade scripts are always run in numerical order:
-upgradeXXXX.sql - Once all previous versions in the SYSTEM_DB_STATUS table have the final upgrade script numbers, proceed running the full set of upgrade scripts for each iRIS version in order to get up to 13.01. For each full set of upgrade scripts, the scrips should be run in the following order:
-upgradeXXXX.sql in numerical order
-Grants_Gov_Forms.sql (ignore errors if Grant.gov API is not used)
-Apply_Properties_XXXX.sql (errors can be ignored)
-upgradeINDEX.sql (errors can be ignored) - If performing an upgrade, run the Reports Installation Scripts for 13.01 as well:
-Upgrade_Reports_XXXX.sql in numerical order
4. After running all the upgrade scripts, query the database using the query from Step 1 of the database upgrade section to validate the SYSTEM_DB_STATUS table shows the correct final script number for each version.
Applying New ROOT Folder on Application Server
1. On the application server, extract the ROOT-<version>.zip to any temporary location on the server.
2. Delete the “lib” folder from the existing iRIS application code. By default it is located here:
C:\iMedRIS\apache-tomcat-x.x.x\webapps\ROOT\WEB-INF\lib
3. Select the entire contents of the extracted ROOT-<version> folder, and do a copy and replace on top of the contents of the existing iRIS ROOT folder:
4. Delete the Catalina folder, which is located at the following path:
C:\iMedRIS\apache-tomcat-x.x.x\work\Catalina
5 From the Windows Services console, start the Apache Tomcat service.