Release Management
Space shortcuts
Space Tools

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin



html-text
<!DOCTYPE html>
<html>
<head>
    <title>Upgrade i2b2 Software</title>
    <meta charset="UTF-8">
    <meta name="description" content="Upgrading the i2b2 Software to the latest version" />
    <meta name="keywords" content="i2b2, release, upgrade, 1.7.10" />
<!--    <link rel="stylesheet" type="text/css" media="all" href="/stylesheets/i2b2-wiki.css" /> -->
</head>
<body>
    <h1 class="releaseHeading" id="upgradeVersion-current">Upgrade to Release 1.7.10 from 1.7.09c</h1>
</body>
</html>


Anchor
i2b2-upgrade-v1709cv1710-info
i2b2-upgrade-v1709cv1710-info

Version Information

Current Version:1.7.09c10
Release Date:December 13May 14, 20172018
License:i2b2 Open Source License


Anchor
i2b2-upgrade-v1709cv1710-download
i2b2-upgrade-v1709cv1710-download

Download

Descriptioni2b2 Released VersionMinimum Version RequiredDownload LinkRequirements
Files to upgrade the i2b2 server to 1.7.09c101.7.09c101.7.0509ci2b2upgrade-1705-to-1709c.See Technical Details section on the i2b2 Upgrades page.
Files to upgrade the i2b2 Database to 1.7.101.7.10 Image Added i2b2createdb-1710.zip 
Files to upgrade the i2b2 Web Client to 1.7.09c101.7.09c10 Image Modified i2b2webclient-1709c1710.zip 


Anchor
i2b2-upgrade-v1709cv1710-note
i2b2-upgrade-v1709cv1710-note

 Notes

    • Release 1.7.09 had changes to the crc.properties file. Since some sites might be upgrading from 1.7.08 or earlier, we have kept the steps to update the crc.properties files in these updgrade notes. However, if you are already on 1.7.09, 1.7.09a or higher you will skip the step to modify the crc.properties file as you have already done this step.Release 1.7.09c 10 contains changes to the i2b2 database and Web Client. Therefore in addition to the upgrade i2b2upgrade-1710.zip file you also need to download the i2b2createdb-1710.zip and i2b2webclient-1709c1710.zip filefiles. The  The process of installing the i2b2 Web Client has not changed. If you have questions on how this is done you can find additional information in Chapter 7. i2b2 Web Client Install of the i2b2 Installation Guide.
    • Because this release contains Web Client changes, the The i2b2 Admin module that resides no longer needs to be setup on the i2b2 server will also need to be updated. The . This is due to a new feature introduced in release 1.7.10 that enables a single sign-on location for both the Web Client and Admin share code and although  none of the changes are specific to the Admin, this update in necessary to make sure the two applications remain in syncModule. Please see the 1.7.10 Release Notes for additional information.
    • If you are upgrading to 1.7.10 from a release prior to 1.7.09c it is important you read the upgrade documentation before upgrading your system because earlier upgrades had changes to properties files. When a release has a change to a property file as did 1.7.09 we will make note of it and outline the steps to merge the changes into your local properties file.

Anchor
i2b2-upgrade-v1709cv1710-howTo
i2b2-upgrade-v1709cv1710-howTo

Upgrade Instructions

Excerpt Include
Upgrade i2b2 Upgrades
Upgrade i2b2 Upgrades
nopaneltrue

Knowing some sites have remained on JBoss 7 while some have upgraded to WildFly 10, we have gone ahead and provided Step-by-Step Instructions for both scenarios. For the most part the overall process is very similar. What is different, is the path in which the files reside. Expand the box below to see an example of the differences between the two path names.

 

 

UI Expand
titleExample Paths to i2b2.war


Code Block
languagepowershell
titleJBoss 7 path
/opt/jboss-as-7.1.1.Final/standalone/deployments/i2b2.war/

 


 

Code Block
languagepowershell
titleWildFly 10 path
/opt/wildfly-10.0.0.Final/standalone/deployments/i2b2.war/



 



Anchor
i2b2-upgrade-v1709cv1710-stepByStep-JBoss
i2b2-upgrade-v1709cv1710-stepByStep-JBoss

Step-by-Step Instructions for JBoss


UI Steps
sizesmall


UI Step

Stop JBoss

 

Code Block
languagepowershell
titleLinux Example
collapsetrue
$ /opt/jboss-as-7.1.1.Final/bin/jboss-cli.sh --connect command=:shutdown


 

 

UI Step

Backup your existing i2b2.war directory


UI Expand
titleLinux

On Linux, make a copy of /opt/jboss-as-7.1.1.Final/standalone/deployments/i2b2.war/ and save it to a different location outside of /opt/jboss-as-7.1.1.Final/ 

 


 

UI Expand
titleWindows

On Windows, make a copy of c:\opt\jboss-as-7.1.1.Final\standalone\deployments\i2b2.war\ and save it to a different location outside of c:\opt\jboss-as-7.1.1.Final\ 


 

 

UI Step

Delete i2b2.war.deployed file

 

Code Block
languagepowershell
titleLinux Example
collapsetrue
$ rm /opt/jboss-as-7.1.1.Final/standalone/deployments/i2b2.war.deployed

 

 

Warning

DO NOT delete your existing i2b2.war directory. The zip file contains only a subset of files to add/replace in your existing i2b2.war directory.


 

 

UI Step

Extract / copy the deployment files from the upgrade zip file to your JBoss deployments directory


 

 

UI Step

Copy the deployments directory into your existing JBoss standalone directory, replacing any existing files when prompted.

 

 

Code Block
languagepowershell
titleLinux Example
collapsetrue
$ cp -r deployments /opt/jboss-as-7.1.1.Final/standalone
UI Step

Modify the crc.properties

UI Expand
titleUpdate crc.properties

Open the crc.properties-1709 file and copy the contents from it into the crc.properties file located in the configuration directory on the i2b2 server.

Warning

DO NOT replace the crc.properties file with the new crc.properties-1709 file as the new file only contains the new parameters. If you replace the existing one you will lose all your current configurations and all the necessary parameters to run the crc.

UI Step

Backup your existing admin directory

UI Expand
titleLinux Example

/var/www/html/admin

UI Expand
titleWindows Example

C:\inetpub\wwwroot\admin

UI Step

Extract / Copy the admin directory from the update zip file to your web server directory

Warning

To prevent the loss of your current data configuration settings verify you can access the i2b2_config_data.js file in the backup copy of the admin directory you created in the previous step.

UI Step

Copy your old i2b2_config_data.js file into the updated admin directory on your web server. Overwrite the existing file if prompted.

UI Step


 

 

UI Step

Start JBoss



Code Block
languagepowershell
titleLinux Example
collapsetrue
$ /opt/jboss-as-7.1.1.Final/bin/standalone.sh -b 0.0.0.0 &


 

 

UI Step

Verify your upgrade

 

 

UI Expand
titleTest Web Client

Navigate to your local i2b2 Web Client in your preferred browser and verify you are able to log on and perform standard i2b2 functions. (e.g. Run queries, retrieve previous queries, view breakdowns, etc.)



 

 

Anchor
i2b2-upgrade-v1709cv1710-stepByStep-WildFly
i2b2-upgrade-v1709cv1710-stepByStep-WildFly

Step-by-Step Instructions for WildFly


UI Steps
sizesmall


UI Step

Stop WildFly


Code Block
languagepowershell
titleLinux Example
collapsetrue
$ /opt/wildfly-10.0.0.Final/bin/jboss-cli.sh --connect command=:shutdown


 

 

UI Step

Backup your existing i2b2.war directory


UI Expand
titleLinux

On Linux, make a copy of /opt/wildfly-10.0.0.Final/standalone/deployments/i2b2.war/ and save it to a different location outside of /opt/wildfly-10.0.0.Final/ 

 


 

UI Expand
titleWindows

On Windows, make a copy of c:\opt\wildfly-10.0.0.Final\standalone\deployments\i2b2.war\ and save it to a different location outside of c:\opt\wildfly-10.0.0.Final


 

 

UI Step

Delete i2b2.war.deployed file

 

Code Block
languagepowershell
titleLinux Example
collapsetrue
$ rm /opt/wildfly-10.0.0.Final/standalone/deployments/i2b2.war.deployed

 

 

Warning

DO NOT delete your existing i2b2.war directory. The zip file contains only a subset of files to add/replace in your existing i2b2.war directory.


 

 

UI Step

Extract / copy the deployment files from the upgrade zip file to your WildFly deployments directory


 

 

UI Step

Copy the deployments directory into your existing WildFly standalone directory, replacing any existing files when prompted.

 

 

Code Block
languagepowershell
titleLinux Example
collapsetrue
$ cp -r deployments /opt/wildfly-10.0.0.Final/standalone
UI Step

Modify the crc.properties

UI Expand
titleUpdate crc.properties

Open the crc.properties-1709 file and copy the contents from it into the crc.properties file located in the configuration directory on the i2b2 server.

Warning

DO NOT replace the crc.properties file with the new crc.properties-1709 file as the new file only contains the new parameters. If you replace the existing one you will lose all your current configurations and all the necessary parameters to run the crc.

UI Step

Backup your existing admin directory

UI Expand
titleLinux Example

/var/www/html/admin

UI Expand
titleWindows Example

C:\inetpub\wwwroot\admin

UI Step

Extract / Copy the admin directory from the update zip file to your web server directory

Warning

To prevent the loss of your current data configuration settings verify you can access the i2b2_config_data.js file in the backup copy of the admin directory you created in the previous step.

UI Step

Copy your old i2b2_config_data.js file into the updated admin directory on your web server. Overwrite the existing file if prompted.

UI Step


 

 

UI Step

Start WildFly



Code Block
languagepowershell
titleLinux Example
collapsetrue
$ /opt/wildfly-10.0.0.Final/bin/standalone.sh -b 0.0.0.0 &


 

 

UI Step

Verify your upgrade

 

 

UI Expand
titleTest Web Client

Navigate to your local i2b2 Web Client in your preferred browser and verify you are able to log on and perform standard i2b2 functions. (e.g. Run queries, retrieve previous queries, view breakdowns, etc.)



 

 

 


 

Anchor
i2b2-upgrade-zip-contents
i2b2-upgrade-zip-contents

Contents of the Zip File

i2b2 Upgrade Instructions for 1.7.05+ to 1.7.09c.pdf

admin/

admin/...

configuration/

configuration/crcapp/

configuration/crcapp/crc.properties-1709

 

UI Expand
titlei2b2upgrade-1709c-to-1710.zip

 

database/

Crcdata/

scripts/

oracle/

query_demo_insert_data.sql

postgresql/

query_demo_insert_data.sql

sqlserver/

query_demo_insert_data.sql

crc_create_query_oracle.sql

crc_create_query_postgresql.sql

crc_create_qyert_sqlserver.sql

Pmdata/

upgrade_oracle_i2b2pm_tables.sql

upgrade_postgresql_i2b2pm_tables.sql

upgrade_sqlserver_i2b2pm_tables.sql

 

deployments/

deployments/i2b2.war/ 

deployments/i2b2.war/WEB-INF/

deployments/i2b2.war/WEB-INF/lib/

deployments/i2b2.war/WEB-INF/lib/CRC-core.jar

deployments/i2b2.war/WEB-INF/lib/FR-core.jar

deployments/i2b2.war/WEB-INF/lib/i2b2Common-core.jar

deployments/i2b2.war/WEB-INF/lib/IM-core.jar

deployments/i2b2.war/WEB-INF/lib/Ontology-core.jar

deployments/i2b2.war/WEB-INF/lib/ProjectManagement-core.jar

deployments/i2b2.war/WEB-INF/lib/Workplace-core.jar

deployments/i2b2.war/WEB-INF/services/

deployments/i2b2.war/WEB-INF/services/CRC.aar

deployments/i2b2.war/WEB-INF/services/FR.aar

deployments/i2b2.war/WEB-INF/services/IM.aar

deployments/i2b2.war/WEB-INF/services/ProjectManagement.aar

deployments/i2b2.war/WEB-INF/services/Ontology.aar

deployments/i2b2.war/WEB-INF/services/Workplace.aar

deployments/i2b2.war.dodeploy