Page History
...
Info | |||||
---|---|---|---|---|---|
UPT 4.2 is backwards compatible to previous versions of CSM. When you provision the application in UPT 4.2, you will be asked to specify the CSM version caIntegrator is using. You should enter version 4.2. |
Installing caIntegrator v.1.3
...
Application and Services
To newly install the caIntegrator v.1.3 application and services, follow the steps in these sections:
- #Downloading caIntegrator v.1.3 Files
- #Installing a New caIntegrator v.1.3
- #Configuring JBoss
- #Post-Installation Tasks
...
- If the specified database host cannot be reached, or the field is blank.
- If the specified database does not already exist, or the caIntegrator DB user's credentials are wrong.
# Specify SMTP mail server connection information so that caIntegrator can send emails from users with new account requests.
- If jar signing is necessary for the installation, then enable it on this page, however this step is optional and can be skipped.
- Review the summary of the information you entered.
- Review the selected installation type and the installation destination.
After you click Next from reviewing the installation destination, the installer runs. The installation wizard displays the installation progress and completion. - When you are informed that the process is finished, click Done in the lower right corner of the wizard to close the installer.
- To verify caIntegrator installation:
- Open your web browser to //<jboss.server.hostname>:<jboss.server.port>/caintegrator/workspace.action.
- Enter ncimanager as the user and changeme as the password. Refer to the
<user home>/.installer-caintegrator/caintegrator_installer/install.properties
file for the correct values.
- After successfully installing caIntegrator, make a backup of the
<user home>/.installer-caintegrator/caintegrator_installer/install.properties
file in a different directory for future reference.|
Command-Line Method of Installation
Overview of caIntegrator Command-Line Installer Properties Files
When you do a command-line installation of caIntegrator for the first time, you will work with the properties file included in the caIntegrator_distribution_1_3.zip
. The file is: install.properties
.
...
Note | ||
---|---|---|
| ||
|
If you are performing a new installation, go directly to the installation of version 1.3, Installing caIntegrator v.1.3 Application and Services on page .
caIntegrator1.2 Users Upgrading to caIntegrator 1.3
The directions in this section presume that you have a valid and functioning caIntegrator 1.2. It also assumes that Java SDK, Apache Ant and MySQL have all been successfully uploaded and installed, as described on pages in this document.
Overview of Properties Files
When you installed the previous version of caIntegrator 1.2, you configured the install.properties file. To complete the upgrade to caIntegrator 1.3, you must use some of the values from the original install.properties to configure values in the upgrade installer wizard GUI, or the upgrade.properties file if you are doing a command-line method of upgrade.
See steps 3 & 4 in #Upgrade Using Command Line Installer" for more information.
Upgrade Using the GUI Installer
For detailed information on all of the GUI installer fields, refer to the documentation at this location: https://wiki.nci.nih.gov/x/NAUuAQ.
To perform an upgrade to caIntegrator 1.3 using the GUI Installation Wizard, follow these steps:
- Because of the application name changed in v.1.3, in the JBOSS home directory, locate the war file containing the previous release of caIntegrator2 and delete it. For example, find this file: JBOSS_HOME/server/default/deploy/caintegrator2.war and delete the file named caintegrator2.war.
NOTE: In this same directory, there is may be a different file named caintegrator.war (without the number 2 in the name) which you should not delete. - Open a command prompt in the directory where you downloaded the caIntegrator_gui_distribution_1_3.jar and invoke the GUI installer using this: java –jar caIntegrator_gui_distribution_1_3.jar.
- The Installation Wizard opens to facilitate the installation process. Click Next to proceed through the pages of the wizard, beginning with progressing past the Welcome page.
- Review the release notes.
- You must accept the license agreement to continue.
- Select the Upgrade installation type.
- Configure the JBoss Server-related upgrade settings.
If the path pointing to the caIntegrator installation to be upgraded is incorrect, an error message appears. - Specify the authentication type that caIntegrator is using. If you choose LDAP, configure the LDAP information: the LDAP Host Name, the LDAP Search Base, and the LDAP Search Prefix. An example of the Host Name is ldaps://myldaphost.mydomain.com:636.
- Review the summary of gathered information.
- Click Next to proceed through the next two pages. Review the selected upgrade installation type and the upgrade destination. # After you click Next from reviewing the installation destination, the installer runs. The installation wizard displays the installation progress and completion.
When you are informed that the process is finished, click Done in the lower right corner to close the installation wizard. - To verify caIntegrator installation, open your web browser to http://<jboss.server.hostname>:<jboss.server.port>/caintegrator (example: +http://hostname:47210/caintegrator)+ and enter ncimanager as the user and changeme as the password. Refer to the original install.properties for the correct jboss.server.hostname and jboss.server.port values.
Upgrade Using Command-Line Installer*
To perform an upgrade to caIntegrator 1.3 using the command-line, follow these steps: - Because of the application name changed in v.1.3, in the JBOSS home directory, locate the war file containing the previous release of caIntegrator2 and delete it. For example, find this file: JBOSS_HOME/server/default/deploy/caintegrator2.war and delete the file named caintegrator2.war.
NOTE: In this same directory, there is may be a different file named caintegrator.war (without the number 2 in the name) which you should not delete.| - From the directory where you downloaded the upgrade zip file, extract the files, using one of these two methods:
- Open a command prompt and use it to extract this file to a temporary location. For example, you may enter a command such as unzip -q caIntegrator_upgrade_1_3.zip. (You must have a ZIP tool installed).
Note: It is recommended that you use a new directory for the unzipped files, rather than the one you used to unzip the installer for the previous version(s) of caIntegrator. This location will be referred to as the <upgrade_installer_directory> henceforth. - Use WinZip or a similar utility to unzip the files to a temporary location. This location will be referred to as the <upgrade_installer directory> henceforth
Example: <upgrade_installer directory> = C:\caintegrator2_1_2_upgrade_installer - Edit the default properties in the <upgrade_installer_directory>/upgrade.properties file. Before doing so, review the #Working with Properties Files.
To do so, open both properties files, the one you configured originally when you installed the previous version of caIntegrator. (<install. properties file>)and the <upgrade_installer_directory>/upgrade.properties file.
For the latest details about configuring the properties for your updated environment, refer to this wiki page: https://wiki.nci.nih.gov/x/MBKy
Note: The upgrade.properties file does not have as many attributes, so you will not need to transfer all values you set in the previous installation file. - Record these property values.
Note: You shouldn't need to modify the other default values as we have chosen unique ports to reduce the risk of other applications using the same values. However, be sure to check the *.properties file to verify that the ports in thethis file are not being used by other applications. - From the command line, navigate to <upgrade_installer_directory>/ (Example:cd C:\caIntegrator_upgrade_installer), and type ant. This initiates the upgrade process. The anticipated duration is anywhere 1-15 minutes depending on your system's speed, power and memory.
The installer upgrades your existing caIntegrator database on your MySQL server, and starts your existing JBoss server.
Notes regarding upgrade:
When the installer detects that a database exists, it warns you to back it up, which you were instructed to do earlier in this process. Press Y to proceed. - To verify caIntegrator installation, open your web browser to http://<jboss.server.hostname>:<jboss.server.port>/caintegrator /workspace.action (example: +http://hostname:47210/caintegrator/workspace.action)+ and enter ncimanager as the user and changeme as the password. Refer to the original install.properties for the correct jboss.server.hostname and jboss.server.port values.
Configuring JBoss
Note | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
Running JBoss as a ServiceBEFORE RUNNING JBOSSBefore starting the caIntegrator JBOSS server, change the default location for user data. User data consists of various files that are saved by caIntegrator during the deployment and querying of studies. The default location for user data should be changed via the Djava.io.tmpdir jvm parameter in the jboss run.conf file.
The default caIntegrator installation runs JBoss as a command line process using the user currently logged on. Therefore, when you log out as this user, JBoss will no longer be available for caIntegrator. For that reason, it is recommended that you configure your JBoss servers to run as a Linux or Windows service. The instructions are contained in this section. |
To run JBoss as a service, follow these steps:
...