NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

Versions Compared

Key

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

...

  1. From the command line, enter:
    echo %JAVA_HOME%*
    echo %ANT_HOME%*
    Both of these commands should return the location where you installed these tools.
  2. To verify your Java SDK installation, enter java --version from a command prompt. You should see java version "1.6.0_31".
  3. To verify your Ant installation, enter ant --version
    Info
    titleOther environment variables

    Environment variables for caIntegrator and, optionally, UPT are modified and set in those sections of this document: #Installing a New caIntegrator v.1.4|||||\ and #Downloading and Installing UPT (Optional)|||||\.

MySQL Installation and Configuration

...

Note
titleBEFORE YOU BEGIN

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.

...

GUI Installer Method of Installation

...

  1. From the directory where you downloaded the caIntegrator_distribution_1_4.zip described in Downloading caIntegrator v.1.4 files, 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_4.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
      Info
      titleAbout setting property values

      Setting the property values is an important step in the installation process. Before you complete steps 2 & 3, review #Working with Properties Files|||||\.

  2. 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 the BDA Properties wiki page.
  3. Record the property values you have set.
    Info
    titleOther default values

    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 the installed instance. The URL follows this format: http://<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.

...

Note
titleBEFORE YOU BEGIN
  • Important: Backup the 1.3 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.

If you are performing a new installation, go directly to #Installing caIntegrator v.1.4 Application and Services|||||\.

caIntegrator 1.3 Users Upgrading to caIntegrator 1.4

The directions in this section presume that you have a valid and functioning caIntegrator 1.3. It also assumes that Java SDK, Apache Ant and MySQL have all been successfully uploaded and installed, as described on pages #Required Software--Not Included in caIntegrator|||||\.

Overview of Properties Files

...

See steps 3 & 4 in #Upgrade Using Command Line Installer|||||\ for more information.

Upgrade Using the GUI Installer

...

  1. Because of the application name change in v.1.4, 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.
    Warning
    titleWatch .war file name

    In this same directory, there may be a different file named caintegrator.war (without the number 2 in the name) which you should not delete.

  2. From the directory where you downloaded the upgrade zip file, extract 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_upgrade_1_4.zip. You must have a ZIP tool installed.
      Info
      titleDirectory for unzipped files

      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.

    2. 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
  3. Edit the default properties in the <upgrade_installer_directory>/upgrade.properties file. Before doing so, review #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 the BDA Properties page.
    Info
    titleNote

    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.

  4. Record these property values.
    Info
    titleModifying property values

    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 this file are not being used by other applications.

  5. 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.
  6. 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.
  7. To verify caIntegrator installation, open your web browser to the installed instance. The URL follows this format: 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.

...

Note
titleFor Optimal Performance

You must modify your JBoss 45.1.0 configuration to increase the amount of available memory for the caIntegrator application. Directions for doing this in Windows are in the following step 1.

...

  1. Modify the following entry to the JBoss run.bat file which is located at <application_root_directory>/jboss-45.1.0.5.GA-nci/bin/run.bat. Find the line that begins with set JAVA_OPTS= -Dbda=bda -Dprogram.name=%PROGNAME% -server and modify the "-Xms256m -Xmx512m" to read "-Xms4096m -Xmx4096m".
    Info
    titlePhysical memory

    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.

    Warning
    titleWarning

    Be careful when copying and pasting from this installation guide. 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.

  2. Restart your JBoss 45.1.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 for more information.

...

Info
titleJBoss & MySQL as services

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 45.1.0 .4 for UPT (optional)
  • JBoss 45.1.0 .5 (for caIntegratorapplication)
  • MySQL 5.0.45x

Running JBoss as a Service

...

To add and administer caIntegrator users in the UPT, refer to the caIntegrator 1.3 User's Guide

Default Users

...