There must already be a pre-existing MySQL DB and connection username/password for caIntegrator to install into; caIntegrator does not create its own DB.

JBoss Errors During Installation

Command-line Installation Steps

To install a new instance of caIntegrator using the command-line, follow these steps:

1. From the directory where you downloaded the caIntegrator_distribution_1_3.zip from Downloading caIntegrator v.1.3 files on page , unzip the files, using one of these two methods:
   
   1. 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_distribution_1_3.zip (you must have a ZIP tool installed). This location will be referred to as the <installer_directory> henceforth.
      
   2. Use WinZip or a similar utility to unzip the files to a temporary location. This location will be referred to as the <installer_directory> henceforth.
      Example: <installer directory> = C:\caIntegrator_installer|
2. Note: Setting the property values is an important step in the installation process. Before you complete steps 2 & 3, review Working with Properties Files on page .
   Open the <installer_directory>/install.properties file, modify the values for your environment and save the file. For the latest details about configuring the properties for your environment, refer to this wiki page: https://wiki.nci.nih.gov/x/NAUuAQ.|
3. Record the property values you have set.
   Note: You should not 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 verify that the ports in this file are not being used by other applications. |
4. From the command line, navigate to <installer_directory>/(Example:cd C:\caIntegrator_2_0_installer), and type ant. This initiates the installation process. The anticipated duration is anywhere from 1-15 minutes, depending on your system's speed, power and memory.
   The installer installs the caIntegrator schema in the specified pre-existing database on your MySQL server, and installs, configures, and starts the JBoss server for the caIntegrator application. |
5. To verify caIntegrator installation, open your web browser to //<jboss.server.hostname>:<jboss.server.port>/caintegrator/workspace.action.
   Refer to the <installer_directory>/install.properties file for the correct values. Enter manager as the user and manager as the password.
6. After successfully installing caIntegrator, make a backup of the <installer_directory>/install.properties file in a different directory for future reference.
   

   Upgrading caIntegrator 1.2 x to 1.3

   This section describes how to upgrade your product from caIntegrator 1.2 to caIntegrator 1.3. The instructions in this section apply only if you have already installed a caIntegrator version 1.2.

You can perform an upgrade installation of caIntegrator v.1.3 using either of these two methods:

• A GUI Installation wizard. Instructions for this method begin on page .
• A command-line installation. For instructions, see page .

• Important: Backup the 1.21 database. You need to create a reliable copy of your entire caIntegrator database.
  
• Important: Backup the current installation of caIntegrator and artifacts from the original installation, such as properties files.

  Info

  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)+Image Modified 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)+Image Modified 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

• title

• For Optimal Performance For optimal performance, you must modify your JBoss 4.0.5 configuration to increase the amount of available memory for the caIntegrator application. Directions for doing this in Windows are in the following step 1.

  
  To configure JBoss in Windows, follow these steps.

1. Modify the following entry to the JBoss run.bat file which is located at <application_root_directory>/jboss-4.0.5.GA/bin/run.bat. Find the line that begins with "set JAVA_OPTS= -Dbda=bda -Dprogram.name=%PROGNAME% -server", modify the "-Xms256m -Xmx512m" to read "-Xms4096m -Xmx4096m".
   {info:title=Note

1. If 4096m is higher than the physical memory on the machine, then performance could be severely impacted with performance degradation and errors. 4096m of physical memory is recommended.

   Info

   Warning
   title Warning

1. Be careful when copying and pasting from this document, whether PDF or MS Word. No spaces must come before and after the columns. A safe way to ensure that the text has no unwanted space and unwanted characters is to copy the text into a blank text editor such as NotePad first. Then you can correct the spacing and copy-paste back into the run.bat file.

1. Restart your JBoss 4.0.5 server for the changes to take effect. The method of doing this may depend on the start/stop/restart scripts you created after the installation. Most commonly, you can execute shutdown.bat and then run.bat under $JBOSS_HOME/bin. Refer to the publicly available JBoss user's guide at http://www.jboss.org for more information.
   

1. Configuring JBoss Servers and MySQL Server to Run as Services

   
   

   NOTE Image Modified

   MySQL and the JBoss server that make up caIntegrator, and the JBoss server optionally installed for UPT, must run continually as services. The instructions in this section cover all of these scenarios. For a caIntegrator deployment, there are at least three servers, and if UPT is installed, four servers:

• JBoss 4.0.4 for UPT (optional)
  
• JBoss 4.0.5 (for caIntegratorapplication)
  
• MySQL 5.0.45|
  

  Running JBoss as a Service

  
  

  BEFORE RUNNING JBOSS

• Before 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.
  
  Example jvm parameter: -Djava.io.tmpdir=/local/content/caintegrator/jvmtmp
  |
  

  Note

• title

• BEFORE YOU BEGIN

  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.

You need to have access to the Windows Resource Kit.

It is assumed that your MySQL server was installed as a service. If it was not, follow these recommendations for installing this server as a service.